Open Journal Systems  3.3.0
Representation Class Reference
Inheritance diagram for Representation:
DataObject ArticleGalley

Public Member Functions

 __construct ()
 
 getContextId ()
 
 getDAO ()
 
 getIsApproved ()
 
 getLocalizedName ()
 
 getName ($locale)
 
 getRemoteURL ()
 
 getRepresentationFiles ($fileStage=null)
 
 getSequence ()
 
 getStoredPubId ($pubIdType)
 
 setIsApproved ($isApproved)
 
 setName ($name, $locale=null)
 
 setRemoteURL ($remoteURL)
 
 setSequence ($seq)
 
 setStoredPubId ($pubIdType, $pubId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
 getLocalizedData ($key, $preferredLocale=null)
 
 getMetadataFieldNames ($translated=true)
 
 getSetMetadataFieldNames ($translated=true)
 
 getSupportedExtractionAdapters ()
 
 getSupportedInjectionAdapters ()
 
 getSupportedMetadataSchemas ()
 
 hasData ($key, $locale=null)
 
 injectMetadata ($metadataDescription)
 
 removeSupportedMetadataAdapter ($metadataSchemaName)
 
 setAllData (&$data)
 
 setData ($key, $value, $locale=null)
 
 setHasLoadableAdapters ($hasLoadableAdapters)
 
 setId ($id)
 
 unsetData ($key, $locale=null)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Data Fields inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

A submission's representation (Publication Format, Galley, ...)

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

Constructor & Destructor Documentation

◆ __construct()

Representation::__construct ( )

Constructor.

Reimplemented from DataObject.

Definition at line 22 of file Representation.inc.php.

References DataObject\setHasLoadableAdapters().

Member Function Documentation

◆ getContextId()

Representation::getContextId ( )

Get the context id from the submission assigned to this representation.

Returns
int

Definition at line 131 of file Representation.inc.php.

References PKPServices\get(), DAORegistry\getDAO(), and DataObject\getData().

◆ getDAO()

Representation::getDAO ( )

Get DAO class name for this object.

Returns
DAO

Reimplemented from DataObject.

Definition at line 141 of file Representation.inc.php.

References Application\getRepresentationDAO().

◆ getIsApproved()

Representation::getIsApproved ( )

Determines if a representation is approved or not.

Returns
boolean

Definition at line 75 of file Representation.inc.php.

References DataObject\getData().

◆ getLocalizedName()

Representation::getLocalizedName ( )

Get "localized" format name (if applicable).

Returns
string

Reimplemented in ArticleGalley.

Definition at line 49 of file Representation.inc.php.

References DataObject\getLocalizedData().

◆ getName()

Representation::getName (   $locale)

Get the format name (if applicable).

Parameters
$localestring
Returns
string

Reimplemented in ArticleGalley.

Definition at line 58 of file Representation.inc.php.

References DataObject\getData().

◆ getRemoteURL()

Representation::getRemoteURL ( )

Get the remote URL at which this representation is retrievable.

Returns
string
Deprecated:
3.2.0.0

Definition at line 114 of file Representation.inc.php.

References DataObject\getData().

◆ getRepresentationFiles()

Representation::getRepresentationFiles (   $fileStage = null)

◆ getSequence()

Representation::getSequence ( )

Get sequence of format in format listings for the submission.

Returns
float

Definition at line 33 of file Representation.inc.php.

References DataObject\getData().

◆ getStoredPubId()

Representation::getStoredPubId (   $pubIdType)

Get stored public ID of the submission.

Parameters
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
Returns
int

Definition at line 94 of file Representation.inc.php.

References DataObject\getData().

◆ setIsApproved()

Representation::setIsApproved (   $isApproved)

Sets whether a representation is approved or not.

Parameters
boolean$isApproved

Definition at line 83 of file Representation.inc.php.

References DataObject\setData().

◆ setName()

Representation::setName (   $name,
  $locale = null 
)

Set name.

Parameters
$namestring
$locale

Definition at line 67 of file Representation.inc.php.

References DataObject\setData().

◆ setRemoteURL()

Representation::setRemoteURL (   $remoteURL)

Set the remote URL for retrieving this representation.

Parameters
$remoteURLstring
Deprecated:
3.2.0.0

Definition at line 123 of file Representation.inc.php.

References DataObject\setData().

◆ setSequence()

Representation::setSequence (   $seq)

Set sequence of format in format listings for the submission.

Parameters
$seqfloat

Definition at line 41 of file Representation.inc.php.

References DataObject\setData().

◆ setStoredPubId()

Representation::setStoredPubId (   $pubIdType,
  $pubId 
)

Set the stored public ID of the submission.

Parameters
$pubIdTypestring One of the NLM pub-id-type values or 'other::something' if not part of the official NLM list (see http://dtd.nlm.nih.gov/publishing/tag-library/n-4zh0.html).
$pubIdstring

Definition at line 105 of file Representation.inc.php.

References DataObject\setData().


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