SPIP Code

Documentation du code de SPIP et de ses plugins

Albums

autocomplete_albums_fonctions.php

Fonctions utiles au squelette «autocomplete_albums»

Tags
plugin

Albums

copyright

2014

author

Tetue, Charles Razack

licence

GNU/GPL

Table of Contents

filtre_albums_autocomplete()  : array<string|int, mixed>
Retourne une liste d'objets, correspondants éventuellement à un terme de recherche.

Functions

filtre_albums_autocomplete()

Retourne une liste d'objets, correspondants éventuellement à un terme de recherche.

filtre_albums_autocomplete([string $type = '' ][, string $type2 = '' ][, bool $pivot2 = false ][, string $terme = '' ][, string $champ = '' ][, int|string $nb = '' ]) : array<string|int, mixed>

On peut restreindre la sélection en fonction des liaisons avec un autre type d'objet. Si un terme est donné, on cherche les occurences dans 2 champs :

  • le champ servant de clé primaire id_xxx.
  • le champ contenant le titre tel que défini dans la déclaration de la table, ou un champ spécifique donné en argument.
Parameters
$type : string = ''

Type d'objet recherché

$type2 : string = ''

Type d'objet lié

$pivot2 : bool = false

true pour définir l'objet secondaire comme pivot. Le pivot est l'objet qui porte la table de liens dont on se sert pour récupérer les liaisons. Par défaut on cherche dans la table de liens de l'objet principal.

$terme : string = ''

Terme de recherche (optionnel)

$champ : string = ''

Champ spécial dans lequel le terme doit être recherché. Par défaut, on cherche dans le champ correspondant au titre de l'objet, tel que précisé dans la déclaration de la table sql.

$nb : int|string = ''

Nombre maximal de résultats, 20 par défaut.

Tags
example
  • Albums avec toto dans le titre : ...autocomplete('album','','','toto')
  • Articles avec toto dans le titre et ayant des albums liés : ...autocomplete('article','album',true,'toto')
  • Auteurs ayant toto dans leur email et liés à des albums : ...autocomplete('auteur','album','','toto','email')
  • Mot-clés liés à des albums : ...autocomplete('mot','album')
Return values
array<string|int, mixed> —

tableau contenant une sélection des objets avec leur identifiant et leur titre.

Search results