ContentService

Type
Class
Namespace
Craft
Inherits
Craft\ContentService » Craft\BaseApplicationComponent » CApplicationComponent » CComponent
Implements
IApplicationComponent
Since
1.0

Class ContentService

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be 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.
__get()Returns a property value, an event handler list or a behavior based on its name.
__isset()Checks if a property value is null.
__set()Sets value of a component property.
__unset()Sets a component property to be null.
asa()Returns the named behavior object.
attachBehavior()Attaches a behavior to this component.
attachBehaviors()Attaches a list of behaviors to the component.
attachEventHandler()Attaches an event handler to an event.
canGetProperty()Determines whether a property can be read.
canSetProperty()Determines whether a property can be set.
createContent()Instantiates a new content model for a given element.
detachBehavior()Detaches a behavior from the component.
detachBehaviors()Detaches all behaviors from the component.
detachEventHandler()Detaches an existing event handler.
disableBehavior()Disables an attached behavior.
disableBehaviors()Disables all behaviors attached to this component.
enableBehavior()Enables an attached behavior.
enableBehaviors()Enables all behaviors attached to this component.
evaluateExpression()Evaluates a PHP expression or callback under the context of this component.
getContent()Returns the content model for a given element.
getEventHandlers()Returns the list of attached event handlers for an event.
getIsInitialized()Checks if this application component has been initialized.
hasEvent()Determines whether an event is defined.
hasEventHandler()Checks whether the named event has attached handlers.
hasProperty()Determines whether a property is defined.
init()Initializes the application component.
isInitialized()Checks if this application component has been initialized yet, or not.
onSaveContent()Fires an 'onSaveContent' event.
raiseEvent()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

Arguments

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

Arguments

Returns

Craft\ContentModel, null – 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

Arguments

Returns

null

Signature

public null onSaveContent ( Craft\Event $event )

saveContent()

Saves an element's content.

View source

Arguments

  • $element (Craft\BaseElementModel) – The element whose content we're saving.
  • $validate (boolean) – Whether the element's content should be validated first.
  • $updateOtherLocales (boolean) – Whether any non-translatable fields' values should be copied to the element's other locales.

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\BaseElementModel $element, $validate = true, $updateOtherLocales = true )

validateContent()

Validates some content with a given field layout.

View source

Arguments

Returns

boolean – Whether the element's content validates.

Signature

public boolean validateContent ( Craft\BaseElementModel $element )