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

Public Member Functions
	_removeEmptyElements ($value)
	getAgentId ()
	getAssignedRepresentativeNames ()
	getCountriesExcluded ()
	getCountriesIncluded ()
	getCurrencyCode ()
	getDate ()
	getDateFormat ()
	getDateRole ()
	getDiscount ()
	getPrice ()
	getPriceTypeCode ()
	getPublicationFormatId ()
	getRegionsExcluded ()
	getRegionsIncluded ()
	getSupplierId ()
	getTaxRateCode ()
	getTaxTypeCode ()
	getTerritoriesAsString ()
	Market ()
	setAgentId ($agentId)
	setCountriesExcluded ($countriesExcluded)
	setCountriesIncluded ($countriesIncluded)
	setCurrencyCode ($currencyCode)
	setDate ($date)
	setDateFormat ($dateFormat)
	setDateRole ($dateRole)
	setDiscount ($discount)
	setPrice ($price)
	setPriceTypeCode ($priceTypeCode)
	setPublicationFormatId ($publicationFormatId)
	setRegionsExcluded ($regionsExcluded)
	setRegionsIncluded ($regionsIncluded)
	setSupplierId ($supplierId)
	setTaxRateCode ($taxRateCode)
	setTaxTypeCode ($taxTypeCode)

Detailed Description

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

See also:: MarketDAO

Definition at line 16 of file Market.inc.php.

Member Function Documentation

Market._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 323 of file Market.inc.php.

Market.getAgentId ( )

Get the id of the assigned agent, if there is one.

Returns:: string

Definition at line 253 of file Market.inc.php.

Referenced by getAssignedRepresentativeNames().

Market.getAssignedRepresentativeNames ( )

Returns a string containing the name of the reps assigned to this Market territory.

Returns:: string

Definition at line 298 of file Market.inc.php.

References getAgentId(), and getSupplierId().

Market.getCountriesExcluded ( )

Get the excluded countries for this market entry

Returns:: array

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

Referenced by getTerritoriesAsString().

Market.getCountriesIncluded ( )

Get the included countries for this market entry

Returns:: array

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

Referenced by getTerritoriesAsString().

Market.getCurrencyCode ( )

Get the currency code (ONIX value) used for this market (List96).

Returns:: string

Definition at line 156 of file Market.inc.php.

Market.getDate ( )

Get the date for this Market.

Returns:: string

Definition at line 140 of file Market.inc.php.

Market.getDateFormat ( )

Get the date format for this Market.

Returns:: string

Definition at line 124 of file Market.inc.php.

Market.getDateRole ( )

Get the date role for this Market.

Returns:: string

Definition at line 108 of file Market.inc.php.

Market.getDiscount ( )

Get the discount.

Returns:: string

Definition at line 188 of file Market.inc.php.

Market.getPrice ( )

Get the price.

Returns:: string

Definition at line 172 of file Market.inc.php.

Market.getPriceTypeCode ( )

Get the price type code (ONIX code) used for this market (List58).

Returns:: string

Definition at line 205 of file Market.inc.php.

Market.getPublicationFormatId ( )

get publication format id

Returns:: int

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

Market.getRegionsExcluded ( )

Get the excluded regions for this market entry

Returns:: array

Definition at line 92 of file Market.inc.php.

Referenced by getTerritoriesAsString().

Market.getRegionsIncluded ( )

Get the included regions for this market entry

Returns:: array

Definition at line 76 of file Market.inc.php.

Referenced by getTerritoriesAsString().

Market.getSupplierId ( )

Get the id of the assigned supplier, if there is one.

Returns:: string

Definition at line 269 of file Market.inc.php.

Referenced by getAssignedRepresentativeNames().

Market.getTaxRateCode ( )

Get the tax rate code (ONIX value) used for this market (List62).

Returns:: string

Definition at line 221 of file Market.inc.php.

Market.getTaxTypeCode ( )

Get the tax type code used (ONIX value) for this market (List171).

Returns:: string

Definition at line 237 of file Market.inc.php.

Market.getTerritoriesAsString ( )

Returns a string briefly describing the territories for this market

Returns:: string

Definition at line 285 of file Market.inc.php.

References getCountriesExcluded(), getCountriesIncluded(), getRegionsExcluded(), and getRegionsIncluded().

Market.Market ( )

Constructor

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

Market.setAgentId ( $ agentId )

Set the id of the assigned agent.

Parameters:

int

$agentId

Definition at line 261 of file Market.inc.php.

Market.setCountriesExcluded ( $ countriesExcluded )

Set the excluded country list for this market entry

Parameters:

$countriesExcluded

array

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

Market.setCountriesIncluded ( $ countriesIncluded )

Set the included country list for this market entry

Parameters:

$countriesIncluded

array

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

Market.setCurrencyCode ( $ currencyCode )

Set the currency code (ONIX value) for a market.

Parameters:

string

$currencyCode

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

Market.setDate ( $ date )

Set this Market's date.

Parameters:

string

$date

Definition at line 148 of file Market.inc.php.

Market.setDateFormat ( $ dateFormat )

Set the date format for this Market. (List55)

Parameters:

string

$dateFormat

Definition at line 132 of file Market.inc.php.

Market.setDateRole ( $ dateRole )

Set the date role for this Market. (List163)

Parameters:

String

$dateRole

Definition at line 116 of file Market.inc.php.

Market.setDiscount ( $ discount )

Set the discount.

Parameters:

string

$discount

Definition at line 196 of file Market.inc.php.

Market.setPrice ( $ price )

Set the price.

Parameters:

string

$price

Definition at line 180 of file Market.inc.php.

Market.setPriceTypeCode ( $ priceTypeCode )

Set the price type code (ONIX code) for a market.

Parameters:

string

$priceTypeCode

Definition at line 213 of file Market.inc.php.

Market.setPublicationFormatId ( $ publicationFormatId )

set publication format id

Parameters:

$pressId

int

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

Market.setRegionsExcluded ( $ regionsExcluded )

Set the excluded region list for this market entry

Parameters:

$regionsExcluded

array

Definition at line 100 of file Market.inc.php.

Market.setRegionsIncluded ( $ regionsIncluded )

Set the included region list for this market entry

Parameters:

$regionsIncluded

array

Definition at line 84 of file Market.inc.php.

Market.setSupplierId ( $ supplierId )

Set the id of the assigned supplier.

Parameters:

int

$supplierId

Definition at line 277 of file Market.inc.php.

Market.setTaxRateCode ( $ taxRateCode )

Set the tax rate code (ONIX value) for a market.

Parameters:

string

$taxRateCode

Definition at line 229 of file Market.inc.php.

Market.setTaxTypeCode ( $ taxTypeCode )

Set the tax type code (ONIX value) for a market.

Parameters:

string

$taxTypeCode

Definition at line 245 of file Market.inc.php.

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

classes/publicationFormat/Market.inc.php

Market Class Reference

Public Member Functions

Detailed Description

Member Function Documentation