Class CollectionAttributeKey

Description

An object that represents metadata added to pages. They key object maps to the "type" of metadata added to pages.

Located in /models/attribute/categories/collection.php (line 23)

Object
   |
   --AttributeKey
      |
      --CollectionAttributeKey
Variable Summary
Method Summary
 static void getByHandle ( $akHandle)
 static void getByID ( $akID)
 static void getColumnHeaderList ()
 static void getList ()
 static void getSearchableIndexedList ()
 static void getSearchableList ()
 void add ( $at,  $args, [ $pkg = false])
 void delete ()
 void get ( $akID)
 AttributeValueList getAttributes ( $cID,  $cvID, [ $method = 'getValue'])
 void getAttributeValue ( $avID, [ $method = 'getValue'])
 void saveAttribute ( $nvc, [ $value = false])
Variables
mixed $searchIndexFieldDefinition = 'cID I(11) UNSIGNED NOTNULL DEFAULT 0 PRIMARY' (line 29)
  • access: protected
Methods
static getByHandle (line 86)
  • access: public
void getByHandle ( $akHandle)
  • $akHandle
static getByID (line 72)
  • access: public
void getByID ( $akID)
  • $akID
static getColumnHeaderList (line 50)
  • access: public
void getColumnHeaderList ()
static getList (line 93)
  • access: public
void getList ()

Redefinition of:
AttributeKey::getList()
Returns a list of all attributes of this category
static getSearchableIndexedList (line 53)
  • access: public
void getSearchableIndexedList ()
static getSearchableList (line 57)
  • access: public
void getSearchableList ()
add (line 121)
  • access: public
void add ( $at,  $args, [ $pkg = false])
  • $at
  • $args
  • $pkg

Redefinition of:
AttributeKey::add()
Adds an attribute key.
delete (line 136)
  • access: public
void delete ()

Redefinition of:
AttributeKey::delete()
get (line 100)
  • access: public
void get ( $akID)
  • $akID
getAttributes (line 36)

Returns an attribute value list of attributes and values (duh) which a collection version can store against its object.

  • access: public
AttributeValueList getAttributes ( $cID,  $cvID, [ $method = 'getValue'])
  • $cID
  • $cvID
  • $method
getAttributeValue (line 61)
  • access: public
void getAttributeValue ( $avID, [ $method = 'getValue'])
  • $avID
  • $method
getIndexedSearchTable (line 25)
  • access: public
void getIndexedSearchTable ()

Redefinition of:
AttributeKey::getIndexedSearchTable()
saveAttribute (line 104)
  • access: protected
void saveAttribute ( $nvc, [ $value = false])
  • $nvc
  • $value

Redefinition of:
AttributeKey::saveAttribute()
Calls the functions necessary to save this attribute to the database. If no passed value is passed, then we save it via the stock form.

Inherited Methods

Inherited From AttributeKey

 AttributeKey::add()
 AttributeKey::addAttributeValue()
 AttributeKey::clearAttributeSets()
 AttributeKey::createIndexedSearchTable()
 AttributeKey::delete()
 AttributeKey::duplicate()
 AttributeKey::getAttributeKeyCategoryID()
 AttributeKey::getAttributeKeyDisplayHandle()
 AttributeKey::getAttributeKeyHandle()
 AttributeKey::getAttributeKeyIconSRC()
 AttributeKey::getAttributeKeyID()
 AttributeKey::getAttributeKeyName()
 AttributeKey::getAttributeKeyType()
 AttributeKey::getAttributeSets()
 AttributeKey::getAttributeType()
 AttributeKey::getAttributeValueIDList()
 AttributeKey::getController()
 AttributeKey::getIndexedSearchTable()
 AttributeKey::getInstanceByID()
 AttributeKey::getKeyHandle()
 AttributeKey::getKeyID()
 AttributeKey::getKeyName()
 AttributeKey::getList()
 AttributeKey::getListByPackage()
 AttributeKey::getPackageHandle()
 AttributeKey::getPackageID()
 AttributeKey::getSearchIndexFieldDefinition()
 AttributeKey::inAttributeSet()
 AttributeKey::isAttributeKeyAutoCreated()
 AttributeKey::isAttributeKeyColumnHeader()
 AttributeKey::isAttributeKeyContentIndexed()
 AttributeKey::isAttributeKeyEditable()
 AttributeKey::isAttributeKeySearchable()
 AttributeKey::load()
 AttributeKey::outputSearchHTML()
 AttributeKey::refreshCache()
 AttributeKey::reindex()
 AttributeKey::render()
 AttributeKey::saveAttribute()
 AttributeKey::saveAttributeForm()
 AttributeKey::setAttribute()
 AttributeKey::setAttributeKeyColumnHeader()
 AttributeKey::setAttributeSet()
 AttributeKey::update()
 AttributeKey::updateSearchIndex()
 AttributeKey::validateAttributeForm()
 AttributeKey::__destruct()

Documentation generated on Thu, 15 Sep 2011 16:36:19 -0700 by phpDocumentor 1.4.1