Category Class Reference

Inheritance diagram for Category:

Public Member Functions
	getContextId ()
	getDescription ($locale)
	getImage ()
	getLocalizedDescription ()
	getLocalizedTitle ()
	getParentId ()
	getPath ()
	getSequence ()
	getSortOption ()
	getTitle ($locale)
	setContextId ($contextId)
	setDescription ($description, $locale)
	setImage ($image)
	setParentId ($parentId)
	setPath ($path)
	setSequence ($sequence)
	setSortOption ($sortOption)
	setTitle ($title, $locale)
Public Member Functions inherited from DataObject
	__construct ()
	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

Describes basic Category properties.

See also

CategoryDAO

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

Member Function Documentation

getContextId()

Category::getContextId

(

)

Get ID of context.

Returns

int

Definition at line 22 of file Category.inc.php.

References DataObject\getData().

getDescription()

Category::getDescription

(

$locale

)

Get description of category.

Parameters

$locale

string

Returns

string

Definition at line 121 of file Category.inc.php.

References DataObject\getData().

getImage()

Category::getImage

(

)

Get the image.

Returns

array

Definition at line 138 of file Category.inc.php.

References DataObject\getData().

getLocalizedDescription()

Category::getLocalizedDescription

(

)

Get localized description of the category.

Returns

string

Definition at line 112 of file Category.inc.php.

References DataObject\getLocalizedData().

getLocalizedTitle()

Category::getLocalizedTitle

(

)

Get localized title of the category.

Returns

string

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

References DataObject\getLocalizedData().

getParentId()

Category::getParentId

(

)

Get ID of parent category.

Returns

int

Definition at line 38 of file Category.inc.php.

References DataObject\getData().

getPath()

Category::getPath

(

)

Get category path.

Returns

string

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

References DataObject\getData().

getSequence()

Category::getSequence

(

)

Get sequence of category.

Returns

int

Definition at line 54 of file Category.inc.php.

References DataObject\getData().

getSortOption()

Category::getSortOption

(

)

Get the option how the books in this category should be sorted, in the form: concat(sortBy, sortDir).

Returns

string

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

References DataObject\getData().

getTitle()

Category::getTitle

(

$locale

)

Get title of category.

Parameters

$locale

string

Returns

string

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

References DataObject\getData().

setContextId()

Category::setContextId

(

$contextId

)

Set ID of context.

Parameters

$contextId

int

Definition at line 30 of file Category.inc.php.

References DataObject\setData().

setDescription()

Category::setDescription	(		$description,
			$locale
	)

Set description of category.

Parameters

$description	string
$locale	string

Definition at line 130 of file Category.inc.php.

References DataObject\setData().

setImage()

Category::setImage

(

$image

)

Set the image.

Parameters

$image

array

Definition at line 146 of file Category.inc.php.

References DataObject\setData().

setParentId()

Category::setParentId

(

$parentId

)

Set ID of parent category.

Parameters

$parentId

int

Definition at line 46 of file Category.inc.php.

References DataObject\setData().

setPath()

Category::setPath

(

$path

)

Set category path.

Parameters

$path

string

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

References DataObject\setData().

setSequence()

Category::setSequence

(

$sequence

)

Set sequence of category.

Parameters

$sequence

int

Definition at line 62 of file Category.inc.php.

References DataObject\setData().

setSortOption()

Category::setSortOption

(

$sortOption

)

Set the option how the books in this categpry should be sorted, in the form: concat(sortBy, sortDir).

Parameters

$sortOption

string

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

References DataObject\setData().

setTitle()

Category::setTitle	(		$title,
			$locale
	)

Set title of category.

Parameters

$title	string
$locale	string

Definition at line 104 of file Category.inc.php.

References DataObject\setData().

---

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

• Category.inc.php