ContributionService
in package
Contribution Service.
Manages contributions from public users.
Table of Contents
Methods
- __construct() : mixed
- approve() : array<string|int, mixed>
- Approve a contribution.
- create() : array<string|int, mixed>
- Create a new contribution.
- getByContributor() : array<string|int, mixed>
- Get contributions by a contributor.
- getByItem() : array<string|int, mixed>
- Get contributions for an item.
- getForReview() : array<string|int, mixed>
- Get a single contribution for review.
- getOpportunities() : array<string|int, mixed>
- Get contribution opportunities for an item.
- getPendingReview() : array<string|int, mixed>
- Get pending contributions for review.
- getStats() : array<string|int, mixed>
- Get contribution statistics.
- getTypes() : array<string|int, mixed>
- Get contribution types.
- reject() : array<string|int, mixed>
- Reject a contribution.
- update() : array<string|int, mixed>
- Update an existing contribution.
Methods
__construct()
public
__construct([string $culture = 'en' ]) : mixed
Parameters
- $culture : string = 'en'
approve()
Approve a contribution.
public
approve(int $contributionId, int $reviewerId[, string|null $notes = null ]) : array<string|int, mixed>
Parameters
- $contributionId : int
- $reviewerId : int
- $notes : string|null = null
Return values
array<string|int, mixed>create()
Create a new contribution.
public
create(int $contributorId, int $itemId, string $typeCode, array<string|int, mixed> $content) : array<string|int, mixed>
Parameters
- $contributorId : int
- $itemId : int
- $typeCode : string
- $content : array<string|int, mixed>
Return values
array<string|int, mixed>getByContributor()
Get contributions by a contributor.
public
getByContributor(int $contributorId[, string|null $status = null ][, int $page = 1 ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
- $contributorId : int
- $status : string|null = null
- $page : int = 1
- $limit : int = 20
Return values
array<string|int, mixed>getByItem()
Get contributions for an item.
public
getByItem(int $informationObjectId[, string|null $status = 'approved' ][, int $page = 1 ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
- $informationObjectId : int
- $status : string|null = 'approved'
- $page : int = 1
- $limit : int = 20
Return values
array<string|int, mixed>getForReview()
Get a single contribution for review.
public
getForReview(int $contributionId) : array<string|int, mixed>
Parameters
- $contributionId : int
Return values
array<string|int, mixed>getOpportunities()
Get contribution opportunities for an item.
public
getOpportunities(int $informationObjectId) : array<string|int, mixed>
Parameters
- $informationObjectId : int
Return values
array<string|int, mixed>getPendingReview()
Get pending contributions for review.
public
getPendingReview([int $page = 1 ][, string|null $typeFilter = null ][, int $limit = 20 ]) : array<string|int, mixed>
Parameters
- $page : int = 1
- $typeFilter : string|null = null
- $limit : int = 20
Return values
array<string|int, mixed>getStats()
Get contribution statistics.
public
getStats() : array<string|int, mixed>
Return values
array<string|int, mixed>getTypes()
Get contribution types.
public
getTypes() : array<string|int, mixed>
Return values
array<string|int, mixed>reject()
Reject a contribution.
public
reject(int $contributionId, int $reviewerId[, string|null $notes = null ]) : array<string|int, mixed>
Parameters
- $contributionId : int
- $reviewerId : int
- $notes : string|null = null
Return values
array<string|int, mixed>update()
Update an existing contribution.
public
update(int $contributionId, array<string|int, mixed> $content, int $contributorId[, string|null $changeSummary = null ]) : array<string|int, mixed>
Parameters
- $contributionId : int
- $content : array<string|int, mixed>
- $contributorId : int
- $changeSummary : string|null = null