Public Member Functions

SalesRights Class Reference

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

List of all members.

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)

Detailed Description

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

See also:
SalesRightsDAO

Definition at line 16 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 153 of file SalesRights.inc.php.

SalesRights.getCountriesExcluded (  ) 

Get the excluded countries for this sales rights entry

Returns:
array

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

SalesRights.getCountriesIncluded (  ) 

Get the included countries for this sales rights entry

Returns:
array

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

SalesRights.getNameForONIXCode (  ) 

Get the human readable name for this ONIX code

Returns:
string

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

References getType().

SalesRights.getPublicationFormatId (  ) 

get publication format id

Returns:
int

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

SalesRights.getRegionsExcluded (  ) 

Get the excluded regions for this sales rights entry

Returns:
array

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

SalesRights.getRegionsIncluded (  ) 

Get the included regions for this sales rights entry

Returns:
array

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

SalesRights.getROWSetting (  ) 

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

Returns:
string

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

SalesRights.getType (  ) 

Get the ONIX code for this sales rights entry

Returns:
string

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

Referenced by getNameForONIXCode().

SalesRights.SalesRights (  ) 

Constructor

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

SalesRights.setCountriesExcluded ( countriesExcluded  ) 

Set the excluded country list for this sales rights entry

Parameters:
$countriesExcluded array

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

SalesRights.setCountriesIncluded ( countriesIncluded  ) 

Set the included country list for this sales rights entry

Parameters:
$countriesIncluded array

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

SalesRights.setPublicationFormatId ( publicationFormatId  ) 

set publication format id

Parameters:
$pressId int

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

SalesRights.setRegionsExcluded ( regionsExcluded  ) 

Set the excluded region list for this sales rights entry

Parameters:
$regionsExcluded array

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

SalesRights.setRegionsIncluded ( regionsIncluded  ) 

Set the included region list for this sales rights entry

Parameters:
$regionsIncluded array

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

SalesRights.setROWSetting ( rowSetting  ) 

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

Parameters:
$rowSetting boolean

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

SalesRights.setType ( type  ) 

Set the ONIX code for this sales rights entry

Parameters:
$type string

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


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