Documentation du code de SPIP et de ses plugins

SPIP

IterDecorator extends FilterIterator
in package

Table of Contents

$command  : array<string|int, mixed>
parametres de l'iterateur
$err  : bool
Y a t'il une erreur ?
$fetched  : int
nombre d'elements recuperes depuis la position 0, en tenant compte des filtres
$filtre  : array<string|int, mixed>
Conditions de filtrage ie criteres de selection
$func_filtre  : string
Fonction de filtrage compilee a partir des criteres de filtre
$info  : array<string|int, mixed>
infos de compilateur
$limit  : mixed
$max  : mixed
nombre maximal de recherche pour $total si l'iterateur n'implemente pas de fonction specifique
$offset  : int
Critere {offset, limit}
$pos  : int
position courante de l'iterateur
$select  : mixed
Liste des champs a inserer dans les $row retournes par ->fetch()
$total  : int
nombre total resultats dans l'iterateur
$type  : string
type de l'iterateur
$iter  : mixed
__construct()  : mixed
accept()  : bool
Accepte-t-on l'entree courante lue ? On execute les filtres pour le savoir.
cle()  : mixed
count()  : int
Compter le nombre total de resultats pour #TOTAL_BOUCLE
err()  : mixed
Drapeau a activer en cas d'echec (select SQL errone, non chargement des DATA, etc)
fetch()  : array<string|int, mixed>|bool
Renvoyer un tableau des donnees correspondantes a la position courante de l'iterateur en controlant si on respecte le filtre Appliquer aussi le critere {offset,limit}
free()  : bool
liberer la ressource
get_select()  : mixed
next()  : void
rewind()  : void
revient au depart
seek()  : bool
aller a la position absolue n, comptee depuis le debut
skip()  : int
Avancer de $saut pas
valeur()  : mixed
assembler_filtres()  : string|null
Assembler le tableau de filtres traduits depuis les conditions SQL les filtres vides ou null sont ignores
composer_filtre()  : string|null
Calculer un filtre sur un champ du tableau
traduire_condition_sql_en_filtre()  : string|array<string|int, mixed>|null
Traduire un element du tableau where SQL en un filtre
calculer_filtres()  : mixed
calculer_select()  : mixed
seek_loop()  : mixed

Properties

$command

parametres de l'iterateur

protected array<string|int, mixed> $command

$fetched

nombre d'elements recuperes depuis la position 0, en tenant compte des filtres

protected int $fetched = 0

$filtre

Conditions de filtrage ie criteres de selection

protected array<string|int, mixed> $filtre = []

$func_filtre

Fonction de filtrage compilee a partir des criteres de filtre

protected string $func_filtre = \null

$info

infos de compilateur

protected array<string|int, mixed> $info

$max

nombre maximal de recherche pour $total si l'iterateur n'implemente pas de fonction specifique

protected mixed $max = 100000

$select

Liste des champs a inserer dans les $row retournes par ->fetch()

protected mixed $select = []

$total

nombre total resultats dans l'iterateur

protected int $total = \null

Methods

__construct()

public __construct(Iterator $iter, mixed $command, mixed $info) : mixed
Parameters
$iter : Iterator
$command : mixed
$info : mixed
Return values
mixed

accept()

Accepte-t-on l'entree courante lue ? On execute les filtres pour le savoir.

public accept() : bool
Return values
bool

count()

Compter le nombre total de resultats pour #TOTAL_BOUCLE

public count() : int
Return values
int

err()

Drapeau a activer en cas d'echec (select SQL errone, non chargement des DATA, etc)

public err() : mixed
Return values
mixed

fetch()

Renvoyer un tableau des donnees correspondantes a la position courante de l'iterateur en controlant si on respecte le filtre Appliquer aussi le critere {offset,limit}

public fetch() : array<string|int, mixed>|bool
Return values
array<string|int, mixed>|bool

free()

liberer la ressource

public free() : bool
Return values
bool

get_select()

public get_select(mixed $nom) : mixed
Parameters
$nom : mixed
Return values
mixed

rewind()

revient au depart

public rewind() : void
Return values
void

seek()

aller a la position absolue n, comptee depuis le debut

public seek(int $n[, string $continue = null ]) : bool
Parameters
$n : int

absolute pos

$continue : string = null

param for sql_ api

Return values
bool

success or fail if not implemented

skip()

Avancer de $saut pas

public skip( $saut[,  $max = null ]) : int
Parameters
$saut :
$max : = null
Return values
int

assembler_filtres()

Assembler le tableau de filtres traduits depuis les conditions SQL les filtres vides ou null sont ignores

protected assembler_filtres( $filtres[, string $operateur = 'AND' ]) : string|null
Parameters
$filtres :
$operateur : string = 'AND'
Return values
string|null

composer_filtre()

Calculer un filtre sur un champ du tableau

protected composer_filtre( $cle,  $op,  $valeur[, false $not = false ]) : string|null
Parameters
$cle :
$op :
$valeur :
$not : false = false
Return values
string|null

traduire_condition_sql_en_filtre()

Traduire un element du tableau where SQL en un filtre

protected traduire_condition_sql_en_filtre( $v) : string|array<string|int, mixed>|null
Parameters
$v :
Return values
string|array<string|int, mixed>|null

calculer_filtres()

private calculer_filtres() : mixed
Return values
mixed

calculer_select()

private calculer_select() : mixed
Return values
mixed

seek_loop()

private seek_loop(mixed $n) : mixed
Parameters
$n : mixed
Return values
mixed

Search results