Class AttributeKey

Description
Description | Descendents | Methods (details)

Located in /models/attribute/key.php (line 3) 

Object
   |
   --AttributeKey
Direct descendents
Description | Descendents | Methods (details)
Class Description
class CollectionAttributeKey An object that represents metadata added to pages. They key object maps to the "type" of metadata added to pages.
class FileAttributeKey An object that represents metadata added to files.
class UserAttributeKey An object that represents metadata added to users.
Method Summary
Description | Descendants | Methods (details)
static void getInstanceByID ( $akID)
static void getList ( $akCategoryHandle, [ $filters = array()])
static void getListByPackage ( $pkg)
void __destruct ()
void add ( $akCategoryHandle,  $type,  $args, [ $pkg = false])
void addAttributeValue ()
void clearAttributeSets ()
void createIndexedSearchTable ()
void delete ()
void duplicate ([ $args = array()])
void getAttributeKeyCategoryID ()
void getAttributeKeyDisplayHandle ()
void getAttributeKeyHandle ()
void getAttributeKeyIconSRC ()
void getAttributeKeyID ()
void getAttributeKeyName ()
void getAttributeKeyType ()
void getAttributeSets ()
void getAttributeType ()
void getAttributeValueIDList ()
void getController ()
void getIndexedSearchTable ()
void getKeyHandle ()
void getKeyID ()
void getKeyName ()
void getPackageHandle ()
void getPackageID ()
void getSearchIndexFieldDefinition ()
void inAttributeSet ( $as)
void isAttributeKeyAutoCreated ()
void isAttributeKeyColumnHeader ()
void isAttributeKeyContentIndexed ()
void isAttributeKeyEditable ()
void isAttributeKeySearchable ()
void load ( $akID)
void outputSearchHTML ()
void refreshCache ()
void reindex ( $tbl,  $columnHeaders,  $attribs,  $rs)
void render ([ $view = 'view'], [ $value = false], [ $return = false])
void saveAttribute ( $attributeValue, [ $passedValue = false])
void saveAttributeForm ( $obj)
void setAttribute ( $obj,  $value)
void setAttributeKeyColumnHeader ( $r)
void setAttributeSet ( $as)
void update ( $args)
void updateSearchIndex ([ $prevHandle = false])
void validateAttributeForm ([ $h = false])
Methods
Description | Descendents | Methods (details)
static getInstanceByID (line 74)
  • access: public
void getInstanceByID ( $akID)
  • $akID
static getList (line 95)

Returns a list of all attributes of this category

  • access: public
void getList ( $akCategoryHandle, [ $filters = array()])
  • $akCategoryHandle
  • $filters
Redefined in descendants as:
static getListByPackage (line 122)

Note, this queries both the pkgID found on the AttributeKeys table AND any attribute keys of a special type installed by that package, and any in categories by that package.

That's because a special type, if the package is uninstalled, is going to be unusable by attribute keys that still remain.

  • access: public
void getListByPackage ( $pkg)
  • $pkg
Destructor __destruct (line 503)
  • access: public
void __destruct ()
add (line 153)

Adds an attribute key.

  • access: protected
void add ( $akCategoryHandle,  $type,  $args, [ $pkg = false])
  • $akCategoryHandle
  • $type
  • $args
  • $pkg
Redefined in descendants as:
addAttributeValue (line 449)

Adds a generic attribute record (with this type) to the AttributeValues table

  • access: public
void addAttributeValue ()
clearAttributeSets (line 534)
  • access: public
void clearAttributeSets ()
createIndexedSearchTable (line 518)
  • access: public
void createIndexedSearchTable ()
delete (line 401)
  • access: public
void delete ()
Redefined in descendants as:
duplicate (line 280)

Duplicates an attribute key

  • access: public
void duplicate ([ $args = array()])
  • $args
getAttributeKeyCategoryID (line 27)
  • access: public
void getAttributeKeyCategoryID ()
getAttributeKeyDisplayHandle (line 19)
  • access: public
void getAttributeKeyDisplayHandle ()
getAttributeKeyHandle (line 17)

Returns the handle for this attribute key

  • access: public
void getAttributeKeyHandle ()
getAttributeKeyIconSRC (line 461)
  • access: public
