Actions

Difference between revisions of "Plugin/Events/Content"

From Joomla! Documentation

< Plugin‎ | Events
(onContentBeforeSave: Updates)
(onContentAfterSave: Updates)
Line 82: Line 82:
 
===Description===
 
===Description===
 
This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.
 
This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.
 +
 
===Parameters===
 
===Parameters===
 
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module  (e.g. com_content.article).
 
*<code>context</code> The context of the content being passed to the plugin - this is the component name and view - or name of module  (e.g. com_content.article).
 
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
 
*<code>article</code> A reference to the JTableContent object that is being saved which holds the article data.
 
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
 
*<code>isNew</code> A boolean which is set to true if the content is about to be created.
 +
 
===Return Value===
 
===Return Value===
 
None. Result will be omitted.
 
None. Result will be omitted.
===Used in files===
 
*<tt>administrator/components/com_content/controller.php</tt>
 
*<tt>components/com_content/models/article.php</tt>
 
  
 
==onContentPrepareData==
 
==onContentPrepareData==

Revision as of 09:18, 27 August 2013

Quill icon.png
Content is Incomplete

This article or section is incomplete, which means it may be lacking information. You are welcome to assist in its completion by editing it as well. If this article or section has not been edited in several days, please consider helping complete the content.
This article was last edited by Wilsonge (talk| contribs) 7 months ago. (Purge)

Contents

Content events are triggered during the content creation process. This occur in many views many components and modules - it is not just for the com_content component.

onContentPrepare

Description

This is the first stage in preparing content for output and is the most common point for content orientated plugins to do their work. Since the article and related parameters are passed by reference, event handlers can modify them prior to display.

Parameters

$context, &$row, &$params, $page = 0

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • &article A reference to the article that is being rendered by the view (For example: the text of a com_content article can be found with $article->text).
  • &row A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
  • &params A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
  • page An integer that determines the "page" of the content that is to be generated. Note that in the context of views that might not generate HTML output, a page is a reasonably abstract concept that depends on the context.

Return Value

None. Results are returned by modifying the referenced arguments. Sometimes a boolean might be returned to check for success or failure of the event.

Example

onContentAfterTitle

Description

This is a request for information that should be placed between the content title and the content body. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.

Parameters

See the onPrepareContent event for additional discussion of these parameters.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • &article The article that is being rendered by the view.
  • &params An associative array of relevant parameters.
  • limitstart An integer that determines the "page" of the content that is to be generated.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

onContentBeforeDisplay

Description

This is a request for information that should be placed immediately before the generated content. For views that generate HTML, this might include the use of styles that are specified as part of the content or related parameters. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.

Parameters

See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • &article The article that is being rendered by the view.
  • &params An associative array of relevant parameters.
  • limitstart An integer that determines the "page" of the content that is to be generated.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

Example

onContentAfterDisplay

Description

This is a request for information that should be placed immediately after the generated content. For views that generate HTML, this might include the closure of styles that are specified as part of the content or related parameters. Although parameters are passed by reference, this is not the event to modify article data. Use onPrepareContent for that purpose.

Parameters

See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • &article The article that is being rendered by the view.
  • &params A JRegistry object of merged article and menu item params.
  • limitstart An integer that determines the "page" of the content that is to be generated.

Return Value

String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.

onContentBeforeSave

Description

This is an event that is called right before the content is saved into the database. Since the article object is passed by reference, you can make any changes you wish to the data. You can also abort the save by returning false. In the case of JModelLegacy for example the error will then be set by calling $this->setError($table->getError); to be displayed to user.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • article A reference to the JTableContent object that is being saved which holds the article data.
  • isNew A boolean which is set to true if the content is about to be created.

Return Value

Boolean. Result will affect the saving process. See description for details.

onContentAfterSave

Description

This is an event that is called after the content is saved into the database. Even though article object is passed by reference, changes will not be saved since storing data into database phase is past. An example use case would be redirecting user to the appropriate place after saving.

Parameters

  • context The context of the content being passed to the plugin - this is the component name and view - or name of module (e.g. com_content.article).
  • article A reference to the JTableContent object that is being saved which holds the article data.
  • isNew A boolean which is set to true if the content is about to be created.

Return Value

None. Result will be omitted.

onContentPrepareData

Description

Called after the data for a JForm has been retrieved. It can be used to modify the data for a JForm object in memory before rendering.

Parameters

  • context The context where this event was triggered (for example, 'com_users.profile'). Use this to check whether you are in the desired context for the plugin.
  • data An object containing the data for the form.

Return Value

  • boolean True if method succeeds.

Used in files

  • administrator/components/com_admin/models/profile.php
  • administrator/components/com_users/models/user.php
  • components/com_contact/models/contact.php
  • components/com_users/models/profile.php
  • plugins/user/profile/profile.php

onContentPrepareForm

Description

Called before a JForm is rendered. It can be used to modify the JForm object in memory before rendering. For example, use JForm->loadFile() to add fields or JForm->removeField() to remove fields. Or use JForm->setFieldAttribute() or other JForm methods to modify fields for the form.

Parameters

  • form The JForm object to be displayed. Use the $form->getName() method to check whether this is the form you want to work with.
  • data An object containing the data for the form.

Return Value

  • boolean True if method succeeds.

Used in files

  • components/com_contact/models/contact.php
  • libraries/joomla/application/component/modelform.php
  • components/com_users/models/login.php
  • plugins/user/profile/profile.php