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

Public Member Functions

 Category ()
 
 getDescription ($locale)
 
 getImage ()
 
 getLocalizedDescription ()
 
 getLocalizedTitle ()
 
 getParentId ()
 
 getPath ()
 
 getPressId ()
 
 getTitle ($locale)
 
 setDescription ($description, $locale)
 
 setImage ($image)
 
 setParentId ($parentId)
 
 setPath ($path)
 
 setPressId ($pressId)
 
 setTitle ($title, $locale)
 
- 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

Describes basic Category properties.

See Also
CategoryDAO

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

Member Function Documentation

Category::Category ( )

Constructor.

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

Category::getDescription (   $locale)

Get description of category.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Category::getImage ( )

Get the image.

Returns
array

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

References DataObject\getData().

Category::getLocalizedDescription ( )

Get localized description of the category.

Returns
string

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

References DataObject\getLocalizedData().

Category::getLocalizedTitle ( )

Get localized title of the category.

Returns
string

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

References DataObject\getLocalizedData().

Category::getParentId ( )

Get ID of parent category.

Returns
int

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

References DataObject\getData().

Category::getPath ( )

Get category path.

Returns
string

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

References DataObject\getData().

Category::getPressId ( )

Get ID of press.

Returns
int

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

References DataObject\getData().

Category::getTitle (   $locale)

Get title of category.

Parameters
$localestring
Returns
string

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

References DataObject\getData().

Category::setDescription (   $description,
  $locale 
)

Set description of category.

Parameters
$descriptionstring
$localestring

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

References DataObject\setData().

Category::setImage (   $image)

Set the image.

Parameters
$imagearray

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

References DataObject\setData().

Category::setParentId (   $parentId)

Set ID of parent category.

Parameters
$parentIdint

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

References DataObject\setData().

Category::setPath (   $path)

Set category path.

Parameters
$pathstring

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

References DataObject\setData().

Category::setPressId (   $pressId)

Set ID of press.

Parameters
$pressIdint

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

References DataObject\setData().

Category::setTitle (   $title,
  $locale 
)

Set title of category.

Parameters
$titlestring
$localestring

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

References DataObject\setData().


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