Content
- Type
- Class
- Namespace
- craft\services
- Inherits
- craft\services\Content » yii\base\Component (opens new window) » yii\base\BaseObject (opens new window)
- Implements
- yii\base\Configurable (opens new window)
- Since
- 3.0.0
Content service.
An instance of the service is available via Craft::$app->content.
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| behaviors (opens new window) | yii\base\Behavior (opens new window) – List of behaviors attached to this component. |
| contentTable | string (opens new window) |
| db | craft\db\Connection, array (opens new window), string (opens new window) – The database connection to use |
| fieldColumnPrefix | string (opens new window) |
| fieldContext | string (opens new window) |
# contentTable
- Type
- string (opens new window)
- Default value
\craft\db\Table::CONTENT
View source (opens new window)
# db
- Type
- craft\db\Connection, array (opens new window), string (opens new window)
- Default value
'db'- Since
- 3.5.6
The database connection to use
View source (opens new window)
# fieldColumnPrefix
- Type
- string (opens new window)
- Default value
'field_'
View source (opens new window)
# fieldContext
- Type
- string (opens new window)
- Default value
'global'
View source (opens new window)
# Public Methods
| Method | Description |
|---|---|
| __call() (opens new window) | Calls the named method which is not a class method. |
| __clone() (opens new window) | This method is called after the object is created by cloning an existing one. |
| __construct() (opens new window) | Constructor. |
| __get() (opens new window) | Returns the value of a component property. |
| __isset() (opens new window) | Checks if a property is set, i.e. defined and not null. |
| __set() (opens new window) | Sets the value of a component property. |
| __unset() (opens new window) | Sets a component property to be null. |
| attachBehavior() (opens new window) | Attaches a behavior to this component. |
| attachBehaviors() (opens new window) | Attaches a list of behaviors to the component. |
| behaviors() (opens new window) | Returns a list of behaviors that this component should behave as. |
| canGetProperty() (opens new window) | Returns a value indicating whether a property can be read. |
| canSetProperty() (opens new window) | Returns a value indicating whether a property can be set. |
| className() (opens new window) | Returns the fully qualified name of this class. |
| detachBehavior() (opens new window) | Detaches a behavior from the component. |
| detachBehaviors() (opens new window) | Detaches all behaviors from the component. |
| ensureBehaviors() (opens new window) | Makes sure that the behaviors declared in behaviors() (opens new window) are attached to this component. |
| getBehavior() (opens new window) | Returns the named behavior object. |
| getBehaviors() (opens new window) | 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() (opens new window) | Returns a value indicating whether there is any handler attached to the named event. |
| hasMethod() (opens new window) | Returns a value indicating whether a method is defined. |
| hasProperty() (opens new window) | Returns a value indicating whether a property is defined for this component. |
| init() | Initializes the object. |
| off() (opens new window) | Detaches an existing event handler from this component. |
| on() (opens new window) | Attaches an event handler to an event. |
| populateElementContent() | Populates a given element with its custom field values. |
| saveContent() | Saves an element's content. |
| trigger() (opens new window) | Triggers an event. |
# getContentRow()
DEPRECATED
Deprecated in 3.7.0
Returns the content row for a given element, with field column prefixes removed from the keys.
View source (opens new window)
Arguments
$element(craft\base\ElementInterface) – The element whose content we're looking for.
Returns
array (opens new window), null (opens new window) – The element's content row values, or null if the row could not be found
# init()
Initializes the object.
This method is invoked at the end of the constructor after the object is initialized with the given configuration.
View source (opens new window)
# populateElementContent()
DEPRECATED
Deprecated in 3.7.0
Populates a given element with its custom field values.
View source (opens new window)
Arguments
$element(craft\base\ElementInterface) – The element for which we should create a new content model.
# saveContent()
Saves an element's content.
View source (opens new window)
Arguments
$element(craft\base\ElementInterface) – The element whose content we're saving.
Returns
boolean (opens new window) – 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 (opens new window)
if $element has not been saved yet
# Events
# EVENT_AFTER_SAVE_CONTENT
The event that is triggered after an element's content is saved.
# EVENT_BEFORE_SAVE_CONTENT
The event that is triggered before an element's content is saved.