EntriesService

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

EntriesService provides APIs for managing entries in Craft.

An instance of EntriesService is globally accessible in Craft via {@link WebApp::entries craft()->entries}.

See also http://craftcms.com

View source

Public Properties

PropertyDescription
$behaviorsarray – The behaviors that should be attached to this component.

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.
deleteEntry()Deletes an entry(s).
deleteEntryById()Deletes an entry(s) by its ID.
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.
getEntryById()Returns an entry by its ID.
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.
onBeforeDeleteEntry()Fires an 'onBeforeDeleteEntry' event.
onBeforeSaveEntry()Fires an 'onBeforeSaveEntry' event.
onDeleteEntry()Fires an 'onDeleteEntry' event.
onSaveEntry()Fires an 'onSaveEntry' event.
raiseEvent()Raises an event.
saveEntry()Saves a new or existing entry.

deleteEntry()

Deletes an entry(s).

View source

Arguments

Returns

boolean – Whether the entry deletion was successful.

Throws

Signature

public boolean deleteEntry ( $entries )

deleteEntryById()

Deletes an entry(s) by its ID.

View source

Arguments

  • $entryId (integer, array) – The ID of an entry to delete, or an array of entry IDs.

Returns

boolean – Whether the entry deletion was successful.

Signature

public boolean deleteEntryById ( $entryId )

getEntryById()

Returns an entry by its ID.

$entry = craft()->entries->getEntryById($entryId);

View source

Arguments

  • $entryId (integer) – The entry’s ID.
  • $localeId (string) – The locale to fetch the entry in. Defaults to {@link WebApp::language craft()->language}.

Returns

Craft\EntryModel, null – The entry with the given ID, or null if an entry could not be found.

Signature

public Craft\EntryModel, null getEntryById ( $entryId, $localeId = null )

onBeforeDeleteEntry()

Fires an 'onBeforeDeleteEntry' event.

View source

Arguments

Returns

null

Signature

public null onBeforeDeleteEntry ( Craft\Event $event )

onBeforeSaveEntry()

Fires an 'onBeforeSaveEntry' event.

View source

Arguments

Returns

null

Signature

public null onBeforeSaveEntry ( Craft\Event $event )

onDeleteEntry()

Fires an 'onDeleteEntry' event.

View source

Arguments

Returns

null

Signature

public null onDeleteEntry ( Craft\Event $event )

onSaveEntry()

Fires an 'onSaveEntry' event.

View source

Arguments

Returns

null

Signature

public null onSaveEntry ( Craft\Event $event )

saveEntry()

Saves a new or existing entry.

$entry = new EntryModel();
$entry->sectionId = 10;
$entry->typeId    = 1;
$entry->authorId  = 5;
$entry->enabled   = true;

$entry->getContent()->title = "Hello World!";

$entry->setContentFromPost(array(
    'body' => "<p>I can’t believe I literally just called this “Hello World!”.</p>",
));

$success = craft()->entries->saveEntry($entry);

if (!$success)
{
    Craft::log('Couldn’t save the entry "'.$entry->title.'"', LogLevel::Error);
}

View source

Arguments

Returns

boolean – Whether the entry was saved successfully.

Throws

Signature

public boolean saveEntry ( Craft\EntryModel $entry )