EntriesService

Type

Class

Namespace

Craft

Inherits

Craft\EntriesService » Craft\BaseApplicationComponent » CApplicationComponent (opens new window) » CComponent (opens new window)

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 (opens new window)

Public Properties

Property	Description
$behaviors (opens new window)	array (opens new window) – The behaviors that should be attached to this component.

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

deleteEntry()

Deletes an entry(s).

View source (opens new window)

Arguments

• $entries (Craft\EntryModel, Craft\EntryModel[]) – An entry, or an array of entries, to be deleted.

Returns

boolean (opens new window) – Whether the entry deletion was successful.

Throws

• Exception (opens new window)

Signature

public boolean deleteEntry ( $entries )

deleteEntryById()

Deletes an entry(s) by its ID.

View source (opens new window)

Arguments

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

Returns

boolean (opens new window) – 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 (opens new window)

Arguments

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

Returns

Craft\EntryModel, null (opens new window) – 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 (opens new window)

Arguments

• $event (Craft\Event)

Returns

null (opens new window)

Signature

public null onBeforeDeleteEntry ( Craft\Event $event )

onBeforeSaveEntry()

Fires an 'onBeforeSaveEntry' event.

View source (opens new window)

Arguments

• $event (Craft\Event)

Returns

null (opens new window)

Signature

public null onBeforeSaveEntry ( Craft\Event $event )

onDeleteEntry()

Fires an 'onDeleteEntry' event.

View source (opens new window)

Arguments

• $event (Craft\Event)

Returns

null (opens new window)

Signature

public null onDeleteEntry ( Craft\Event $event )

onSaveEntry()

Fires an 'onSaveEntry' event.

View source (opens new window)

Arguments

• $event (Craft\Event)

Returns

null (opens new window)

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 (opens new window)

Arguments

• $entry (Craft\EntryModel) – The entry to be saved.

Returns

boolean (opens new window) – Whether the entry was saved successfully.

Throws

• Exception (opens new window)

Signature

public boolean saveEntry ( Craft\EntryModel $entry )