Inheritance diagram for TextureHandler:

Public Member Functions
	__construct ()

	authorize ($request, &$args, $roleAssignments)

	createGalley ($args, $request)

	createGalleyForm ($args, $request)

	editor ($args, $request)

	getGalley ()

	getPlugin ()

	getSubmission ()

	json ($args, $request)

	media ($args, $request)

Public Member Functions inherited from PKPHandler
	addPolicy ($authorizationPolicy, $addToTop=false)

	addRoleAssignment ($roleIds, $operations)

	getApiToken ()

&	getAuthorizedContext ()

&	getAuthorizedContextObject ($assocType)

&	getDispatcher ()

	getFirstUserContext ($user, $contexts)

	getId ()

	getLastAuthorizationMessage ()

	getRoleAssignment ($roleId)

	getRoleAssignments ()

	getSiteRedirectContext ($request)

	getTargetContext ($request, &$contextsCount=null)

	index ($args, $request)

	initialize ($request)

	markRoleAssignmentsChecked ()

	requireSSL ()

	setApiToken ($apiToken)

	setDispatcher ($dispatcher)

	setEnforceRestrictedSite ($enforceRestrictedSite)

	setId ($id)

	setupTemplate ($request)

	validate ($requiredContexts=null, $request=null)

Protected Member Functions
	_buildManifestXMLFromDocument ($manuscriptXml, &$assets)

	_buildMediaInfo ($request, $assets)

	_createDependentFile ($genreId, $mediaData, $submission, $submissionFile, $user)

	_updateManuscriptFile ($fileStage, $genreId, $resources, $submission, $submissionFile, $user)

Protected Attributes
	$_plugin

Protected Attributes inherited from PKPHandler
	$_apiToken = null

Additional Inherited Members
Static Public Member Functions inherited from PKPHandler
static	getPageParamName ($rangeName)

static	getRangeInfo ($request, $rangeName, $contextData=null)

static	hashPageContext ($request, $contextData=array())

Data Fields inherited from PKPHandler
	$_authorizationDecisionManager

	$_checks = array()

	$_dispatcher

	$_enforceRestrictedSite = true

	$_id

	$_isBackendPage = false

	$_roleAssignments = array()

	$_roleAssignmentsChecked = false

Detailed Description

Handle requests for Texture plugin.

Definition at line 18 of file TextureHandler.inc.php.

Constructor & Destructor Documentation

◆ __construct()

TextureHandler::__construct ( )

Constructor

Reimplemented from PKPHandler.

Definition at line 28 of file TextureHandler.inc.php.

References PKPHandler\addRoleAssignment(), and PluginRegistry\getPlugin().

Member Function Documentation

◆ _buildManifestXMLFromDocument()

TextureHandler::_buildManifestXMLFromDocument	(		$manuscriptXml,
		&	$assets
	)

protected

build manifest.xml from xml document

Parameters

$document	string raw XML
$assets	array list of figure metadata

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

References fatalError().

Referenced by json().

◆ _buildMediaInfo()

TextureHandler::_buildMediaInfo	(	$request,
		$assets
	)

protected

Build media info

Parameters

$request	PKPRquest
$assets	array

Returns: array

Definition at line 292 of file TextureHandler.inc.php.

References DAORegistry\getDAO().

Referenced by json().

◆ _createDependentFile()

TextureHandler::_createDependentFile	(	$genreId,
		$mediaData,
		$submission,
		$submissionFile,
		$user
	)

protected

creates dependent file

Parameters

$genreId	intr
$mediaData	string
$submission	Article
$submissionFile	SubmissionFie
$user	User

Returns: SubmissionArtworkFile

Definition at line 449 of file TextureHandler.inc.php.

References Core\getCurrentDate(), and DAORegistry\getDAO().

Referenced by json().

◆ _updateManuscriptFile()

TextureHandler::_updateManuscriptFile	(	$fileStage,
		$genreId,
		$resources,
		$submission,
		$submissionFile,
		$user
	)

