Content

Type
Class
Namespace
craft\services
Inherits
craft\services\Content » yii\base\Component » yii\base\BaseObject
Implements
yii\base\Configurable
Since
3.0

Content service.

An instance of the Content service is globally accessible in Craft via Craft::$app->content.

View source

Public Properties

PropertyDescription
$behaviorsyii\base\Behavior – List of behaviors attached to this component
$contentTablestring
$fieldColumnPrefixstring
$fieldContextstring

$contentTable

Signature

public string $contentTable = '{{%content}}'

$fieldColumnPrefix

Signature

public string $fieldColumnPrefix = 'field_'

$fieldContext

Signature

public string $fieldContext = 'global'

Public Methods

MethodDescription
__call()Calls the named method which is not a class method.
__clone()This method is called after the object is created by cloning an existing one.
__construct()Constructor.
__get()Returns the value of an object property.
__isset()Checks if a property is set, i.e. defined and not null.
__set()Sets value of an object property.
__unset()Sets an object property to null.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
behaviors()Returns a list of behaviors that this component should behave as.
canGetProperty()Returns a value indicating whether a property can be read.
canSetProperty()Returns a value indicating whether a property can be set.
className()Returns the fully qualified name of this class.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
ensureBehaviors()Makes sure that the behaviors declared in behaviors() are attached to this component.
getBehavior()Returns the named behavior object.
getBehaviors()Returns all behaviors attached to this component.
getContentRow()Returns the content row for a given element, with field column prefixes removed from the keys.
hasEventHandlers()Returns a value indicating whether there is any handler attached to the named event.
hasMethod()Returns a value indicating whether a method is defined.
hasProperty()Returns a value indicating whether a property is defined.
init()Initializes the object.
off()Detaches an existing event handler from this component.
on()Attaches an event handler to an event.
populateElementContent()Populates a given element with its custom field values.
saveContent()Saves an element's content.
trigger()Triggers an event.

getContentRow()

Returns the content row for a given element, with field column prefixes removed from the keys.

View source

Arguments

Returns

array, null – The element's content row values, or null if the row could not be found

Signature

public array, null getContentRow ( craft\base\ElementInterface $element )

populateElementContent()

Populates a given element with its custom field values.

View source

Arguments

Signature

public void populateElementContent ( craft\base\ElementInterface $element )

saveContent()

Saves an element's content.

View source

Arguments

Returns

boolean – Whether the content was saved successfully. If it wasn't, any validation errors will be saved on the element and its content model.

Throws

Signature

public boolean saveContent ( craft\base\ElementInterface $element )

Events

EVENT_AFTER_SAVE_CONTENT

Type
craft\events\ElementContentEvent

The event that is triggered after an element's content is saved.

EVENT_BEFORE_SAVE_CONTENT

Type
craft\events\ElementContentEvent

The event that is triggered before an element's content is saved.