void getAttributeKeyIconSRC ()
getAttributeKeyID (line 26)

Returns the ID for this attribute key

  • access: public
void getAttributeKeyID ()
getAttributeKeyName (line 12)

Returns the name for this attribute key

  • access: public
void getAttributeKeyName ()
getAttributeKeyType (line 90)
  • access: public
void getAttributeKeyType ()
getAttributeSets (line 539)
  • access: public
void getAttributeSets ()
getAttributeType (line 86)

Returns an attribute type object

  • access: public
void getAttributeType ()
getAttributeValueIDList (line 435)
  • access: public
void getAttributeValueIDList ()
getController (line 466)
  • access: public
void getController ()
getIndexedSearchTable (line 5)
  • access: public
void getIndexedSearchTable ()
Redefined in descendants as:
getKeyHandle (line 575)

Returns the handle for this attribute key

  • access: public
void getKeyHandle ()
getKeyID (line 580)

Returns the ID for this attribute key

  • access: public
void getKeyID ()
getKeyName (line 570)
  • access: public
void getKeyName ()
getPackageHandle (line 70)
  • access: public
void getPackageHandle ()
getPackageID (line 69)
  • access: public
void getPackageID ()
getSearchIndexFieldDefinition (line 6)
  • access: public
void getSearchIndexFieldDefinition ()
inAttributeSet (line 300)
  • access: public
void inAttributeSet ( $as)
  • $as
isAttributeKeyAutoCreated (line 42)

Returns whether the attribute key is one that was automatically created by a process.

  • access: public
void isAttributeKeyAutoCreated ()
isAttributeKeyColumnHeader (line 47)

Returns whether the attribute key is included in the standard search for this category.

  • access: public
void isAttributeKeyColumnHeader ()
isAttributeKeyContentIndexed (line 37)

Returns whether the attribute key is indexed as a "keyword search" field.

  • access: public
void isAttributeKeyContentIndexed ()
isAttributeKeyEditable (line 52)

Returns whether the attribute key is one that can be edited through the frontend.

  • access: public
void isAttributeKeyEditable ()
isAttributeKeySearchable (line 32)

Returns whether the attribute key is searchable

  • access: public
void isAttributeKeySearchable ()
load (line 57)

Loads the required attribute fields for this instantiated attribute

  • access: protected
void load ( $akID)
  • $akID
Redefined in descendants as:
outputSearchHTML (line 565)
  • deprecated:
  • access: public
void outputSearchHTML ()
refreshCache (line 221)
  • access: public
void refreshCache ()
Redefined in descendants as:
reindex (line 312)
  • access: public
void reindex ( $tbl,  $columnHeaders,  $attribs,  $rs)
  • $tbl
  • $columnHeaders
  • $attribs
  • $rs
render (line 479)

Renders a view for this attribute key. If no view is default we display it's "view" Valid views are "view", "form" or a custom view (if the attribute has one in its directory) Additionally, an attribute does not have to have its own interface. If it doesn't, then whatever is printed in the corresponding $view function in the attribute's controller is printed out.

  • access: public
void render ([ $view = 'view'], [ $value = false], [ $return = false])
  • $view
  • $value
  • $return
saveAttribute (line 490)

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.

  • access: protected
void saveAttribute ( $attributeValue, [ $passedValue = false])
  • $attributeValue
  • $passedValue
Redefined in descendants as:
saveAttributeForm (line 552)

Saves an attribute using its stock form.

  • access: public
void saveAttributeForm ( $obj)
  • $obj
setAttribute (line 559)

Sets an attribute directly with a passed value.

  • access: public
void setAttribute ( $obj,  $value)
  • $obj
  • $value
setAttributeKeyColumnHeader (line 306)
  • access: public
void setAttributeKeyColumnHeader ( $r)
  • $r
setAttributeSet (line 527)
  • access: public
void setAttributeSet ( $as)
  • $as
update (line 228)

Updates an attribute key.

  • access: public
void update ( $args)
  • $args
Redefined in descendants as:
updateSearchIndex (line 341)
  • access: public
void updateSearchIndex ([ $prevHandle = false])
  • $prevHandle
validateAttributeForm (line 507)
  • access: public
void validateAttributeForm ([ $h = false])
  • $h

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