Class plgContentPagebreak

Description

Page break plugin

Usage:

  1. <hr class="system-pagebreak" />
  1. <hr class="system-pagebreak" title="The page title" />
or
  1. <hr class="system-pagebreak" alt="The first page" />
or
  1. <hr class="system-pagebreak" title="The page title" alt="The first page" />
or
  1. <hr class="system-pagebreak" alt="The first page" title="The page title" />

  • since: 1.6

Located in /plugins/content/pagebreak/pagebreak.php (line 32)

JObject
   |
   --JEvent
      |
      --JPlugin
         |
         --plgContentPagebreak
Method Summary
plgContentPagebreak __construct ( &$subject, array $config, object $subject)
void onContentPrepare (string $context, object The &$row, object The &$params, [int $page = 0])
void _createNavigation ( &$row,  $page,  $n)
void _createTOC ( &$row,  &$matches,  &$page)
Variables

Inherited Variables

Inherited from JPlugin

JPlugin::$params
JPlugin::$_name
JPlugin::$_type

Inherited from JEvent

JEvent::$_subject

Inherited from JObject

JObject::$_errors
Methods
Constructor __construct (line 42)

Constructor

  • since: 1.5
  • access: public
plgContentPagebreak __construct ( &$subject, array $config, object $subject)
  • object $subject: The object to observe
  • array $config: An array that holds the plugin configuration
  • &$subject

Redefinition of:
JPlugin::__construct()
Constructor
onContentPrepare (line 57)
  • since: 1.6
  • access: public
void onContentPrepare (string $context, object The &$row, object The &$params, [int $page = 0])
  • string $context: The context of the content being passed to the plugin.
  • object The &$row: article object. Note $article->text is also available
  • object The &$params: article params
  • int $page: The 'page' number
_createNavigation (line 297)
  • since: 1.6
  • access: protected
void _createNavigation ( &$row,  $page,  $n)
  • &$row
  • $page
  • $n
_createTOC (line 214)
  • access: protected
void _createTOC ( &$row,  &$matches,  &$page)
  • &$row
  • &$matches
  • &$page

Inherited Methods

Inherited From JPlugin

JPlugin::__construct()
JPlugin::loadLanguage()

Inherited From JEvent

JEvent::__construct()
JEvent::update()

Inherited From JObject

JObject::__construct()
JObject::def()
JObject::get()
JObject::getError()
JObject::getErrors()
JObject::getProperties()
JObject::set()
JObject::setError()
JObject::setProperties()
JObject::toString()
JObject::__toString()

Documentation generated on Mon, 25 Jun 2012 13:58:31 -0500 by phpDocumentor 1.4.4