Référence de la classe PlgContentPagebreak

Graphe d'héritage de PlgContentPagebreak:

Fonctions membres publiques
	onContentPrepare ($context, &$row, &$params, $page=0)

Fonctions membres protégées
	_createToc (&$row, &$matches, &$page)
	_createNavigation (&$row, $page, $n)

Attributs protégés
	$list = array()

Description détaillée

Page break plugin

Usage:

---

---

or

---

or

---

or

---

Depuis

1.6

Documentation des fonctions membres

_createNavigation()

_createNavigation ( &  $row,   $page,   $n  )

protected

Creates the navigation for the item

Paramètres

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

Renvoie

void

Depuis

1.6

Références $n, $path, $row, et ContentHelperRoute\getArticleRoute().

_createToc()

_createToc ( &  $row, &  $matches, &  $page  )

protected

Creates a Table of Contents for the pagebreak

Paramètres

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

Renvoie

void

Depuis

1.6

Références $i, $input, $list, $path, $row, $title, elseif, ENT_QUOTES, ContentHelperRoute\getArticleRoute(), et htmlspecialchars.

onContentPrepare()

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

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

Paramètres

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

Renvoie

mixed Always returns void or true

Depuis

1.6

Références $context, $input, $key, $n, $params, $row, $style, $text, $title, $view, et elseif.

Documentation des champs

$list

$list = array()

protected

---

La documentation de cette classe a été générée à partir du fichier suivant :

• plugins/content/pagebreak/pagebreak.php