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

Public Member Functions

 _removeEmptyElements ($value)
 
 getCountriesExcluded ()
 
 getCountriesIncluded ()
 
 getNameForONIXCode ()
 
 getPublicationFormatId ()
 
 getRegionsExcluded ()
 
 getRegionsIncluded ()
 
 getROWSetting ()
 
 getType ()
 
 SalesRights ()
 
 setCountriesExcluded ($countriesExcluded)
 
 setCountriesIncluded ($countriesIncluded)
 
 setPublicationFormatId ($publicationFormatId)
 
 setRegionsExcluded ($regionsExcluded)
 
 setRegionsIncluded ($regionsIncluded)
 
 setROWSetting ($rowSetting)
 
 setType ($type)
 
- 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

Basic class describing a sales rights composite type (used on the ONIX templates for publication formats)

See Also
SalesRightsDAO

Definition at line 17 of file SalesRights.inc.php.

Member Function Documentation

SalesRights::_removeEmptyElements (   $value)

Internal function for an array_filter to remove empty countries. array_filter() can be called without a callback to remove empty array elements but it depends on type juggling and may not be reliable.

Parameters
String$value
Returns
boolean

Definition at line 154 of file SalesRights.inc.php.

SalesRights::getCountriesExcluded ( )

Get the excluded countries for this sales rights entry

Returns
array

Definition at line 103 of file SalesRights.inc.php.

References DataObject\getData().

SalesRights::getCountriesIncluded ( )

Get the included countries for this sales rights entry

Returns
array

Definition at line 87 of file SalesRights.inc.php.

References DataObject\getData().

SalesRights::getNameForONIXCode ( )

Get the human readable name for this ONIX code

Returns
string

Definition at line 61 of file SalesRights.inc.php.

References DAORegistry\getDAO(), and getType().

SalesRights::getPublicationFormatId ( )

get publication format id

Returns
int

Definition at line 29 of file SalesRights.inc.php.

References DataObject\getData().

SalesRights::getRegionsExcluded ( )

Get the excluded regions for this sales rights entry

Returns
array

Definition at line 135 of file SalesRights.inc.php.

References DataObject\getData().

SalesRights::getRegionsIncluded ( )

Get the included regions for this sales rights entry

Returns
array

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

References DataObject\getData().

SalesRights::getROWSetting ( )

Get the ROWSetting value for this sales rights entry (Rest Of World)

Returns
string

Definition at line 79 of file SalesRights.inc.php.

References DataObject\getData().

SalesRights::getType ( )

Get the ONIX code for this sales rights entry

Returns
string

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

References DataObject\getData().

Referenced by getNameForONIXCode().

SalesRights::SalesRights ( )

Constructor

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

SalesRights::setCountriesExcluded (   $countriesExcluded)

Set the excluded country list for this sales rights entry

Parameters
$countriesExcludedarray

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

References DataObject\setData().

SalesRights::setCountriesIncluded (   $countriesIncluded)

Set the included country list for this sales rights entry

Parameters
$countriesIncludedarray

Definition at line 95 of file SalesRights.inc.php.

References DataObject\setData().

SalesRights::setPublicationFormatId (   $publicationFormatId)

set publication format id

Parameters
$pressIdint

Definition at line 37 of file SalesRights.inc.php.

References DataObject\setData().

SalesRights::setRegionsExcluded (   $regionsExcluded)

Set the excluded region list for this sales rights entry

Parameters
$regionsExcludedarray

Definition at line 143 of file SalesRights.inc.php.

References DataObject\setData().

SalesRights::setRegionsIncluded (   $regionsIncluded)

Set the included region list for this sales rights entry

Parameters
$regionsIncludedarray

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

References DataObject\setData().

SalesRights::setROWSetting (   $rowSetting)

Set the ROWSetting for this sales rights entry (Rest Of World)

Parameters
$rowSettingboolean

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

References DataObject\setData().

SalesRights::setType (   $type)

Set the ONIX code for this sales rights entry

Parameters
$typestring

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

References DataObject\setData().


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