Open Journal Systems  3.3.0
Citation Class Reference
Inheritance diagram for Citation:
DataObject

Public Member Functions

 __construct ($rawCitation=null)
 
 _cleanCitationString ($citationString)
 
 getCitationWithLinks ()
 
 getRawCitation ()
 
 getSequence ()
 
 setRawCitation ($rawCitation)
 
 setSequence ($seq)
 
- Public Member Functions inherited from DataObject
 __construct ()
 
 addSupportedMetadataAdapter ($metadataAdapter)
 
 extractMetadata ($metadataSchema)
 
 getAdditionalMetadataFieldNames ()
 
getAllData ()
 
 getDAO ()
 
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

Class representing a citation (bibliographic reference)

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

Constructor & Destructor Documentation

◆ __construct()

Citation::__construct (   $rawCitation = null)

Constructor.

Parameters
$rawCitationstring an unparsed citation string

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

References setRawCitation().

Member Function Documentation

◆ _cleanCitationString()

Citation::_cleanCitationString (   $citationString)

Take a citation string and clean/normalize it

Parameters
$citationStringstring
Returns
string

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

References PKPString\regexp_replace().

Referenced by setRawCitation().

◆ getCitationWithLinks()

Citation::getCitationWithLinks ( )

Replace URLs through HTML links, if the citation does not already contain HTML links

Returns
string

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

References getRawCitation().

◆ getRawCitation()

Citation::getRawCitation ( )

Get the rawCitation

Returns
string

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

References DataObject\getData().

Referenced by getCitationWithLinks().

◆ getSequence()

Citation::getSequence ( )

Get the sequence number

Returns
integer

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

References DataObject\getData().

◆ setRawCitation()

Citation::setRawCitation (   $rawCitation)

Set the rawCitation

Parameters
$rawCitationstring

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

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

Referenced by __construct().

◆ setSequence()

Citation::setSequence (   $seq)

Set the sequence number

Parameters
$seqinteger

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

References DataObject\setData().


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