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

Public Member Functions

 _cleanCitationString ($citationString)
 
 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 ()
 
 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)
 

Static Public Member Functions

static _getSupportedCitationStates ()
 

Public Attributes

 $_citationState = CITATION_RAW
 
 $_errors = array()
 
 $_maxSourceDescriptionSeq = 0
 
 $_sourceDescriptions = array()
 
- Public Attributes inherited from DataObject
 $_data = array()
 
 $_extractionAdaptersLoaded = false
 
 $_hasLoadableAdapters = false
 
 $_injectionAdaptersLoaded = false
 
 $_metadataExtractionAdapters = array()
 
 $_metadataInjectionAdapters = array()
 

Detailed Description

Class representing a citation (bibliographic reference)

See Also
MetadataDescription

Definition at line 34 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 268 of file Citation.inc.php.

Referenced by getErrors().

static Citation::_getSupportedCitationStates ( )
static

Return supported citation states

Returns
array supported citation states

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

Citation::addError (   $errorMessage)

Add a checking error

Parameters
$errorMessagestring

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

References DataObject\getData().

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 97 of file Citation.inc.php.

Citation::Citation (   $rawCitation = null)

Constructor.

Parameters
$rawCitationstring an unparsed citation string

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

Citation::getAssocId ( )

Get the association id

Returns
integer

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

Citation::getAssocType ( )

Get the association type

Returns
integer

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

Citation::getCitationState ( )

Get the citationState

Returns
integer

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

References DataObject\getData().

Citation::getErrors ( )

Get all checking errors

Returns
array

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

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

& 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 235 of file Citation.inc.php.

Citation::getRawCitation ( )

Get the rawCitation

Returns
string

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

Citation::getSeq ( )

Get the sequence number

Returns
integer

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

& Citation::getSourceDescriptions ( )

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

Returns
array MetadataDescriptions

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

Citation::setAssocId (   $assocId)

Set the association id

Parameters
$assocIdinteger

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

Citation::setAssocType (   $assocType)

Set the association type

Parameters
$assocTypeinteger

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

Citation::setCitationState (   $citationState)

Set the citationState

Parameters
$citationStateinteger

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

References DataObject\setData().

Citation::setRawCitation (   $rawCitation)

Set the rawCitation

Parameters
$rawCitationstring

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

Citation::setSeq (   $seq)

Set the sequence number

Parameters
$seqinteger

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

Citation::setSourceDescriptions ( $sourceDescriptions)

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

Parameters
$sourceDescriptionsarray MetadataDescriptions

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

References $_maxSourceDescriptionSeq.

Member Data Documentation

int Citation::$_citationState = CITATION_RAW

citation state (raw, edited, parsed, looked-up)

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

array Citation::$_errors = array()

errors that occurred while checking or filtering the citation.

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

integer Citation::$_maxSourceDescriptionSeq = 0

the max sequence number that has been attributed so far

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

Referenced by setSourceDescriptions().

array Citation::$_sourceDescriptions = array()

an array of MetadataDescriptions

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


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