ZMObject
└─ZMCategory
public class ZMCategory
extends ZMObject
| Fields inherited from org.zenmagick.core.ZMObject | |
|---|---|
| properties_ | |
| Constructor Summary | |
|---|---|
Create new instance. |
|
| Method Summary | |
|---|---|
| void | addChild(mixed child) Add a child category. |
| array | getChildIds(boolean includeSelf) Get a list of all child category ids. |
| array | Get the child categories of this category. |
| string | Get the category description. |
| int | getId() Get the id. |
| string | getImage() Get the category image (if any). |
| ZMImageInfo | Get the categories image ino instance (if any). |
| int | Get the language id. |
| ZMMetaTagDetails | getMetaTagDetails(int languageId) Get meta tag details if available. |
| string | getName() Get the category name. |
| ZMCategory | Get the parent category (if any). |
| int | Get the parent category id (if any). |
| string | getPath() Get the category path. |
| array | Get the category path array. |
| array | Get a list of allowed product types. |
| int | Get the sort order. |
| boolean | Checks if this category has children. |
| boolean | Checks if the catgory has a parent. |
| boolean | isActive() Checks if this category is active; ie. |
| void | setActive(boolean active) Set the active flag. |
| void | setDescription(string description) Set the category description. |
| void | setId(int id) Set the id. |
| void | setImage(string image) Set the category image (if any). |
| void | setLanguageId(int languageId) Set the language id. |
| void | setName(string name) Set the category name. |
| void | setParentId(int parentId) Set the parent category id. |
| void | setSortOrder(int sortOrder) Set the sort order. |
| Methods inherited from org.zenmagick.core.ZMObject | |
|---|---|
| attachMethod, get, getAttachedMethods, getPropertyNames, set, singleton | |
public ZMCategory()
Create new instance.
public void addChild(mixed child)
Add a child category.
public array getChildIds(boolean includeSelf)
Get a list of all child category ids.
true.public array getChildren()
Get the child categories of this category.
ZMcategory instances.public string getDescription()
Get the category description.
public int getId()
Get the id.
public string getImage()
Get the category image (if any).
public ZMImageInfo getImageInfo()
Get the categories image ino instance (if any).
ZMImageInfo for this categorie's image, or null.public int getLanguageId()
Get the language id.
public ZMMetaTagDetails getMetaTagDetails(int languageId)
Get meta tag details if available.
null.public string getName()
Get the category name.
public ZMCategory getParent()
Get the parent category (if any).
null.public int getParentId()
Get the parent category id (if any).
0.public string getPath()
Get the category path.
This method will return a value that can be used as cPath value in a URL
pointing to this category.
cPath=[PATH].public array getPathArray()
Get the category path array.
public array getProductTypeIds()
Get a list of allowed product types.
An empty list means no restrictions.
public int getSortOrder()
Get the sort order.
public boolean hasChildren()
Checks if this category has children.
true if this category has children, false if not.public boolean hasParent()
Checks if the catgory has a parent.
true if this category has a parent, false if not.public boolean isActive()
Checks if this category is active; ie. visible in the storefront.
true if this category is active, false if not.public void setActive(boolean active)
Set the active flag.
true if this category is active, false if not.public void setDescription(string description)
Set the category description.
public void setId(int id)
Set the id.
public void setImage(string image)
Set the category image (if any).
public void setLanguageId(int languageId)
Set the language id.
public void setName(string name)
Set the category name.
public void setParentId(int parentId)
Set the parent category id.
public void setSortOrder(int sortOrder)
Set the sort order.
A single category