Open Journal Systems  2.4.3
 All Classes Namespaces Functions Variables Groups Pages
Citation Class Reference
Inheritance diagram for Citation:
DataObject

Public Member Functions

 _cleanCitationString ($citationString)
 
 _getSupportedCitationStates ()
 
 addError ($errorMessage)
 
 addSourceDescription (&$sourceDescription)
 
 Citation ($rawCitation=null)
 
 getAssocId ()
 
 getAssocType ()
 
 getCitationState ()
 
 getErrors ()
 
getNamespacedMetadataProperties ()
 
 getRawCitation ()
 
 getSeq ()
 
getSourceDescriptions ()
 
 setAssocId ($assocId)
 
 setAssocType ($assocType)
 
 setCitationState ($citationState)
 
 setRawCitation ($rawCitation)
 
 setSeq ($seq)
 
 setSourceDescriptions (&$sourceDescriptions)
 
- Public Member Functions inherited from DataObject
 addSupportedMetadataAdapter (&$metadataAdapter)
 
 DataObject ($callHooks=true)
 
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()
 

Detailed Description

Class representing a citation (bibliographic reference)

See Also
MetadataDescription

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

Member Function Documentation

Citation::_cleanCitationString (   $citationString)

Take a citation string and clean/normalize it

Parameters
$citationStringstring
Returns
string

Definition at line 255 of file Citation.inc.php.

References Config\getVar(), String\regexp_replace(), String\utf8_compliant(), and String\utf8_normalize().

Referenced by setRawCitation().

Citation::_getSupportedCitationStates ( )

Return supported citation states NB: PHP4 work-around for a private static class member

Returns
array supported citation states

Definition at line 239 of file Citation.inc.php.

Referenced by setCitationState(), and CitationForm\validate().

Citation::addError (   $errorMessage)

Add a checking error

Parameters
$errorMessagestring

Definition at line 168 of file Citation.inc.php.

Citation::addSourceDescription ( $sourceDescription)

Add a meta-data description discovered for this citation from an external source.

Parameters
$sourceDescriptionMetadataDescription
Returns
integer the source description's sequence number.

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

Citation::Citation (   $rawCitation = null)

Constructor.

Parameters
$rawCitationstring an unparsed citation string

Definition at line 53 of file Citation.inc.php.

References DataObject\setHasLoadableAdapters(), and setRawCitation().

Citation::getAssocId ( )

Get the association id

Returns
integer

Definition at line 152 of file Citation.inc.php.

References DataObject\getData().

Citation::getAssocType ( )

Get the association type

Returns
integer

Definition at line 136 of file Citation.inc.php.

References DataObject\getData().

Citation::getCitationState ( )

Get the citationState

Returns
integer

Definition at line 119 of file Citation.inc.php.

Citation::getErrors ( )

Get all checking errors

Returns
array

Definition at line 176 of file Citation.inc.php.

& Citation::getNamespacedMetadataProperties ( )

Returns all properties of this citation. The returned array contains the name spaces as key and the property list as values.

Returns
array

Definition at line 221 of file Citation.inc.php.

References DataObject\getSupportedMetadataSchemas().

Citation::getRawCitation ( )

Get the rawCitation

Returns
string

Definition at line 185 of file Citation.inc.php.

References DataObject\getData().

Citation::getSeq ( )

Get the sequence number

Returns
integer

Definition at line 203 of file Citation.inc.php.

References DataObject\getData().

& Citation::getSourceDescriptions ( )

Get all meta-data descriptions discovered for this citation from external sources.

Returns
array MetadataDescriptions

Definition at line 111 of file Citation.inc.php.

Citation::setAssocId (   $assocId)

Set the association id

Parameters
$assocIdinteger

Definition at line 160 of file Citation.inc.php.

References DataObject\setData().

Citation::setAssocType (   $assocType)

Set the association type

Parameters
$assocTypeinteger

Definition at line 144 of file Citation.inc.php.

References DataObject\setData().

Citation::setCitationState (   $citationState)

Set the citationState

Parameters
$citationStateinteger

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

References _getSupportedCitationStates().

Citation::setRawCitation (   $rawCitation)

Set the rawCitation

Parameters
$rawCitationstring

Definition at line 193 of file Citation.inc.php.

References _cleanCitationString(), and DataObject\setData().

Referenced by Citation().

Citation::setSeq (   $seq)

Set the sequence number

Parameters
$seqinteger

Definition at line 211 of file Citation.inc.php.

References DataObject\setData().

Citation::setSourceDescriptions ( $sourceDescriptions)

Set meta-data descriptions discovered for this citation from external sources.

Parameters
$sourceDescriptionsarray MetadataDescriptions

Definition at line 71 of file Citation.inc.php.


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