protected

Update manuscript XML file

Parameters

$fileStage	int
$genreId	int
$resources	array
$submission	Article
$submissionFile	SubmissionFile
$user	User

Returns: SubmissionFile

Definition at line 484 of file TextureHandler.inc.php.

References Core\getCurrentDate(), and DAORegistry\getDAO().

Referenced by json().

◆ authorize()

TextureHandler::authorize	(		$request,
		&	$args,
			$roleAssignments
	)

Authorize this request.

Routers will call this method automatically thereby enforcing authorization. This method will be called before the validate() method and before passing control on to the handler operation.

NB: This method will be called once for every request only.

Parameters

$request	Request
$args	array request arguments
$roleAssignments	array the operation role assignment, see getRoleAssignment() for more details.

Returns: boolean

Reimplemented from PKPHandler.

Definition at line 42 of file TextureHandler.inc.php.

References PKPHandler\addPolicy().

◆ createGalley()

TextureHandler::createGalley	(	$args,
		$request
	)

Parameters

$args
$request	PKPRequest

Returns: JSONMessage

Definition at line 73 of file TextureHandler.inc.php.

References getPlugin(), and getSubmission().

◆ createGalleyForm()

TextureHandler::createGalleyForm	(	$args,
		$request
	)

Create galley form

Parameters

$args	array
$request	PKPRequest

Returns: JSONMessage JSON object

Definition at line 55 of file TextureHandler.inc.php.

References getPlugin(), and getSubmission().

◆ editor()

TextureHandler::editor	(	$args,
		$request
	)

Display substance editor

Parameters

$args	array
$request	PKPRequest

Returns: string

Definition at line 103 of file TextureHandler.inc.php.

References fatalError(), PKPTemplateManager\getManager(), and PKPLocale\requireComponents().

◆ getGalley()

TextureHandler::getGalley ( )

Get the authorized galley.

Returns: ArticleGalley

Definition at line 556 of file TextureHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

◆ getPlugin()

TextureHandler::getPlugin ( )

Get the plugin.

Returns: TexuturePlugin

Definition at line 548 of file TextureHandler.inc.php.

References $_plugin.

Referenced by createGalley(), and createGalleyForm().

◆ getSubmission()

TextureHandler::getSubmission ( )

Get the submission associated with this grid.

Returns: Submission

Definition at line 540 of file TextureHandler.inc.php.

References PKPHandler\getAuthorizedContextObject().

Referenced by createGalley(), and createGalleyForm().

◆ json()

TextureHandler::json	(	$args,
		$request
	)

fetch json archive

Parameters

$args	array
$request	PKPRequest

Returns: string

Definition at line 140 of file TextureHandler.inc.php.

References _buildManifestXMLFromDocument(), _buildMediaInfo(), _createDependentFile(), _updateManuscriptFile(), fatalError(), PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

◆ media()

TextureHandler::media	(	$args,
		$request
	)

display images attached to XML document

Parameters

$args	array
$request	PKPRequest

Returns: void

Definition at line 400 of file TextureHandler.inc.php.

References fatalError(), PKPHandler\getAuthorizedContextObject(), and DAORegistry\getDAO().

Field Documentation

◆ $_plugin

MarkupPlugin TextureHandler::$_plugin

protected

The Texture plugin

Definition at line 23 of file TextureHandler.inc.php.

Referenced by getPlugin().

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

TextureHandler.inc.php

Public Member Functions

Protected Member Functions

Protected Attributes

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ __construct()

Member Function Documentation

◆ _buildManifestXMLFromDocument()

◆ _buildMediaInfo()

◆ _createDependentFile()

◆ _updateManuscriptFile()

◆ authorize()

◆ createGalley()

◆ createGalleyForm()

◆ editor()

◆ getGalley()

◆ getPlugin()

◆ getSubmission()

◆ json()

◆ media()

Field Documentation

◆ $_plugin