Package Actions

Fichiers du package

FichierDescription
editer_groupe_mots.php

Gestion de l'action editer_groupes_mots

editer_mot.php

Gestion de l'action editer_mot

supprimer_groupe_mots.php

Gestion de l'action supprimer_groupe_mots

supprimer_mot.php

Gestion de l'action supprimer_mot

Proposer une amélioration

Liste des fonctions

Si aucun identifiant n'est donné, on crée alors un nouveau groupe de mots clés.

array action_editer_groupe_mots_dist( null | integer $id_groupe = null )

Paramètres

  1. null | integer $id_groupe = null

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

Retour

  • array

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

Package

Proposer une amélioration

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

array action_editer_mot_dist( null | integer $arg = null )

Paramètres

  1. null | integer $arg = null

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

Retour

  • array

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

Package

Proposer une amélioration

Supprime le groupe uniquement si on en a l'autorisation. Cela implique qu'il n'y ait pas de mots clés dans le groupe.

void action_supprimer_groupe_mots_dist( null | integer $id_groupe = null )

Paramètres

  1. null | integer $id_groupe = null

    Identifiant du groupe à supprimer. En absence utilise l'argument de l'action sécurisée.

Package

Proposer une amélioration
integer | boolean groupe_mots_inserer( integer $id_parent = null , null | array $set = null )

Paramètres

  1. integer $id_parent = null

    inutilise, pour consistance de l'API

  2. null | array $set = null

Retour

  • integer | boolean

    Identifiant du nouveau groupe de mots clés.

Appelle le pipeline

Package

Proposer une amélioration
string | null groupe_mots_modifier( integer $id_groupe , array | null $set = null )

Paramètres

  1. integer $id_groupe

    Identifiant du grope de mots clés à modifier

  2. array | null $set = 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

Retour

  • string | null

    Chaîne vide si aucune erreur, Null si aucun champ à modifier, Chaîne contenant un texte d'erreur sinon.

Package

Proposer une amélioration

..)`

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

integer | boolean mot_associer( integer $id_mot , array $objets , array $qualif = null )

Paramètres

  1. integer $id_mot

    Identifiant du mot à faire associer

  2. array $objets

    Description des associations à faire

  3. array $qualif = null

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

Retour

  • integer | boolean

    Nombre de modifications, false si erreur

Exemples

  • 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));

Package

Proposer une amélioration

..)`

$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

integer | boolean mot_dissocier( integer $id_mot , array $objets )

Paramètres

  1. integer $id_mot

    Identifiant du mot à faire dissocier

  2. array $objets

    Description des dissociations à faire

Retour

  • integer | boolean

    Nombre de modifications, false si erreur

Package

Proposer une amélioration
integer | boolean mot_inserer( integer $id_groupe , array | null $set = null )

Paramètres

  1. integer $id_groupe

    Identifiant du groupe de mot

  2. array | null $set = null

Retour

  • integer | boolean

    Identifiant du nouveau mot clé, false si erreur.

Appelle le pipeline

Package

Proposer une amélioration
null | string mot_instituer( integer $id_mot , array $c )

Paramètres

  1. integer $id_mot

    Identifiant du mot clé

  2. array $c

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

Retour

  • null | string

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

Appelle le pipeline

Package

Proposer une amélioration
string | null mot_modifier( integer $id_mot , array | null $set = null )

Paramètres

  1. integer $id_mot

    Identifiant du mot clé à modifier

  2. array | null $set = 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())

Retour

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

Package

Proposer une amélioration

..)`

$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

integer | boolean mot_qualifier( integer $id_mot , array $objets , array $qualif )

Paramètres

  1. integer $id_mot

    Identifiant du mot à faire associer

  2. array $objets

    Description des associations à faire

  3. array $qualif

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

Retour

  • integer | boolean

    Nombre de modifications, false si erreur

Exemples

  • $c = array('vu'=>'oui');

Package

Proposer une amélioration
void mot_supprimer( integer $id_mot )

Paramètres

  1. integer $id_mot

    Identifiant du mot clé à supprimer

Retour

  • void

Appelle le pipeline

Package

Proposer une amélioration

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)

boolean un_seul_mot_dans_groupe( integer $id_groupe )

Paramètres

  1. integer $id_groupe

    Identifiant du groupe de mot clé

Retour

  • boolean

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

Package

Proposer une amélioration

Dépréciées

integer | boolean groupemots_inserer( string $table = '' , null | array $set = null )

Paramètres

  1. string $table = ''

    Tables sur lesquels des mots de ce groupe pourront être liés

  2. null | array $set = null

Retour

  • integer | boolean

    Identifiant du nouveau groupe de mots clés.

Voir également

Package

Deprecated

  • Utiliser groupe_mots_inserer() ou objet_inserer()
Proposer une amélioration
string | null groupemots_modifier( integer $id_groupe , array | null $set = null )

Paramètres

  1. integer $id_groupe

    Identifiant du grope de mots clés à modifier

  2. array | null $set = 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

Retour

  • string | null

    Chaîne vide si aucune erreur, Null si aucun champ à modifier, Chaîne contenant un texte d'erreur sinon.

Voir également

Package

Deprecated

  • Utiliser groupe_mots_modifier() ou objet_modifier()
Proposer une amélioration
integer | boolean insert_mot( integer $id_groupe )

Paramètres

  1. integer $id_groupe

    Identifiant du groupe de mot

Retour

  • integer | boolean

    Identifiant du nouveau mot clé, false si erreur.

Voir également

Package

Deprecated

  • Utiliser mot_inserer()
Proposer une amélioration
string | null mots_set( integer $id_mot , array | null $set = null )

Paramètres

  1. integer $id_mot

    Identifiant du mot clé à modifier

  2. array | null $set = 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

Retour

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

Voir également

Package

Deprecated

  • Utiliser mot_modifier()
Proposer une amélioration
string | null revision_groupe_mot( integer $id_groupe , array | null $c = false )

Paramètres

  1. integer $id_groupe

    Identifiant du grope de mots clés à modifier

  2. array | null $c = false

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

Retour

  • string | null

    Chaîne vide si aucune erreur, Null si aucun champ à modifier, Chaîne contenant un texte d'erreur sinon.

Voir également

Package

Deprecated

  • Utiliser groupe_mots_modifier()
Proposer une amélioration
string | null revision_mot( integer $id_mot , array | null $c = false )

Paramètres

  1. integer $id_mot

    Identifiant du mot clé à modifier

  2. array | null $c = false

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

Retour

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

Voir également

Package

Deprecated

  • Utiliser mot_modifier()
Proposer une amélioration