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

Public Member Functions

 getDisplayBlock ()
 
 getDisplayHomepage ()
 
 getId ()
 
 getJournalId ()
 
 getLimitItems ()
 
 getLocalizedTitle ()
 
 getRecentItems ()
 
 getSeq ()
 
 getTitle ($locale)
 
 getUrl ()
 
 setDisplayBlock ($displayBlock)
 
 setDisplayHomepage ($displayHomepage)
 
 setId ($feedId)
 
 setJournalId ($journalId)
 
 setLimitItems ($limitItems)
 
 setRecentItems ($recentItems)
 
 setSeq ($seq)
 
 setTitle ($title, $locale)
 
 setUrl ($url)
 
- 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

Basic class describing an external feed.

Definition at line 21 of file ExternalFeed.inc.php.

Member Function Documentation

ExternalFeed::getDisplayBlock ( )

Get block display of the external feed.

Returns
int

Definition at line 115 of file ExternalFeed.inc.php.

References DataObject\getData().

ExternalFeed::getDisplayHomepage ( )

Get homepage display of the external feed.

Returns
int

Definition at line 99 of file ExternalFeed.inc.php.

References DataObject\getData().

ExternalFeed::getId ( )

Get the ID of the external feed.

Returns
int

Definition at line 35 of file ExternalFeed.inc.php.

References DataObject\getData().

ExternalFeed::getJournalId ( )

Get the journal ID of the external feed.

Returns
int

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

References DataObject\getData().

ExternalFeed::getLimitItems ( )

Get limit items of the external feed.

Returns
int

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

References DataObject\getData().

ExternalFeed::getLocalizedTitle ( )

Get the localized title

Returns
string

Definition at line 164 of file ExternalFeed.inc.php.

References DataObject\getLocalizedData().

ExternalFeed::getRecentItems ( )

Get recent items of the external feed.

Returns
int

Definition at line 147 of file ExternalFeed.inc.php.

References DataObject\getData().

ExternalFeed::getSeq ( )

Get feed display sequence.

Returns
float

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

References DataObject\getData().

ExternalFeed::getTitle (   $locale)

Get feed title

Parameters
$localestring
Returns
string

Definition at line 173 of file ExternalFeed.inc.php.

References DataObject\getData().

ExternalFeed::getUrl ( )

Get feed URL.

Returns
int

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

References DataObject\getData().

ExternalFeed::setDisplayBlock (   $displayBlock)

Set the block display of the external feed.

Parameters
$displayBlockint

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

References DataObject\setData().

ExternalFeed::setDisplayHomepage (   $displayHomepage)

Set the homepage display of the external feed.

Parameters
$displayHomepageint

Definition at line 107 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setId (   $feedId)

Set the ID of the external feed.

Parameters
$feedIdint

Definition at line 43 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setJournalId (   $journalId)

Set the journal ID of the external feed.

Parameters
$journalIdint

Definition at line 59 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setLimitItems (   $limitItems)

Set limit items of the external feed.

Parameters
$limitItemsint

Definition at line 139 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setRecentItems (   $recentItems)

Set recent items of the external feed.

Parameters
$recentItemsint

Definition at line 155 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setSeq (   $seq)

Set feed display sequence

Parameters
$sequencefloat

Definition at line 91 of file ExternalFeed.inc.php.

References DataObject\setData().

ExternalFeed::setTitle (   $title,
  $locale 
)

Set feed title

Parameters
$titlestring
$localestring

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

References DataObject\setData().

ExternalFeed::setUrl (   $url)

Set feed URL.

Parameters
$urlstring

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

References DataObject\setData().


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