Documentation du code de SPIP et de ses plugins

SPIP

Decorator extends FilterIterator
in package

Table of Contents

Properties

$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 du compilateur
$limit  : mixed
$logger  : LoggerInterface
$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  : Iterator

Methods

__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()  : null|string
Assembler le tableau de filtres traduits depuis les conditions SQL les filtres vides ou null sont ignores.
composer_filtre()  : null|string
Calculer un filtre sur un champ du tableau.
traduire_condition_sql_en_filtre()  : null|array<string|int, mixed>|string
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

$info

Infos du 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

Methods

__construct()

public __construct(Iterator $iter, array<string|int, mixed> $command, array<string|int, mixed> $info) : mixed
Parameters
$iter : Iterator
$command : array<string|int, mixed>
$info : array<string|int, 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

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

seek()

aller a la position absolue n, comptee depuis le debut.

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

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(int $saut[, int|null $max = null ]) : int
Parameters
$saut : int
$max : int|null = 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(array<string|int, mixed> $filtres[, string $operateur = 'AND' ]) : null|string
Parameters
$filtres : array<string|int, mixed>
$operateur : string = 'AND'
Return values
null|string

composer_filtre()

Calculer un filtre sur un champ du tableau.

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

traduire_condition_sql_en_filtre()

Traduire un element du tableau where SQL en un filtre.

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

seek_loop()

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

        
On this page

Search results