Class Category
A common abstraction for the CategoryNode and CategoryData classes.
-
Apptus\ESales\Connector\Category
implements
IteratorAggregate
Methods summary
public
|
|
public
Apptus\ESales\Connector\Attribute |null
|
#
getAttribute( name $name )
Get the attribute with the specified name or null if no such attribute exists for this category.
Get the attribute with the specified name or null if no such attribute exists for this category.
Parameters
- $name
- name of the attribute to get.
Returns
|
public
string
|
#
key( )
Return the key of this category.
Return the key of this category.
Returns
string the key
The key of this category.
|
public
string|mixed
|
#
getValue( string $attributeName, mixed $defaultValue = null )
Get the value of the attribute with the specified $attributeName. The specified $defaultValue
will be returned if no such attribute exists (defaults to null).
Get the value of the attribute with the specified $attributeName. The specified $defaultValue
will be returned if no such attribute exists (defaults to null).
Parameters
- $attributeName
- name of the attribute whose value to retrieve.
- $defaultValue
- value to return if this category does not have an attribute with the specified $attributeName, defaults to null.
Returns
string|mixed The attribute value of attribute with the specified $attributeName, or the supplied $defaultValue
if this category has no attribute matching the name.
|
public
|
|
public
string
|
#
getTicket( )
Get the notification ticket of this category.
Get the notification ticket of this category.
Returns
string
|
public
string
|
#
getDisplayName( )
Get the display name of this category.
Returns
string the display name
|
public
string
|
#
getParentKey( )
Get the parent key of this category.
Get the parent key of this category.
Returns
string the parent key
|
public
string
|
#
getLocale( )
Get the locale of this category.
Get the locale of this category.
Returns
string the locale
|
public
integer
|
#
getProductCount( )
Get the total number of products contained in this category. Will be -1 if not supported by the requested panel.
Get the total number of products contained in this category. Will be -1 if not supported by the requested panel.
Returns
integer the product count
|
public
|
|