Inheritance diagram for PKP\Services\PKPPublicationService:

Public Member Functions
	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)

Protected Member Functions
	_saveFileParam ($publication, $submission, $value, $settingName, $userId, $localeKey='', $isImage=false)

Detailed Description

Definition at line 32 of file PKPPublicationService.inc.php.

Member Function Documentation

◆ _saveFileParam()

PKP\Services\PKPPublicationService::_saveFileParam	(	$publication,
		$submission,
		$value,
		$settingName,
		$userId,
		$localeKey = `''`,
		$isImage = `false`
	)

protected

Handle a publication setting for an uploaded file

Moves the temporary file to the public directory
Resets the param value to what is expected to be stored in the db
If a null value is passed, deletes any existing file

This method is protected because all operations which edit publications should go through the add and edit methods in order to ensure that the appropriate hooks are fired.

Parameters

Publication	$publication	The publication being edited
Submission	$submission	The submission this publication is part of
mixed	$value	The param value to be saved. Contains the temporary file ID if a new file has been uploaded.
string	$settingName	The name of the setting to save, typically used in the filename.
integer	$userId	ID of the user who owns the temporary file
string	$localeKey	Optional. Pass if the setting is multilingual
boolean	$isImage	Optional. For image files which include alt text in value

Returns: string|array|null New param value or null on failure

Definition at line 700 of file PKPPublicationService.inc.php.

References PKPServices\get(), PKPApplication\get(), and Core\getCurrentDate().

◆ add()

PKP\Services\PKPPublicationService::add	(	$publication,
		$request
	)

Definition at line 404 of file PKPPublicationService.inc.php.

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

◆ delete()

PKP\Services\PKPPublicationService::delete ( $publication )

Definition at line 665 of file PKPPublicationService.inc.php.

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

◆ edit()

PKP\Services\PKPPublicationService::edit	(	$publication,
		$params,
		$request
	)

Definition at line 498 of file PKPPublicationService.inc.php.

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

◆ get()

PKP\Services\PKPPublicationService::get ( $publicationId )

Definition at line 37 of file PKPPublicationService.inc.php.

References DAORegistry\getDAO().

◆ getCount()

PKP\Services\PKPPublicationService::getCount ( $args = [] )

Definition at line 45 of file PKPPublicationService.inc.php.

References PKP\Services\PKPPublicationService\getQueryBuilder().

◆ getDateBoundaries()

PKP\Services\PKPPublicationService::getDateBoundaries ( $args )

Get the oldest and most recent published dates of matching publications

Parameters

array $args Supports all args of self::getMany()

Returns: array [oldest, newest]

Definition at line 253 of file PKPPublicationService.inc.php.

References DAORegistry\getDAO(), and PKP\Services\PKPPublicationService\getQueryBuilder().

◆ getFullProperties()

PKP\Services\PKPPublicationService::getFullProperties	(	$publication,
		$args = `null`
	)

Definition at line 241 of file PKPPublicationService.inc.php.

References PKPServices\get(), PKP\Services\PKPPublicationService\getProperties(), and PKP\Services\SCHEMA_PUBLICATION.

◆ getIds()

PKP\Services\PKPPublicationService::getIds ( $args = [] )

Definition at line 52 of file PKPPublicationService.inc.php.

References PKP\Services\PKPPublicationService\getQueryBuilder().

◆ getMany()

PKP\Services\PKPPublicationService::getMany ( $args = [] )

Get publications

Parameters

array $args { @option int|array submissionIds @option int count @option int offset }

Returns: Iterator

Definition at line 66 of file PKPPublicationService.inc.php.

References DAORegistry\getDAO(), and PKP\Services\PKPPublicationService\getQueryBuilder().

◆ getMax()

PKP\Services\PKPPublicationService::getMax ( $args = [] )

Definition at line 86 of file PKPPublicationService.inc.php.

References PKP\Services\PKPPublicationService\getQueryBuilder().

◆ getProperties()

PKP\Services\PKPPublicationService::getProperties	(	$publication,
		$props,
		$args = `null`
	)

Definition at line 127 of file PKPPublicationService.inc.php.

