TagElementType

Type: Class
Namespace: Craft
Inherits: Craft\TagElementType » Craft\BaseElementType » Craft\BaseComponentType » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
Implements: Craft\IComponentType, Craft\IElementType, IApplicationComponent
Since: 1.1

The TagElementType class is responsible for implementing and definingtags as a native element type in Craft.

# Public Properties

Property	Description
$behaviors (opens new window)	array (opens new window) – The behaviors that should be attached to this component.

# Protected Properties

Property	Description
$componentType	string (opens new window)

# Public Methods

Method	Description
__call() (opens new window)	Calls the named method which is not a class method.
__get() (opens new window)	Returns a property value, an event handler list or a behavior based on its name.
__isset() (opens new window)	Checks if a property value is null.
__set() (opens new window)	Sets value of a component property.
__unset() (opens new window)	Sets a component property to be null.
asa() (opens new window)	Returns the named behavior object.
attachBehavior() (opens new window)	Attaches a behavior to this component.
attachBehaviors() (opens new window)	Attaches a list of behaviors to the component.
attachEventHandler() (opens new window)	Attaches an event handler to an event.
canGetProperty() (opens new window)	Determines whether a property can be read.
canSetProperty() (opens new window)	Determines whether a property can be set.
defineAvailableTableAttributes()	Defines all of the available columns that can be shown in table views.
defineCriteriaAttributes()	Defines any custom element criteria attributes for this element type.
defineSearchableAttributes()	Defines which element model attributes should be searchable.
defineSortableAttributes()	Defines the attributes that elements can be sorted by.
detachBehavior() (opens new window)	Detaches a behavior from the component.
detachBehaviors() (opens new window)	Detaches all behaviors from the component.
detachEventHandler() (opens new window)	Detaches an existing event handler.
disableBehavior() (opens new window)	Disables an attached behavior.
disableBehaviors() (opens new window)	Disables all behaviors attached to this component.
enableBehavior() (opens new window)	Enables an attached behavior.
enableBehaviors() (opens new window)	Enables all behaviors attached to this component.
evaluateExpression() (opens new window)	Evaluates a PHP expression or callback under the context of this component.
getAvailableActions()	Returns the available element actions for a given source (if one is provided).
getClassHandle()	Returns the component’s handle, ideally based on the class name.
getContentFieldColumnsForElementsQuery()	Returns the field column names that should be selected from the content table.
getContentTableForElementsQuery()	Returns the content table name that should be joined into an elements query for a given element criteria.
getDefaultTableAttributes()	Returns the list of table attribute keys that should be shown by default.
getEagerLoadingMap()	Returns an array that maps source-to-target element IDs based on the given sub-property handle.
getEditorHtml()	Returns the HTML for an editor HUD for the given element.
getElementQueryStatusCondition()	Returns the element query condition for a custom status criteria.
getEventHandlers() (opens new window)	Returns the list of attached event handlers for an event.
getFieldsForElementsQuery()	Returns the fields that should take part in an upcoming elements qurery.
getIndexHtml()	Returns the element index HTML.
getIsInitialized() (opens new window)	Checks if this application component has been initialized.
getName()	Returns the component’s name.
getSource()	Returns a source by its key and context.
getSources()	Returns this element type's sources.
getStatuses()	Returns all of the possible statuses that elements of this type may have.
getTableAttributeHtml()	Returns the HTML that should be shown for a given element’s attribute in Table View.
hasContent()	Returns whether this element type will be storing any data in the `content` table (tiles or custom fields).
hasEvent() (opens new window)	Determines whether an event is defined.
hasEventHandler() (opens new window)	Checks whether the named event has attached handlers.
hasProperty() (opens new window)	Determines whether a property is defined.
hasStatuses()	Returns whether this element type can have statuses.
hasTitles()	Returns whether this element type has titles.
init() (opens new window)	Initializes the application component.
isInitialized()	Checks if this application component has been initialized yet, or not.
isLocalized()	Returns whether this element type stores data on a per-locale basis.
isSelectable()	Returns whether this component should be shown when the user is creating a component of this type.
modifyElementsQuery()	Modifies an element query targeting elements of this type.
onAfterMoveElementInStructure()	Performs actions after an element has been moved within a structure.
populateElementModel()	Populates an element model based on a query result.
raiseEvent() (opens new window)	Raises an event.
routeRequestForMatchedElement()	Routes the request when the URI matches an element.
saveElement()	Saves a given element.

