Public Member Functions | |
| __construct () | |
| deletePublicationBefore ($hookName, $args) | |
| getPublicationProperties ($hookName, $args) | |
| publishPublicationBefore ($hookName, $args) | |
| validatePublication ($hookName, $args) | |
| validatePublishPublication ($hookName, $args) | |
| versionPublication ($hookName, $args) | |
 Public Member Functions inherited from PKP\Services\PKPPublicationService | |
| add ($publication, $request) | |
| delete ($publication) | |
| edit ($publication, $params, $request) | |
| get ($publicationId) | |
| getCount ($args=[]) | |
| getDateBoundaries ($args) | |
| getFullProperties ($publication, $args=null) | |
| getIds ($args=[]) | |
| getMany ($args=[]) | |
| getMax ($args=[]) | |
| getProperties ($publication, $props, $args=null) | |
| getQueryBuilder ($args=[]) | |
| getSummaryProperties ($publication, $args=null) | |
| publish ($publication) | |
| unpublish ($publication) | |
| validate ($action, $props, $allowedLocales, $primaryLocale) | |
| validatePublish ($publication, $submission, $allowedLocales, $primaryLocale) | |
| version ($publication, $request) | |
Additional Inherited Members | |
| Protected Member Functions inherited from PKP\Services\PKPPublicationService | |
| _saveFileParam ($publication, $submission, $value, $settingName, $userId, $localeKey='', $isImage=false) | |
Detailed Description
Definition at line 24 of file PublicationService.inc.php.
Constructor & Destructor Documentation
◆ __construct()
| APP\Services\PublicationService::__construct | ( | ) |
Initialize hooks for extending PKPPublicationService
Definition at line 29 of file PublicationService.inc.php.
References HookRegistry\register().
Member Function Documentation
◆ deletePublicationBefore()
| APP\Services\PublicationService::deletePublicationBefore | ( | $hookName, | |
| $args | |||
| ) |
Delete OJS-specific objects before a publication is deleted
- Parameters
-
$hookName string $args array [ @option Publication The publication being deleted ]
Definition at line 253 of file PublicationService.inc.php.
References PKPServices\get().
◆ getPublicationProperties()
| APP\Services\PublicationService::getPublicationProperties | ( | $hookName, | |
| $args | |||
| ) |
Add values when retrieving an object's properties
- Parameters
-
$hookName string $args array [ @option array Property values @option Publication @option array The props requested @option array Additional arguments (such as the request object) passed ]
Definition at line 49 of file PublicationService.inc.php.
References PKPServices\get().
◆ publishPublicationBefore()
| APP\Services\PublicationService::publishPublicationBefore | ( | $hookName, | |
| $args | |||
| ) |
Modify a publication before it is published
- Parameters
-
$hookName string $args array [ @option Publication The new version of the publication @option Publication The old version of the publication ]
Definition at line 231 of file PublicationService.inc.php.
References PKPServices\get().
◆ validatePublication()
| APP\Services\PublicationService::validatePublication | ( | $hookName, | |
| $args | |||
| ) |
Make additional validation checks
- Parameters
-
$hookName string $args array [ @option array Validation errors already identified @option string One of the VALIDATE_ACTION_* constants @option array The props being validated @option array The locales accepted for this object @option string The primary locale for this object ]
Definition at line 102 of file PublicationService.inc.php.
References PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), and AppLocale\requireComponents().
◆ validatePublishPublication()
| APP\Services\PublicationService::validatePublishPublication | ( | $hookName, | |
| $args | |||
| ) |
Make additional validation checks against publishing requirements
- Parameters
-
$hookName string $args array [ @option array Validation errors already identified @option Publication The publication to validate @option Submission The submission of the publication being validated @option array The locales accepted for this object @option string The primary locale for this object ]
Definition at line 184 of file PublicationService.inc.php.
References PKPServices\get().
◆ versionPublication()
| APP\Services\PublicationService::versionPublication | ( | $hookName, | |
| $args | |||
| ) |
Copy OJS-specific objects when a new publication version is created
- Parameters
-
$hookName string $args array [ @option Publication The new version of the publication @option Publication The old version of the publication @option Request ]
Definition at line 204 of file PublicationService.inc.php.
References PKPServices\get().
The documentation for this class was generated from the following file:
