Multipage Class Reference

Public Member Functions
	Multipage ($sqlRequest, $nombre_session_var_name= 'default_results_per_page', $DefaultResultsPerPage=50, $LinkPerPage=7, $AddToColspan=0, $always_show=true, $template_name=null, $round_elements_per_page=1, $external_results_to_merge_at_beginning=null, $no_pagination_displayed=false)
	Constructeur. More...
	Initialize ()
	Paramétrage et construction. More...
	setResultsNumberPerPage ()
	Multipage::setResultsNumberPerPage() More...
	CurrentPage ($page)
	Calcule les paramètres Limit de la requete SQL en fonction de la page en cours. More...
	Query ($return_objects=false)
	Exécute le SQL avec LIMIT pour retourner les résultats, et calcule juste après car on a besoin que FOUND_ROWS soit exécuté immédiatement après. More...
	Calcul ($query_without_error=true)
	Calcule la position - sur la barre de liens - du lien correspondant à la page en cours. More...
	getPageURL ($page, $nombre=null)
	Multipage::getPageURL() More...
	ParseTemplate ($show_page_if_only_one=false)
	Cherche et remplace dans le template les variables connues en lançant les traitements associés. More...
	pMultipage ()
	Affiche directement en sortie le contenu du template après traitement. More...
	GetMultipage ()
	Renvoie le résultat du template une fois parsé More...
	getHeaderRow ()
	Multipage::getHeaderRow() More...
	getOrderBy ()
	Multipage::getOrderBy() More...

Data Fields
	$DefaultResultsPerPage
	$ResultPerPage
	$sqlRequest
	$sql_count = null
	$LinkPerPage
	$AddToColspan
	$always_show
	$tpl_data
	$tpl_name
	$page
	$pages_count
	$nbRecord = null
	$external_results_to_merge_at_beginning = null
	$HeaderTitlesArray
	$OrderDefault
	$SortDefault
	$forced_order_by_string = null
	$forced_second_order_by_string = null
	$forced_before_first_order_by_string = null
	$nombre_session_var_name
	$nb1
	$nb2
	$nb3
	$LimitSQL
	$first_link_page = true
	$allow_get_sort = true
	$sort_get_variable = 'sort'
	$order_get_variable = 'order'
	$order_sql_prefix = null
	$no_pagination_displayed = false

Detailed Description

Definition at line 46 of file Multipage.php.

Member Function Documentation

Calcul

(

$query_without_error = true

)

Calcule la position - sur la barre de liens - du lien correspondant à la page en cours.

Returns

Definition at line 242 of file Multipage.php.

CurrentPage

(

$page

)

Calcule les paramètres Limit de la requete SQL en fonction de la page en cours.

Parameters

mixed

$page

Returns

Definition at line 182 of file Multipage.php.

getHeaderRow

(

)

Multipage::getHeaderRow()

Returns

Definition at line 385 of file Multipage.php.

GetMultipage

(

)

Renvoie le résultat du template une fois parsé

Returns

Definition at line 375 of file Multipage.php.

getOrderBy

(

)

Multipage::getOrderBy()

Returns

Definition at line 446 of file Multipage.php.

getPageURL	(		$page,
			$nombre = null
	)

Multipage::getPageURL()

Parameters

mixed

$page

Returns

Definition at line 287 of file Multipage.php.

Initialize

(

)

Paramétrage et construction.

Returns

Definition at line 122 of file Multipage.php.

Multipage	(		$sqlRequest,
			$nombre_session_var_name = 'default_results_per_page',
			$DefaultResultsPerPage = 50,
			$LinkPerPage = 7,
			$AddToColspan = 0,
			$always_show = true,
			$template_name = null,
			$round_elements_per_page = 1,
			$external_results_to_merge_at_beginning = null,
			$no_pagination_displayed = false
	)

Constructeur.

Definition at line 82 of file Multipage.php.

ParseTemplate

(

$show_page_if_only_one = false

)

Cherche et remplace dans le template les variables connues en lançant les traitements associés.

Returns

Definition at line 310 of file Multipage.php.

pMultipage

(

)

Affiche directement en sortie le contenu du template après traitement.

Returns

Definition at line 365 of file Multipage.php.

Query

(

$return_objects = false

)

Exécute le SQL avec LIMIT pour retourner les résultats, et calcule juste après car on a besoin que FOUND_ROWS soit exécuté immédiatement après.

Parameters

mixed

$return_objects

Returns

Definition at line 200 of file Multipage.php.

setResultsNumberPerPage

(

)

Multipage::setResultsNumberPerPage()

Returns

Definition at line 149 of file Multipage.php.

Field Documentation

$AddToColspan

Definition at line 52 of file Multipage.php.

$allow_get_sort = true

Definition at line 73 of file Multipage.php.

$always_show

Definition at line 53 of file Multipage.php.

$DefaultResultsPerPage

Definition at line 47 of file Multipage.php.

$external_results_to_merge_at_beginning = null

Definition at line 59 of file Multipage.php.

$first_link_page = true

Definition at line 72 of file Multipage.php.

$forced_before_first_order_by_string = null

Definition at line 66 of file Multipage.php.

$forced_order_by_string = null

Definition at line 64 of file Multipage.php.

$forced_second_order_by_string = null

Definition at line 65 of file Multipage.php.

$HeaderTitlesArray

Definition at line 61 of file Multipage.php.

$LimitSQL

Definition at line 71 of file Multipage.php.

$LinkPerPage

Definition at line 51 of file Multipage.php.

$nb1

Definition at line 68 of file Multipage.php.

$nb2

Definition at line 69 of file Multipage.php.

$nb3

Definition at line 70 of file Multipage.php.

$nbRecord = null

Definition at line 58 of file Multipage.php.

$no_pagination_displayed = false

Definition at line 77 of file Multipage.php.

$nombre_session_var_name

Definition at line 67 of file Multipage.php.

$order_get_variable = 'order'

Definition at line 75 of file Multipage.php.

$order_sql_prefix = null

Definition at line 76 of file Multipage.php.

$OrderDefault

Definition at line 62 of file Multipage.php.

$page

Definition at line 56 of file Multipage.php.

$pages_count

Definition at line 57 of file Multipage.php.

$ResultPerPage

Definition at line 48 of file Multipage.php.

$sort_get_variable = 'sort'

Definition at line 74 of file Multipage.php.

$SortDefault

Definition at line 63 of file Multipage.php.

$sql_count = null

Definition at line 50 of file Multipage.php.

$sqlRequest

Definition at line 49 of file Multipage.php.

$tpl_data

Definition at line 54 of file Multipage.php.

$tpl_name

Definition at line 55 of file Multipage.php.

---

The documentation for this class was generated from the following file:

• lib/class/Multipage.php