# `defineCriteriaAttributes()`

Defines any custom element criteria attributes for this element type.

This method returns an array which will get merged into the array defined in {@link ElementCriteriaModel::defineAttributes()}, when new ElementCriteriaModel instances are created targeting this element type (generally from {@link ElementsService::getCriteria() craft()->elements->getCriteria()}).

If this method were to return the following:

return array(
    'foo' => AttributeType::String,
    'bar' => AttributeType::String,
);

then when someone creates a new ElementCriteriaModel instance targeting this elmeent type, they will be able to do this:

$criteria = craft()->elements->getCriteria('ThisElementType');
$criteria->foo = 'FooParamValue';
$criteria->bar = 'BarParamValue';

You can check for these custom criteria attributes, and factor their values into the actual database query, from {@link modifyElementsQuery()}.

IElementType::defineCriteriaAttributes()

View source (opens new window)

Returns

array (opens new window) – Custom criteria attributes.

Signature

public array defineCriteriaAttributes ( )

# `defineSearchableAttributes()`

Defines which element model attributes should be searchable.

This method should return an array of attribute names that can be accessed on your {@link BaseElementModel element model} (for example, the attributes defined by your element model’s {@link BaseElementType::defineAttributes() defineAttributes()} method). {@link SearchService} will call this method when it is indexing keywords for one of your elements, and for each attribute it returns, it will fetch the corresponding property’s value on the element.

For example, if your elements have a “color” attribute which you want to be indexed, this method could return:

return array('color');

Not only will the “color” attribute’s values start getting indexed, but users will also be able to search directly against that attribute’s values using this search syntax:

color:blue

There is no need for this method to worry about the ‘title’ or ‘slug’ attributes, or custom field handles; those are indexed automatically.

IElementType::defineSearchableAttributes()

View source (opens new window)

Returns

array (opens new window) – The attributes that should be searchable

Signature

public array defineSearchableAttributes ( )

# `getEditorHtml()`

Returns the HTML for an editor HUD for the given element.

IElementType::getEditorHtml()

View source (opens new window)

Arguments

$element (Craft\BaseElementModel) – The element being edited.

Returns

string (opens new window) – The HTML for the editor HUD.

Signature

public string getEditorHtml ( Craft\BaseElementModel $element )

# `getName()`

Returns the component’s name.

This is what your component will be called throughout the Control Panel.

IComponentType::getName()

View source (opens new window)

Returns

string (opens new window) – The component’s name.

Signature

public string getName ( )

# `getSources()`

Returns this element type's sources.

This defines what will show up in the source list on element indexes and element selector modals.

Each item in the array should have a key that identifies the source’s key (e.g. "section:3"), and should be set to an array that has the following keys:

label – The human-facing label of the source.
criteria – An array of criteria parameters that the source should use when the source is selected. (Optional)
data – An array of data-X attributes that should be set on the source’s <a> tag in the source list’s, HTML, where each key is the name of the attribute (without the “data-” prefix), and each value is the value of the attribute. (Optional)
defaultSort – A string identifying the sort attribute that should be selected by default, or an array where the first value identifies the sort attribute, and the second determines which direction to sort by. (Optional)
hasThumbs – A boolean that defines whether this source supports Thumbs View. (Use your element model’s {@link BaseElementModel::getThumbUrl() getThumbUrl()} method to define your elements’ thumb URL.) (Optional)
structureId – The ID of the Structure that contains the elements in this source. If set, Structure View will be available to this source. (Optional)
newChildUrl – The URL that should be loaded when a usel select’s the “New child” menu option on an element in this source while it is in Structure View. (Optional)
nested – An array of sources that are nested within this one. Each nested source can have the same keys as top-level sources.

IElementType::getSources()

View source (opens new window)

Arguments

$context (string (opens new window), null (opens new window)) – The context ('index' or 'modal').

Returns

array (opens new window), false (opens new window) – The element type's sources.

Signature

public array, false getSources ( $context = null )

# `hasContent()`

Returns whether this element type will be storing any data in the content table (tiles or custom fields).

IElementType::hasContent()

View source (opens new window)

Returns

