SalesRights Class Reference

Inheritance diagram for SalesRights:

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

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.

Constructor & Destructor Documentation

__construct()

SalesRights::__construct

(

)

Constructor

Reimplemented from DataObject.

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

Member Function Documentation

_removeEmptyElements()

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.

getCountriesExcluded()

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().

getCountriesIncluded()

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().

getNameForONIXCode()

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().

getPublicationFormatId()

SalesRights::getPublicationFormatId

(

)

get publication format id

Returns

int

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

References DataObject\getData().

getRegionsExcluded()

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().

getRegionsIncluded()

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().

getROWSetting()

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().

getType()

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().

setCountriesExcluded()

SalesRights::setCountriesExcluded

(

$countriesExcluded

)

Set the excluded country list for this sales rights entry

Parameters

$countriesExcluded

array

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

References DataObject\setData().

setCountriesIncluded()

SalesRights::setCountriesIncluded

(

$countriesIncluded

)

Set the included country list for this sales rights entry

Parameters

$countriesIncluded

array

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

References DataObject\setData().

setPublicationFormatId()

SalesRights::setPublicationFormatId

(

$publicationFormatId

)

set publication format id

Parameters

$pressId

int

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

References DataObject\setData().

setRegionsExcluded()

SalesRights::setRegionsExcluded

(

$regionsExcluded

)

Set the excluded region list for this sales rights entry

Parameters

$regionsExcluded

array

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

References DataObject\setData().

setRegionsIncluded()

SalesRights::setRegionsIncluded

(

$regionsIncluded

)

Set the included region list for this sales rights entry

Parameters

$regionsIncluded

array

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

References DataObject\setData().

setROWSetting()

SalesRights::setROWSetting

(

$rowSetting

)

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

Parameters

$rowSetting

boolean

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

References DataObject\setData().

setType()

SalesRights::setType

(

$type

)

Set the ONIX code for this sales rights entry

Parameters

$type

string

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

References DataObject\setData().

---

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

• SalesRights.inc.php