Class Category

Concrete\Core\Foundation\Object
Extended by Concrete\Core\Attribute\Key\Category

Methods summary

public integer
# getAttributeKeyCategoryID( )
public string
# getAttributeKeyCategoryHandle( )
public integer
# allowAttributeSets( )
public integer|null
# getPackageID( )
public string
# getPackageHandle( )
public static Concrete\Core\Attribute\Key\Category|null
# getByID( integer $akCategoryID )
public static Concrete\Core\Attribute\Key\Category|null
# getByHandle( string $akCategoryHandle )
public boolean
# handleExists( string $akHandle )
public static
# exportList( SimpleXMLElement $xml )

This function appends a list of attribute categories to the supplied SimpleXMLElement node.

public Concrete\Core\Attribute\Key\Key|false
# getAttributeKeyByHandle( string $akHandle )
public Concrete\Core\Attribute\Key\Key|false
# getAttributeKeyByID( integer $akID )
public Concrete\Core\Attribute\Key\Key[]
# getUnassignedAttributeKeys( )
public static array
# getListByPackage( Package $pkg )
public
# setAllowAttributeSets( integer $val )

This function will set the setting which determines if the category allows for sets or not.

public Concrete\Core\Attribute\Set[]
# getAttributeSets( )
public Concrete\Core\Attribute\Set
# getAttributeSetByHandle( string $asHandle )
public
# clearAttributeKeyCategoryColumnHeaders( )

Sets the Attribute Key Column Headers to false for all Attribute Keys in the category.

public
# associateAttributeKeyType( Concrete\Core\Attribute\Type $at )

Associates the given attribute type with the current attribute category.

public boolean
# hasAttributeKeyTypeAssociated( Concrete\Core\Attribute\Type $at )
public
# clearAttributeKeyCategoryTypes( )

Removes all associated attribute types from the current category.

public
# delete( )

Removes the attribute category and the association records for category types. Additionally, this will unset any Category Column Headers from attribute keys where these were set for this category and will rescan the set display order.

public static Concrete\Core\Attribute\Key\Category[]
# getList( )
public static Concrete\Core\Attribute\Key\Category|null
# add( string $akCategoryHandle, integer $akCategoryAllowSets = 0, boolean|Package $pkg = false )
public null|Concrete\Core\Attribute\Set
# addSet( string $asHandle, string $asName, boolean|Package $pkg = false, integer $asIsLocked = 1 )
protected
# rescanSetDisplayOrder( )

This function rescans all attribute sets and assigns display order ID's based on their current display order and set ID so that all display order ID's are unique and sequential starting at 0.

public
# updateAttributeSetDisplayOrder( array $asIDs )

This takes in array of attribute set ID's and reorders those ID's starting from 0 based on the order of the array provided.

Constants summary

integer ASET_ALLOW_NONE
# 0
integer ASET_ALLOW_SINGLE
# 1
integer ASET_ALLOW_MULTIPLE
# 2

Properties summary

protected $akCategoryID
#
protected $akCategoryHandle
#
protected $akCategoryAllowSets
#
protected $pkgID
#

Properties inherited from Concrete\Core\Foundation\Object

$error