PHPXRef 0.7.1 : Joomla 4.2.2 documentation : Detail view of pagebreak.php

(no description)

Copyright:	(C) 2006 Open Source Matters, Inc.
License:	GNU General Public License version 2 or later; see LICENSE.txt
File Size:	359 lines (12 kb)
Included or required:	0 times
Referenced:	0 times
Includes or requires:	0 files

Defines 1 class

PlgContentPagebreak:: (3 methods):
  onContentPrepare()
  _createToc()
  _createNavigation()

Class: PlgContentPagebreak - X-Ref

Page break plugin

<strong>Usage:</strong>
<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>

onContentPrepare($context, &$row, &$params, $page = 0) X-Ref

Plugin that adds a pagebreak into the text and truncates text at that point

param: string   $context  The context of the content being passed to the plugin.
param: object   &$row     The article object.  Note $article->text is also available
param: mixed    &$params  The article params
param: integer  $page     The 'page' number
return: void

_createToc(&$row, &$matches, &$page) X-Ref

Creates a Table of Contents for the pagebreak

param: object   &$row      The article object.  Note $article->text is also available
param: array    &$matches  Array of matches of a regex in onContentPrepare
param: integer  &$page     The 'page' number
return: void

_createNavigation(&$row, $page, $n) X-Ref

Creates the navigation for the item

param: object  &$row  The article object.  Note $article->text is also available
param: int     $page  The page number
param: int     $n     The total number of pages
return: void

PHP Cross Reference of Joomla 4.2.2 documentation

/plugins/content/pagebreak/ -> pagebreak.php (summary)

Defines 1 class