SPIP Code

Documentation du code de SPIP et de ses plugins

SPIP

editer_objet.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_objet_dist()  : array<string|int, mixed>
Point d'entrée d'édition d'un objet
objet_modifier()  : mixed|string
Appelle toutes les fonctions de modification d'un objet
objet_inserer()  : bool|int
Insère en base un objet générique
objet_instituer()  : string
Modifie le statut et/ou la date d'un objet
objet_editer_heritage()  : mixed
Fabrique la requete d'institution de l'objet, avec champs herites
objet_lire()  : array<string|int, mixed>|string|int|bool
Lit un objet donné connu par son id ou par un identifiant textuel unique et renvoie tout ou partie de sa description.

Functions

action_editer_objet_dist()

Point d'entrée d'édition d'un objet

action_editer_objet_dist([int $id = null ][, string $objet = null ][, array<string|int, mixed> $set = null ]) : array<string|int, mixed>

On ne peut entrer que par un appel en fournissant $id et $objet ou avec un argument d'action sécurisée de type "objet/id"

Parameters
$id : int = null
$objet : string = null
$set : array<string|int, mixed> = null
Return values
array<string|int, mixed>

objet_modifier()

Appelle toutes les fonctions de modification d'un objet

objet_modifier(string $objet, int $id[, array<string|int, mixed>|null $set = null ]) : mixed|string

Il peut y avoir une fonction propre au type d'objet : modifier dans action/editer.php, qui a dans ce cas la précédence.

Retourne une chaîne vide en cas de succès, et déclenche des notifications selon ce qu'on modifie : _modifier + objet_modifier et/ou _instituer + objet_instituer.

Parameters
$objet : string
$id : int
$set : array<string|int, mixed>|null = null
Tags
uses
collecter_requests()
uses
objet_modifier_champs()
uses
objet_instituer()
pipeline_appel

pre_edition : avant la mise à jour en base (via objet_modifier_champs())

pipeline_appel

post_edition : après la mise à jour en base (via objet_modifier_champs())

Return values
mixed|string —
  • En cas de succès : (string) chaîne vide
  • En cas d'erreur : (string) message d'erreur

objet_inserer()

Insère en base un objet générique

objet_inserer(string $objet[, int $id_parent = null ][, array<string|int, mixed>|null $set = null ]) : bool|int

Il peut y avoir une fonction propre au type d'objet : inserer dans action/editer.php, qui a dans ce cas la précédence.

Retourne le numéro de l'objet en cas de succès, et déclenche 2 notifications : _inserer et objet_inserer.

Parameters
$objet : string
$id_parent : int = null
$set : array<string|int, mixed>|null = null
Tags
uses
sql_insertq()
pipeline_appel

pre_insertion : avant l'enregistrement en base

pipeline_appel

post_insertion : après l'enregistrement en base

global

array $GLOBALS ['visiteur_session']

global

array $GLOBALS ['meta']

global

string $GLOBALS ['spip_lang']

Return values
bool|int —
  • Succès : (int) numéro de l'objet crée
  • Erreur :
    • (bool) false si sql_insertq() a échoué
    • (int) 0 si le type d'objet n'existe pas ou que la table est mal déclarée

objet_instituer()

Modifie le statut et/ou la date d'un objet

objet_instituer(string $objet, int $id, array<string|int, mixed> $c[, bool $calcul_rub = true ]) : string
Parameters
$objet : string
$id : int
$c : array<string|int, mixed>

$c est un array ('statut', 'id_parent' = changement de rubrique) statut et rubrique sont lies, car un admin restreint peut deplacer un objet publie vers une rubrique qu'il n'administre pas

$calcul_rub : bool = true
Tags
used-by
objet_modifier()
Return values
string

objet_editer_heritage()

Fabrique la requete d'institution de l'objet, avec champs herites

objet_editer_heritage(string $objet, int $id, int $id_rubrique, string $statut, array<string|int, mixed> $champs[, bool $cond = true ]) : mixed
Parameters
$objet : string
$id : int
$id_rubrique : int
$statut : string
$champs : array<string|int, mixed>
$cond : bool = true

objet_lire()

Lit un objet donné connu par son id ou par un identifiant textuel unique et renvoie tout ou partie de sa description.

objet_lire(string $objet, int|string $valeur_id[, array<string|int, mixed> $options = [] ]) : array<string|int, mixed>|string|int|bool

Il est possible pour un objet donné de fournir la fonction <objet>_lire_champs qui renvoie simplement tous les champs de l'objet concerné sans aucun autre traitement. Sinon, l'appel SQL est réalisé par l'API.

Parameters
$objet : string

Type d'objet (comme article ou rubrique)

$valeur_id : int|string

Valeur du champ identifiant

$options : array<string|int, mixed> = []

Tableau d'options dont les index possibles sont:

  • champs : liste des champs à renvoyer. Si absent ou vide la fonction renvoie tous les champs.
  • champ_id : nom du champ utilisé comme identifiant de l'objet. Si absent ou vide on utilise l'id défini dans la déclaration de l'objet.
  • force : true pour reforcer une lecture en base meme si un cache existe
Return values
array<string|int, mixed>|string|int|bool —

si champs est non fourni ou au format array false : l'objet demande n'existe pas array vide : l'objet existe, mais aucun champ demande n'existe array non vide : objet avec le ou les champs demandes existants (les champs demandes non existant sont absent) si champs est fourni au format string false : l'objet demande n'existe pas OU le champs demande n'existe pas string|int : valeur du champ demande pour l'objet demande


        

        
    




    

    

                                

                

                            
    

        On this page

        
    


                

                            

            

    

        

            
Search results