\PlgContentPagebreak

Page break plugin

<b>Usage:</b>
<code><hr class="system-pagebreak" /></code>
<code><hr class="system-pagebreak" title="The page title" /></code>
or
<code><hr class="system-pagebreak" alt="The first page" /></code>
or
<code><hr class="system-pagebreak" title="The page title" alt="The first page" /></code>
or
<code><hr class="system-pagebreak" alt="The first page" title="The page title" /></code>

Synopsis

class PlgContentPagebreak extends JPlugin {

• // members
• protected  $autoloadLanguage;
• // Inherited members from JPlugin
• public JRegistry  $params;
• protected  $_name;
• protected  $_type;
• protected  $autoloadLanguage;
• // Inherited members from JEvent
• protected   $_subject;
• // Inherited members from JObject
• protected  $_errors;
• // methods
• public mixed onContentPrepare()
• protected void _createTOC()
• protected void _createNavigation()
• // Inherited methods from JPlugin
• public void __construct()
• public boolean loadLanguage()
• // Inherited methods from JEvent
• public void __construct()
• public mixed update()
• // Inherited methods from JObject
• public void __construct()
• public string __toString()
• public mixed def()
• public mixed get()
• public array getProperties()
• public string getError()
• public array getErrors()
• public mixed set()
• public boolean setProperties()
• public void setError()
}


Hierarchy

Extends

• JPlugin

Members

protected

• $_errors — array
  An array of error messages or Exception objects.
• $_name — string
  The name of the plugin
• $_subject —
  Event object to observe.
• $_type — string
  The plugin type
• $autoloadLanguage — boolean
  Load the language file on instantiation.
• $autoloadLanguage — boolean
  Affects constructor behavior. If true, language files will be loaded automatically.

public

• $params — JRegistry
  A JRegistry object holding the parameters for the plugin

Methods

protected

• _createNavigation() — Creates the navigation for the item
• _createTOC() — Creates a Table of Contents for the pagebreak

public

• onContentPrepare() — Plugin that adds a pagebreak into the text and truncates text at that point

Inherited from JPlugin

public

• loadLanguage() — Loads the plugin language file

Inherited from JEvent

public

• update() — Method to trigger events.

Inherited from JObject

public

• __toString() — Magic method to convert the object to a string gracefully.
• def() — Sets a default value if not alreay assigned
• get() — Returns a property of the object or the default value if the property is not set.
• getError() — Get the most recent error message.
• getErrors() — Return all errors, if any.
• getProperties() — Returns an associative array of object properties.
• set() — Modifies a property of the object, creating it if it does not already exist.
• setError() — Add an error message.
• setProperties() — Set the object properties based on a named array/hash.