Summary
- File
- Package hierarchy PHPBoost\Event
- Class hierarchy \ContributionService
This service allows developers to manage their contributions.
Class ContributionService
Methods
__static()
__static()
static
- Inherited from \ContributionService
Tags
| None found |
find_by_id()
find_by_id(integer $id_contrib) : \ContributionFinds a contribution with its identifier.
Parameters
| integer | $id_contrib | Id of the contribution. |
Returns
\Contribution
—
The contribution you wanted. If it doesn't exist, it will return null.
static
- Inherited from \ContributionService
Tags
| None found |
get_all_contributions()
get_all_contributions(string $criteria = 'creation_date', string $order = 'desc') : array<mixed,\Contribution>Gets all the contributions of the table. You can sort the list.
Parameters
| string | $criteria | Criteria according to which they are ordered. It can be id, entitled, fixing_url, auth, current_status, module, creation_date, fixing_date, poster_id, fixer_id, poster_member.login poster_login, fixer_member.login fixer_login, identifier, id_in_module, type, description. |
| string | $order | desc or asc. |
Returns
array<mixed,\Contribution>
—
The list of the contributions.
static
- Inherited from \ContributionService
Tags
| None found |
find_by_criteria()
find_by_criteria(string $module, integer $id_in_module = null, string $type = null, string $identifier = null, integer $poster_id = null, integer $fixer_id = null) : array<mixed,\Contribution>Builds a list of the contributions matching the required criteria(s). All the parameters represent the criterias you can use.
If you don't want to use a criteria, let the null value. The returned contribution match all the criterias (it's a AND condition).
Parameters
| string | $module | The module identifier. |
| integer | $id_in_module | The id in module field. |
| string | $type | The contribution type. |
| string | $identifier | The contribution identifier. |
| integer | $poster_id | The poster. |
| integer | $fixer_id | The fixer. |
Returns
array<mixed,\Contribution>
—
The list of the contributions matching all the criterias.
static
- Inherited from \ContributionService
Tags
| None found |
save_contribution()
save_contribution(\Contribution $contribution) Create or update a contribution in the database.
Parameters
| \Contribution | $contribution | The contribution to synchronize with the data base. |
static
- Inherited from \ContributionService
Tags
| None found |
delete_contribution()
delete_contribution(\Contribution $contribution) Deletes a contribution in the database.
Parameters
| \Contribution | $contribution | The contribution to delete in the data base. |
static
- Inherited from \ContributionService
Tags
| None found |
delete_contribution_module()
delete_contribution_module(string $module_id) Delete all contributions of a module
Parameters
| string | $module_id | the module identifier |
static
- Inherited from \ContributionService
Tags
| None found |
generate_cache()
generate_cache() Generates the contribution cache file.
static
- Inherited from \ContributionService
Tags
| None found |
compute_number_contrib_for_each_profile()
compute_number_contrib_for_each_profile() : array<mixed,integer>Computes the number of contributions available for each profile.
It will count the contributions for the administrator, the moderators, the members, for each group and for each member who can have some special authorizations.
Returns
array<mixed,integer>
—
A map containing the values for each profile:
- r2 => for the administrator
- r1 => for the moderators
- r0 => for the members
- gi => for the group whose id is i
- mi => for the member whose id is i
static
- Inherited from \ContributionService
Tags
| None found |