class LegacyCategory implements CategoryInterface, StandardSearchIndexerInterface (View source)

Traits

Properties

protected $categoryEntity from StandardCategoryTrait

Methods

getEntityManager()

No description

setCategoryEntity(Category $category)

No description

getCategoryEntity()

No description

getSetManager()

No description

addSet($handle, $name, $pkg = null, $locked = null) deprecated

No description

getAttributeTypes()

No description

delete()

No description

__construct(Application $application, EntityManager $entityManager)

No description

getLegacyKeyClass()

No description

getSearchIndexer()

Get the indexer instance that manages search indexing (if the attribute category supports indexing).

string|false
getIndexedSearchTable()

Get the name of the indexing table (return false if there's no indexing table).

mixed
getIndexedSearchPrimaryKeyValue(object $mixed)

Get the value of the primary key column of the indexing table that identifies the object to be indexed.

array|false
getSearchIndexFieldDefinition()

Get the definition of the indexing table, excluding attribute-related fields (return false if there's no indexing table).

getAttributeKeyByHandle(string $akHandle)

Get an attribute key given its handle.

getList()

Get all the attribute keys.

getAttributeValues($mixed)

Get all the generic attribute values for an object instance.

Key
addFromRequest(Type $type, Request $request)

Create a new attribute key starting from the data contained in a request.

Key
updateFromRequest(Key $key, Request $request)

Update an existing attribute key with the data contained in a request.

import(Type $type, SimpleXMLElement $element, Package $package = null)

No description

getAttributeKeyByID(int $akID)

Get an attribute key given its ID.

deleteKey(Key $key)

Method called when a key is deleted. This is usually used to delete all the values associated to an attribute key.

deleteValue(AttributeValueInterface $value)

Delete an attribute value.

getAttributeValue(Key $key, $mixed)

Get the generic attribute value of an object for a specific key.

clearAttributeSet(Key $key)

No description

addAttributeKey($type, $args, $pkg = false)

No description

Details

getEntityManager()

setCategoryEntity(Category $category)

Parameters

Category $category

getCategoryEntity()

getSetManager()

addSet($handle, $name, $pkg = null, $locked = null) deprecated

deprecated

Parameters

$handle
$name
$pkg
$locked

getAttributeTypes()

associateAttributeKeyType(Type $type)

Parameters

Type $type

__construct(Application $application, EntityManager $entityManager)

Parameters

Application $application
EntityManager $entityManager

getLegacyKeyClass()

SearchIndexerInterface|null getSearchIndexer()

Get the indexer instance that manages search indexing (if the attribute category supports indexing).

Return Value

SearchIndexerInterface|null

string|false getIndexedSearchTable()

Get the name of the indexing table (return false if there's no indexing table).

Return Value

string|false

mixed getIndexedSearchPrimaryKeyValue(object $mixed)

Get the value of the primary key column of the indexing table that identifies the object to be indexed.

Parameters

object $mixed The object for which we need the identifier

Return Value

mixed

array|false getSearchIndexFieldDefinition()

Get the definition of the indexing table, excluding attribute-related fields (return false if there's no indexing table).

The resulting array can have these keys: - columns: an array describing the table columns - primary: an array containing the names of the columns that define the table primary key - foreignKeys: an array describing the foreign keys.

Return Value

array|false

AttributeKeyInterface|null getAttributeKeyByHandle(string $akHandle)

Get an attribute key given its handle.

Parameters

string $akHandle

Return Value

AttributeKeyInterface|null

AttributeKeyInterface[] getList()

Get all the attribute keys.

Return Value

AttributeKeyInterface[]

AttributeValueInterface[] getAttributeValues($mixed)

Get all the generic attribute values for an object instance.

Parameters

$mixed

Return Value

AttributeValueInterface[]

Key addFromRequest(Type $type, Request $request)

Create a new attribute key starting from the data contained in a request.

Parameters

Type $type The attribute type to be created
Request $request The request instance that contains the data

Return Value

Key

Key updateFromRequest(Key $key, Request $request)

Update an existing attribute key with the data contained in a request.

Parameters

Key $key The attribute key to be updated
Request $request The request instance that contains the data

Return Value

Key

import(Type $type, SimpleXMLElement $element, Package $package = null)

Parameters

Type $type
SimpleXMLElement $element
Package $package

AttributeKeyInterface|null getAttributeKeyByID(int $akID)

Get an attribute key given its ID.

Parameters

int $akID

Return Value

AttributeKeyInterface|null

deleteKey(Key $key)

Method called when a key is deleted. This is usually used to delete all the values associated to an attribute key.

Note: this does NOT delete the source key entity. That is done simply by removing the key through Doctrine. Doctrine then calls the Concrete\Core\Attribute\Key\Listener::preRemove method, which runs this.

Parameters

Key $key

deleteValue(AttributeValueInterface $value)

Delete an attribute value.

Parameters

AttributeValueInterface $value

AttributeValueInterface|null getAttributeValue(Key $key, $mixed)

Get the generic attribute value of an object for a specific key.

Parameters

Key $key
$mixed

Return Value

AttributeValueInterface|null

protected clearAttributeSet(Key $key)

Parameters

Key $key

addAttributeKey($type, $args, $pkg = false)

Parameters

$type
$args
$pkg