References HookRegistry\call(), PKPServices\get(), DAORegistry\getDAO(), and PKP\Services\SCHEMA_PUBLICATION.

Referenced by PKP\Services\PKPPublicationService\getFullProperties(), and PKP\Services\PKPPublicationService\getSummaryProperties().

◆ getQueryBuilder()

PKP\Services\PKPPublicationService::getQueryBuilder ( $args = [] )

Returns: PKPPublicationQueryBuilder

Definition at line 97 of file PKPPublicationService.inc.php.

References HookRegistry\call().

Referenced by PKP\Services\PKPPublicationService\getCount(), PKP\Services\PKPPublicationService\getDateBoundaries(), PKP\Services\PKPPublicationService\getIds(), PKP\Services\PKPPublicationService\getMany(), and PKP\Services\PKPPublicationService\getMax().

◆ getSummaryProperties()

PKP\Services\PKPPublicationService::getSummaryProperties	(	$publication,
		$args = `null`
	)

Definition at line 232 of file PKPPublicationService.inc.php.

References PKPServices\get(), PKP\Services\PKPPublicationService\getProperties(), and PKP\Services\SCHEMA_PUBLICATION.

◆ publish()

PKP\Services\PKPPublicationService::publish ( $publication )

Publish a publication or schedule it for publication at a future date

Parameters

Publication $publication

Returns: Publication

Definition at line 550 of file PKPPublicationService.inc.php.

References HookRegistry\call(), PKPServices\get(), PKPApplication\get(), Core\getCurrentDate(), DAORegistry\getDAO(), Application\getSubmissionSearchDAO(), Application\getSubmissionSearchIndex(), and SubmissionLog\logEvent().

◆ unpublish()

PKP\Services\PKPPublicationService::unpublish ( $publication )

Unpublish a publication that has already been published

Parameters

Publication $publication

Returns: Publication

Definition at line 622 of file PKPPublicationService.inc.php.

References HookRegistry\call(), PKPServices\get(), PKPApplication\get(), DAORegistry\getDAO(), Application\getSubmissionSearchDAO(), Application\getSubmissionSearchIndex(), and SubmissionLog\logEvent().

◆ validate()

PKP\Services\PKPPublicationService::validate	(	$action,
		$props,
		$allowedLocales,
		$primaryLocale
	)

Definition at line 267 of file PKPPublicationService.inc.php.

References ValidatorFactory\allowedLocales(), PKPServices\get(), ValidatorFactory\make(), AppLocale\requireComponents(), ValidatorFactory\required(), and PKP\Services\SCHEMA_PUBLICATION.

◆ validatePublish()

PKP\Services\PKPPublicationService::validatePublish	(	$publication,
		$submission,
		$allowedLocales,
		$primaryLocale
	)

Validate a publication against publishing requirements

This validation check should return zero errors before calling self::publish().

It should not be necessary to repeat validation rules from self::validate(). These rules should be applied during all add or edit actions.

This additional check should be used when a journal or press wants to enforce particular publishing requirements, such as requiring certain metadata or other information.

Parameters

Publication	$publication
Submission	$submission
array	$allowedLocales	array Which locales are allowed
string	$primaryLocale	string

Returns: array List of error messages. The array keys are property names

Definition at line 382 of file PKPPublicationService.inc.php.

References HookRegistry\call().

◆ version()

PKP\Services\PKPPublicationService::version	(	$publication,
		$request
	)

Create a new version of a publication

Make a copy of an existing publication, without the datePublished, and make copies of all associated objects.

Parameters

Publication	$publication	The publication to copy
	Request

Returns: Publication The new publication

Definition at line 455 of file PKPPublicationService.inc.php.

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

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

PKPPublicationService.inc.php

Public Member Functions

Protected Member Functions

Detailed Description

Member Function Documentation

◆ _saveFileParam()

◆ add()

◆ delete()

◆ edit()

◆ get()

◆ getCount()

◆ getDateBoundaries()

◆ getFullProperties()

◆ getIds()

◆ getMany()

◆ getMax()

◆ getProperties()

◆ getQueryBuilder()

◆ getSummaryProperties()

◆ publish()

◆ unpublish()

◆ validate()

◆ validatePublish()

◆ version()