Class craft\services\Content
- Inheritance
- craft\services\Content » yii\base\Component » yii\base\BaseObject
- Implements
- yii\base\Configurable
- Available since version
- 3.0
- Source Code
- https://github.com/craftcms/cms/blob/master/src/services/Content.php
Content service.
An instance of the Content service is globally accessible in Craft via Craft::$app->content.
| Property | Type | Description | Defined By |
|---|---|---|---|
$contentTable |
string | craft\services\Content | |
$fieldColumnPrefix |
string | craft\services\Content | |
$fieldContext |
string | craft\services\Content |
| Method | Description | Defined By |
|---|---|---|
__call() |
Calls the named method which is not a class method. | yii\base\BaseObject |
__clone() |
This method is called after the object is created by cloning an existing one. | yii\base\Component |
__construct() |
Constructor. | yii\base\BaseObject |
__get() |
Returns the value of an object property. | yii\base\BaseObject |
__isset() |
Checks if a property is set, i.e. defined and not null. | yii\base\BaseObject |
__set() |
Sets value of an object property. | yii\base\BaseObject |
__unset() |
Sets an object property to null. | yii\base\BaseObject |
attachBehavior() |
Attaches a behavior to this component. | yii\base\Component |
attachBehaviors() |
Attaches a list of behaviors to the component. | yii\base\Component |
behaviors() |
Returns a list of behaviors that this component should behave as. | yii\base\Component |
canGetProperty() |
Returns a value indicating whether a property can be read. | yii\base\BaseObject |
canSetProperty() |
Returns a value indicating whether a property can be set. | yii\base\BaseObject |
className() |
Returns the fully qualified name of this class. | yii\base\BaseObject |
detachBehavior() |
Detaches a behavior from the component. | yii\base\Component |
detachBehaviors() |
Detaches all behaviors from the component. | yii\base\Component |
ensureBehaviors() |
Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
getBehavior() |
Returns the named behavior object. | yii\base\Component |
getBehaviors() |
Returns all behaviors attached to this component. | yii\base\Component |
getContentRow() |
Returns the content row for a given element, with field column prefixes removed from the keys. | craft\services\Content |
hasEventHandlers() |
Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
hasMethod() |
Returns a value indicating whether a method is defined. | yii\base\BaseObject |
hasProperty() |
Returns a value indicating whether a property is defined. | yii\base\BaseObject |
init() |
Initializes the object. | yii\base\BaseObject |
off() |
Detaches an existing event handler from this component. | yii\base\Component |
on() |
Attaches an event handler to an event. | yii\base\Component |
populateElementContent() |
Populates a given element with its custom field values. | craft\services\Content |
saveContent() |
Saves an element's content. | craft\services\Content |
trigger() |
Triggers an event. | yii\base\Component |
| Event | Type | Description | Defined By |
|---|---|---|---|
EVENT_AFTER_SAVE_CONTENT |
craft\events\ElementContentEvent | The event that is triggered after an element's content is saved. | craft\services\Content |
EVENT_BEFORE_SAVE_CONTENT |
craft\events\ElementContentEvent | The event that is triggered before an element's content is saved. | craft\services\Content |
Property Details
$contentTable
public property
#
public string $contentTable = '{{%content}}'
$fieldColumnPrefix
public property
#
public string $fieldColumnPrefix = 'field_'
$fieldContext
public property
#
public string $fieldContext = 'global'Method Details
getContentRow()
public method
#
Returns the content row for a given element, with field column prefixes removed from the keys.
public array, null getContentRow ( craft\base\ElementInterface $element )$element |
craft\base\ElementInterface | The element whose content we're looking for. |
| return | array, null | The element's content row values, or null if the row could not be found |
|---|
populateElementContent()
public method
#
Populates a given element with its custom field values.
public void populateElementContent ( craft\base\ElementInterface $element )$element |
craft\base\ElementInterface | The element for which we should create a new content model. |
saveContent()
public method
#
Saves an element's content.
public boolean saveContent ( craft\base\ElementInterface $element )$element |
craft\base\ElementInterface | The element whose content we're saving. |
| return | 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 | yii\base\Exception | if $element has not been saved yet |
Event Details
EVENT_AFTER_SAVE_CONTENT
event of type craft\events\ElementContentEvent
#
The event that is triggered after an element's content is saved.
EVENT_BEFORE_SAVE_CONTENT
event of type craft\events\ElementContentEvent
#
The event that is triggered before an element's content is saved.