Inheritance diagram for APP\Services\PublicationService:

Public Member Functions
	__construct ()

	addPublication ($hookName, $args)

	canAuthorPublish ($submissionId)

	deletePublicationBefore ($hookName, $args)

	getPublicationProperties ($hookName, $args)

	getRelationOptions ()

	publishPublicationBefore ($hookName, $args)

	relate ($publication, $params)

	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 26 of file PublicationService.inc.php.

Constructor & Destructor Documentation

◆ __construct()

APP\Services\PublicationService::__construct ( )

Initialize hooks for extending PKPPublicationService

Definition at line 31 of file PublicationService.inc.php.

References HookRegistry\register().

Member Function Documentation

◆ addPublication()

APP\Services\PublicationService::addPublication	(	$hookName,
		$args
	)

Set OPS-specific objects when a new publication is created

Parameters

$hookName	string
$args	array [ @option Publication The new publication @option Request ]

Definition at line 196 of file PublicationService.inc.php.

References PluginRegistry\loadCategory().

◆ canAuthorPublish()

APP\Services\PublicationService::canAuthorPublish ( $submissionId )

Check if the server allows authors to publish

Parameters

$submissionId string

Returns: boolean

Definition at line 308 of file PublicationService.inc.php.

References HookRegistry\call(), PKPApplication\get(), and DAORegistry\getDAO().

Referenced by APP\Services\PublicationService\validatePublishPublication().

◆ 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 278 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 52 of file PublicationService.inc.php.

References PKPServices\get().

◆ getRelationOptions()

APP\Services\PublicationService::getRelationOptions ( )

Get the preprint relation options

Returns: json

Definition at line 340 of file PublicationService.inc.php.

◆ 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 259 of file PublicationService.inc.php.

References Core\getCurrentDate().

◆ relate()

APP\Services\PublicationService::relate	(	$publication,
		$params
	)

Set preprint relations

Parameters

Publication	$publication	The publication to copy
	Request

Returns: Publication The new publication

Definition at line 294 of file PublicationService.inc.php.

References DAORegistry\getDAO().

◆ 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 105 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

See also: PKPPublicationService::validatePublish()

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 179 of file PublicationService.inc.php.

References APP\Services\PublicationService\canAuthorPublish().

◆ versionPublication()

APP\Services\PublicationService::versionPublication	(	$hookName,
		$args
	)

Copy OPS-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 219 of file PublicationService.inc.php.

References PKPServices\get(), and PluginRegistry\loadCategory().

The documentation for this class was generated from the following file: