Open Monograph Press  1.1
 All Classes Namespaces Functions Variables Groups Pages
Representation Class Reference
Inheritance diagram for Representation:
DataObject PublicationFormat

Public Member Functions

 getContextId ()
 
 getLocalizedName ()
 
 getName ()
 
 getSeq ()
 
 getStoredPubId ($pubIdType)
 
 getSubmissionId ()
 
 Representation ()
 
 setName ($name, $locale=null)
 
 setSeq ($seq)
 
 setStoredPubId ($pubIdType, $pubId)
 
 setSubmissionId ($submissionId)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter ($metadataAdapter)
 
 DataObject ()
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
getData ($key, $locale=null)
 
 getHasLoadableAdapters ()
 
 getId ()
 
 getLocaleMetadataFieldNames ()
 
getLocalizedData ($key)
 
 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)
 
 upcastTo ($targetObject)
 

Additional Inherited Members

- Public Attributes 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.

Member Function Documentation

Representation::getContextId ( )

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

Returns
int

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

References Application\getSubmissionDAO(), and getSubmissionId().

Referenced by PublicationFormat\getPressId().

Representation::getLocalizedName ( )

Get "localized" format name (if applicable).

Returns
string

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

References DataObject\getLocalizedData().

Representation::getName ( )

Get the format name (if applicable).

Returns
string

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

References DataObject\getData().

Representation::getSeq ( )

Get sequence of format in format listings for the submission.

Returns
float

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

References DataObject\getData().

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 93 of file Representation.inc.php.

References DataObject\getData().

Representation::getSubmissionId ( )

Get submission id

Returns
int

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

References DataObject\getData().

Referenced by getContextId().

Representation::Representation ( )

Constructor.

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

References DataObject\setHasLoadableAdapters().

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

Set name.

Parameters
$namestring
$locale

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

References DataObject\setData().

Representation::setSeq (   $seq)

Set sequence of format in format listings for the submission.

Parameters
$sequencefloat

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

References DataObject\setData().

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 104 of file Representation.inc.php.

References DataObject\setData().

Representation::setSubmissionId (   $submissionId)

Set submission ID.

Parameters
$submissionIdint

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

References DataObject\setData().


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