ContentService
- Type
- Class
- Namespace
- Craft
- Inherits
- Craft\ContentService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)
- Implements
IApplicationComponent- Since
- 1.0
Class ContentService
See also http://craftcms.com
View source (opens new window)
# Public Properties
| Property | Description |
|---|---|
| $behaviors (opens new window) | array (opens new window) – The behaviors that should be attached to this component. |
| $contentTable | string (opens new window) |
| $fieldColumnPrefix | string (opens new window) |
| $fieldContext | string (opens new window) |
# $contentTable
Signature
public string $contentTable = 'content'
# $fieldColumnPrefix
Signature
public string $fieldColumnPrefix = 'field_'
# $fieldContext
Signature
public string $fieldContext = 'global'
# 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. |
| createContent() | Instantiates a new content model for a given element. |
| 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. |
| getContent() | Returns the content model for a given element. |
| getEventHandlers() (opens new window) | Returns the list of attached event handlers for an event. |
| getIsInitialized() (opens new window) | Checks if this application component has been initialized. |
| 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. |
| init() (opens new window) | Initializes the application component. |
| isInitialized() | Checks if this application component has been initialized yet, or not. |
| onSaveContent() | Fires an 'onSaveContent' event. |
| raiseEvent() (opens new window) | Raises an event. |
| saveContent() | Saves an element's content. |
| validateContent() | Validates some content with a given field layout. |
# createContent()
Instantiates a new content model for a given element.
View source (opens new window)
Arguments
$element(Craft\BaseElementModel) – The element for which we should create a new content model.
Returns
Craft\ContentModel – The new content model.
Signature
public Craft\ContentModel createContent ( Craft\BaseElementModel $element )
# getContent()
Returns the content model for a given element.
View source (opens new window)
Arguments
$element(Craft\BaseElementModel) – The element whose content we're looking for.
Returns
Craft\ContentModel, null (opens new window) – The element's content or null if no content has been saved for the element.
Signature
public Craft\ContentModel, null getContent ( Craft\BaseElementModel $element )
# onSaveContent()
Fires an 'onSaveContent' event.
View source (opens new window)
Arguments
$event(Craft\Event)
Returns
Signature
public null onSaveContent ( Craft\Event $event )
# saveContent()
Saves an element's content.
View source (opens new window)
Arguments
$element(Craft\BaseElementModel) – The element whose content we're saving.$validate(boolean (opens new window)) – Whether the element's content should be validated first.$updateOtherLocales(boolean (opens new window)) – Whether any non-translatable fields' values should be copied to the element's other locales.
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
Signature
public boolean saveContent ( Craft\BaseElementModel $element, $validate = true, $updateOtherLocales = true )
# validateContent()
Validates some content with a given field layout.
View source (opens new window)
Arguments
$element(Craft\BaseElementModel) – The element whose content should be validated.
Returns
boolean (opens new window) – Whether the element's content validates.
Signature
public boolean validateContent ( Craft\BaseElementModel $element )