SPIP Code

Documentation du code de SPIP et de ses plugins

Mots

editer_mot.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

action_editer_mot_dist()  : array<string|int, mixed>
Action d'édition d'un mot clé dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée
mot_inserer()  : int|bool
Insertion d'un mot dans un groupe
mot_modifier()  : string|null
Modifier un mot
mot_instituer()  : null|string
Instituer un mot clé : modifier son groupe parent
mot_supprimer()  : mixed
Supprimer un mot
mot_associer()  : int|bool
Associer un mot à des objets listés sous forme `array($objet=>$id_objets,...)`
mot_dissocier()  : int|bool
Dissocier un mot des objets listés sous forme `array($objet=>$id_objets,...)`
mot_qualifier()  : int|bool
Qualifier le lien d'un mot avec les objets listés `array($objet=>$id_objets,...)`
un_seul_mot_dans_groupe()  : bool
Teste si un groupe ne doit avoir qu'un seul mot clé associé

Functions

action_editer_mot_dist()

Action d'édition d'un mot clé dans la base de données dont l'identifiant est donné en paramètre de cette fonction ou en argument de l'action sécurisée

action_editer_mot_dist([null|int $arg = null ]) : array<string|int, mixed>

Si aucun identifiant n'est donné, on crée alors un nouveau mot clé.

Parameters
$arg : null|int = null

Identifiant du mot-clé. En absence utilise l'argument de l'action sécurisée.

Return values
array<string|int, mixed> —

Liste (identifiant du mot clé, Texte d'erreur éventuel)

mot_inserer()

Insertion d'un mot dans un groupe

mot_inserer(int $id_groupe[, array<string|int, mixed>|null $set = null ]) : int|bool
Parameters
$id_groupe : int

Identifiant du groupe de mot

$set : array<string|int, mixed>|null = null
Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
int|bool —

Identifiant du nouveau mot clé, false si erreur.

mot_modifier()

Modifier un mot

mot_modifier(int $id_mot[, array<string|int, mixed>|null $set = null ]) : string|null
Parameters
$id_mot : int

Identifiant du mot clé à modifier

$set : array<string|int, mixed>|null = null

Couples (colonne => valeur) de données à modifier. En leur absence, on cherche les données dans les champs éditables qui ont été postés (via _request())

Return values
string|null —
  • Chaîne vide si aucune erreur,
  • Null si aucun champ n'est à modifier,
  • Chaîne contenant un texte d'erreur sinon.

mot_instituer()

Instituer un mot clé : modifier son groupe parent

mot_instituer(int $id_mot, array<string|int, mixed> $c) : null|string
Parameters
$id_mot : int

Identifiant du mot clé

$c : array<string|int, mixed>

Couples (colonne => valeur) des données à instituer

Tags
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

Return values
null|string —

Null si aucun champ à modifier, chaîne vide sinon.

mot_supprimer()

Supprimer un mot

mot_supprimer(int $id_mot) : mixed
Parameters
$id_mot : int

Identifiant du mot clé à supprimer

Tags
pipeline_appel

trig_supprimer_objets_lies

mot_associer()

Associer un mot à des objets listés sous forme `array($objet=>$id_objets,...)`

mot_associer(int $id_mot, array<string|int, mixed> $objets[, array<string|int, mixed> $qualif = null ]) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

On peut passer optionnellement une qualification du (des) lien(s) qui sera alors appliquée dans la foulée. En cas de lot de liens, c'est la même qualification qui est appliquée à tous.

Parameters
$id_mot : int

Identifiant du mot à faire associer

$objets : array<string|int, mixed>

Description des associations à faire

$qualif : array<string|int, mixed> = null

Couples (colonne => valeur) de qualifications à faire appliquer

Tags
example 
mot_associer(3, array('auteur'=>2));
// Ne fonctionnera pas ici car pas de champ 'vu' sur spip_mots_liens :
mot_associer(3, array('auteur'=>2), array('vu'=>'oui));
Return values
int|bool —

Nombre de modifications, false si erreur

mot_dissocier()

Dissocier un mot des objets listés sous forme `array($objet=>$id_objets,...)`

mot_dissocier(int $id_mot, array<string|int, mixed> $objets) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

un * pour $id_mot,$objet,$id_objet permet de traiter par lot

Parameters
$id_mot : int

Identifiant du mot à faire dissocier

$objets : array<string|int, mixed>

Description des dissociations à faire

Return values
int|bool —

Nombre de modifications, false si erreur

mot_qualifier()

Qualifier le lien d'un mot avec les objets listés `array($objet=>$id_objets,...)`

mot_qualifier(int $id_mot, array<string|int, mixed> $objets, array<string|int, mixed> $qualif) : int|bool

$id_objets peut lui-même être un scalaire ou un tableau pour une liste d'objets du même type

Une * pour $id_auteur,$objet,$id_objet permet de traiter par lot

Parameters
$id_mot : int

Identifiant du mot à faire associer

$objets : array<string|int, mixed>

Description des associations à faire

$qualif : array<string|int, mixed>

Couples (colonne => valeur) de qualifications à faire appliquer

Tags
example 
$c = array('vu'=>'oui');
Return values
int|bool —

Nombre de modifications, false si erreur

un_seul_mot_dans_groupe()

Teste si un groupe ne doit avoir qu'un seul mot clé associé

un_seul_mot_dans_groupe(int $id_groupe) : bool

Renvoyer TRUE si le groupe de mot ne doit être associé qu'une fois aux objet (maximum un seul mot de ce groupe associé à chaque objet)

Parameters
$id_groupe : int

Identifiant du groupe de mot clé

Return values
bool —

true si un seul mot doit être lié avec ce groupe, false sinon.


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results