boolean (opens new window) – Whether the element type has content. Default is false.

Signature

public boolean hasContent ( )

# `hasTitles()`

Returns whether this element type has titles.

IElementType::hasTitles()

View source (opens new window)

Returns

boolean (opens new window) – Whether the element type has titles. Default is false.

Signature

public boolean hasTitles ( )

# `isLocalized()`

Returns whether this element type stores data on a per-locale basis.

If this returns true, the element model’s {@link BaseElementModel::getLocales() getLocales()} method will be responsible for defining which locales its data should be stored in.

IElementType::isLocalized()

View source (opens new window)

Returns

boolean (opens new window) – Whether the element type is localized. Default is false.

Signature

public boolean isLocalized ( )

# `modifyElementsQuery()`

Modifies an element query targeting elements of this type.

If your element type is storing additional data in its own table, this method is the place to join that table in.

$query
    ->addSelect('mytable.foo, mytable.bar')
    ->join('mytable mytable', 'mytable.id = elements.id');

This is also where you get to check the {@link ElementCriteriaModel} for all the custom attributes that this element type supports via {@defineCriteriaAttributes()}, and modify the database query to reflect those parameters.

if ($criteria->foo)
{
    $query->andWhere(DbHelper::parseParam('mytable.foo', $criteria->foo, $query->params));
}

if ($criteria->bar)
{
    $query->andWhere(DbHelper::parseParam('mytable.bar', $criteria->bar, $query->params));
}

If you are able to determine from the element criteria’s paramteers that there’s no way that the query is going to match any elements, you can have it return false. The query will be stopped before it ever gets a chance to execute.

IElementType::modifyElementsQuery()

View source (opens new window)

Arguments

$query (Craft\DbCommand) – The database query currently being built to find the elements.
$criteria (Craft\ElementCriteriaModel) – The criteria that is being used to find the elements.

Returns

mixed – false in the event that the method is sure that no elements are going to be found.

Signature

public mixed modifyElementsQuery ( Craft\DbCommand $query, Craft\ElementCriteriaModel $criteria )

# `populateElementModel()`

Populates an element model based on a query result.

This method is called by {@link ElementsService::findElements()} after it has finished fetching all of the matching elements’ rows from the database.

For each row of data returned by the query, it will call this method on the element type, and it is up to this method to take that array of raw data from the database, and populate a new element model with it.

You should be able to accomplish this with a single line:

return MyElementTypeModel::populateModel($row);

IElementType::populateElementModel()

View source (opens new window)

Arguments

$row (array (opens new window)) – The row of data in the database query result.

Returns

array (opens new window) – The element model, populated with the data in $row.

Signature

public array populateElementModel ( $row )

# `saveElement()`

Saves a given element.

This method will be called when an Element Editor’s Save button is clicked. It should just wrap your service’s saveX() method.

IElementType::saveElement()

View source (opens new window)

Arguments

$element (Craft\BaseElementModel) – The element being saved.
$params (array (opens new window)) – Any element params found in the POST data.

Returns

boolean (opens new window) – Whether the element was saved successfully.

Signature

public boolean saveElement ( Craft\BaseElementModel $element, $params )

# Protected Methods

Method	Description
getTableAttributesForSource()	Returns the attributes that should be shown for the given source.
prepElementCriteriaForTableAttribute()	Preps the element criteria for a given table attribute

← TableFieldType TagGroupModel →

TagElementType

# Public Properties

# Protected Properties

# Public Methods

# defineCriteriaAttributes()

Returns

Signature

# defineSearchableAttributes()

Returns

Signature

# getEditorHtml()

Arguments

Returns

Signature

# getName()

Returns

Signature

# getSources()

Arguments

Returns

Signature

# hasContent()

Returns

Signature

# hasTitles()

Returns

Signature

# isLocalized()

Returns

Signature

# modifyElementsQuery()

Arguments

Returns

Signature

# populateElementModel()

Arguments

Returns

Signature

# saveElement()

Arguments

Returns

Signature

# Protected Methods

# `defineCriteriaAttributes()`

# `defineSearchableAttributes()`

# `getEditorHtml()`

# `getName()`

# `getSources()`

# `hasContent()`

# `hasTitles()`

# `isLocalized()`

# `modifyElementsQuery()`

# `populateElementModel()`

# `saveElement()`