Documentation du code de SPIP et de ses plugins

SPIP

quete.php

SPIP, Système de publication pour l'internet

Copyright © avec tendresse depuis 2001 Arnaud Martin, Antoine Pitrou, Philippe Rivière, Emmanuel Saint-James

Ce programme est un logiciel libre distribué sous licence GNU/GPL.

Table of Contents

Functions

quete_virtuel()  : array<string|int, mixed>|bool|null
Retourne l'URL de redirection d'un article virtuel, seulement si il est publié
quete_parent_lang()  : array<string|int, mixed>
Retourne le couple `parent,lang` pour toute table
quete_parent()  : int
Retourne le parent d'une rubrique
quete_rubrique()  : int
Retourne la rubrique d'un article
quete_profondeur()  : int
Retourne la profondeur d'une rubrique
quete_condition_postdates()  : string
Retourne la condition sur la date lorsqu'il y a des post-dates
quete_condition_statut()  : array<string|int, mixed>|string
Calculer la condition pour filtrer les status,
quete_meta()  : array<string|int, mixed>|bool|null
Récuperer une meta sur un site (spip) distant (en local il y a plus simple)
calcul_exposer()  : bool|string
Calcul pour savoir si un objet est expose dans le contexte fournit par $reference
quete_debut_pagination()  : int
Trouver le numero de page d'une pagination indirecte lorsque debut_xxx=@123 on cherche la page qui contient l'item dont la cle primaire vaut 123
is_whereable()  : bool
Retourne true si ce where doit être appliqué, dans le cas des critères avec ? tel que `{id_article ?}`

Functions

quete_virtuel()

Retourne l'URL de redirection d'un article virtuel, seulement si il est publié

quete_virtuel(int $id_article, string $connect) : array<string|int, mixed>|bool|null
Parameters
$id_article : int
$connect : string
Return values
array<string|int, mixed>|bool|null

quete_parent_lang()

Retourne le couple `parent,lang` pour toute table

quete_parent_lang(string $table, int $id[, string $connect = '' ]) : array<string|int, mixed>

En pratique id_rubrique si présent (ou id_parent pour table rubriques) et champ lang si présent

Parameters
$table : string
$id : int
$connect : string = ''
Return values
array<string|int, mixed>

quete_parent()

Retourne le parent d'une rubrique

quete_parent(int $id_rubrique[, string $connect = '' ]) : int

Repose sur la fonction quete_parent_lang pour la mutualisation +mise en cache SQL des requêtes

Parameters
$id_rubrique : int
$connect : string = ''
Tags
uses
quete_parent_lang()
used-by
quete_profondeur()
Return values
int

quete_rubrique()

Retourne la rubrique d'un article

quete_rubrique(int $id_article, string $serveur) : int

Repose sur la fonction quete_parent_lang pour la mutualisation +mise en cache SQL des requêtes

Parameters
$id_article : int
$serveur : string
Tags
uses
quete_parent_lang()
Return values
int

quete_profondeur()

Retourne la profondeur d'une rubrique

quete_profondeur(int $id[, string $connect = '' ]) : int
Parameters
$id : int
$connect : string = ''
Tags
uses
quete_parent()
Return values
int

quete_condition_postdates()

Retourne la condition sur la date lorsqu'il y a des post-dates

quete_condition_postdates(string $champ_date[, string $serveur = '' ][, bool $ignore_previsu = false ]) : string
Parameters
$champ_date : string

Nom de la colonne de date dans la table SQL

$serveur : string = ''
$ignore_previsu : bool = false

true pour forcer le test même en prévisu

Return values
string

Morceau de la requête SQL testant la date

quete_condition_statut()

Calculer la condition pour filtrer les status,

quete_condition_statut(string $mstatut, string $previsu, string $publie[, string $serveur = '' ][, bool $ignore_previsu = false ]) : array<string|int, mixed>|string
Parameters
$mstatut : string

Le champ de la table sur lequel porte la condition

$previsu : string

Mode previsu : statut ou liste des statuts séparés par une virgule

$publie : string

Mode publie : statut ou liste des statuts séparés par une virgule

$serveur : string = ''

Serveur de BDD

$ignore_previsu : bool = false

true pour forcer le test même en prévisu

Return values
array<string|int, mixed>|string

quete_meta()

Récuperer une meta sur un site (spip) distant (en local il y a plus simple)

quete_meta(string $nom, string $serveur) : array<string|int, mixed>|bool|null
Parameters
$nom : string

Nom de la méta

$serveur : string

Connecteur

Return values
array<string|int, mixed>|bool|null

calcul_exposer()

Calcul pour savoir si un objet est expose dans le contexte fournit par $reference

calcul_exposer(int $id, string $prim, array<string|int, mixed> $reference, int $parent, string $type[, string $connect = '' ]) : bool|string
Parameters
$id : int
$prim : string
$reference : array<string|int, mixed>
$parent : int
$type : string
$connect : string = ''
Return values
bool|string

quete_debut_pagination()

Trouver le numero de page d'une pagination indirecte lorsque debut_xxx=@123 on cherche la page qui contient l'item dont la cle primaire vaut 123

quete_debut_pagination(string $primary, int|string $valeur, int $pas, object $iter) : int
Parameters
$primary : string
$valeur : int|string
$pas : int
$iter : object
Return values
int

is_whereable()

Retourne true si ce where doit être appliqué, dans le cas des critères avec ? tel que `{id_article ?}`

is_whereable(mixed $value) : bool
Parameters
$value : mixed
Return values
bool

        
On this page

Search results