View source

{{incomplete}}
[[Category:Development]]
[[Category:Plugins]]
=5.5 Content Events for Plugin System=
==5.5.1 Overview==
Content events are triggered during the content creation process. This may occur 
in views in the com_content component, or in other components or modules. 

==5.5.2 onPrepareContent==
===5.5.2.1 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.
===5.5.2.2 Parameters===
*<code>article</code> A reference to the article that is being rendered by the view.
*<code>params<code> A reference to an associative array of relevant parameters. The view determines what it considers to be relevant and passes that information along.
*<code>limitstart</code> 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.
===5.5.2.3 Return Value===
None. Results are returned by modifying the referenced arguments.
===5.5.2.4 Used in files===
  *components/com_content/views/article/view.html.php
  *components/com_content/views/article/view.pdf.php
  *components/com_content/views/category/view.html.php
  *components/com_content/views/frontpage/view.html.php
  *components/com_content/views/section/view.html.php
  *plugins/content/code.php
  *plugins/content/emailcloak.php
  *plugins/content/geshi.php
  *plugins/content/image.php
  *plugins/content/loadmodule.php
  *plugins/content/pagebreak.php
  *plugins/content/sef.php

==5.5.3 onAfterDisplayTitle==
===5.5.3.1 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.
===5.5.3.2 Parameters===
See the onPrepareContent event for additional discussion of these parameters.
  *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.
===5.5.3.3 Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===5.5.3.2 Used in files===
  *components/com_content/views/article/view.html.php
  *components/com_content/views/category/view.html.php
  *components/com_content/views/frontpage/view.html.php
  *components/com_content/views/section/view.html.php
  *modules/mod_newsflash/helper.php
===5.5.3.5 See Also===
  *components/com_content/views/article/tmpl/default.php

==5.5.4 onBeforeDisplayContent==
===5.5.4.1 Description===
This is a request for information that should be placed immediately before the generated content. For views that generate XHTML/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.
===5.5.4.2 Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that 
unlike onPrepareContent, these parameters are passed by value.
  *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.
===5.5.4.3 Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===5.5.4.4 Used in files===
  *components/com_content/views/article/view.html.php
  *components/com_content/views/category/view.html.php
  *components/com_content/views/frontpage/view.html.php
  *components/com_content/views/section/view.html.php
  *modules/mod_newsflash/helper.php
===5.5.4.5 See Also===
  *components/com_content/views/article/tmpl/default.php

==5.5.5 onAfterDisplayContent==
===5.5.5.1 Description===
This is a request for information that should be placed immediately after the generated content. For views that generate XHTML/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.
===5.5.5.2 Parameters===
See the onPrepareContent event for additional discussion of these parameters. Note that unlike onPrepareContent, these parameters are passed by value.
  *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.
===5.5.5.3 Return Value===
String. Returned value from this event will be displayed in a placeholder. Most templates display this placeholder after the article separator.
===5.5.5.4 Used in files===
  *components/com_content/views/article/view.html.php
  *components/com_content/views/category/view.html.php
  *components/com_content/views/frontpage/view.html.php
  *components/com_content/views/section/view.html.php
===5.5.5.5 See Also===
  *components/com_content/views/article/tmpl/default.php

==5.5.6 onBeforeContentSave==
===5.5.6.1 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 this case the error set by calling $article->setError($message); will be displayed to user.
===5.5.6.2 Parameters===
  *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.
===5.5.6.3 Return Value===
Boolean. Result will affect the saving process. See description for details.
===5.5.6.4 Used in files===
  *administrator/components/com_content/controller.php
  *components/com_content/models/article.php

==5.5.7 onAfterContentSave==
===5.5.7.1 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.
===5.5.7.2 Parameters===
  *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.
===5.5.7.3 Return Value===
None. Result will be omitted.
===5.5.7.4 Used in files===
  *administrator/components/com_content/controller.php
  *components/com_content/models/article.php