Documentation du code de SPIP et de ses plugins

Commandes

Editer

Table of Contents

Functions

action_distribuer_commande_dist()  : mixed
Distribuer une commande : pour chaque ligne de la commande on appelle l'api distribuer si elle est implementee pour l'objet concerne permet les distributions des produits dematerialises : par email, activation abonnement etc.
action_editer_commande_dist()  : array<string|int, mixed>
Point d'entrée d'édition d'une commande
commande_inserer()  : int|bool
Crée une nouvelle commande et retourne son identifiant
commande_modifier()  : mixed|string
Appelle les fonctions de modification d'une commande
commande_instituer()  : mixed|string
Instituer une commande
editer_commande_details()  : void
Fabrique la requête d'institution de la commande
revision_commande()  : mixed|string
Enregistre une modification d'une commande
commande_insert()  : mixed
Crée une nouvelle commande
commande_set()  : mixed
Appelle les fonctions de modification d'une commande
instituer_commande()  : mixed
Modifie des éléments à part que sont l'auteur, la date, le statut

Functions

action_distribuer_commande_dist()

Distribuer une commande : pour chaque ligne de la commande on appelle l'api distribuer si elle est implementee pour l'objet concerne permet les distributions des produits dematerialises : par email, activation abonnement etc.

action_distribuer_commande_dist(int $id_commande[, mixed $statut_ancien = null ]) : mixed

le statut du detail doit etre passe a 'envoye' apres distribution, pour ne pas risquer une double distribution mais on ne gere pas ici, c'est a chaque fonction distribuer de decider (ie cas des retour ou exotiques)

Parameters
$id_commande : int
$statut_ancien : mixed = null

action_editer_commande_dist()

Point d'entrée d'édition d'une commande

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

On ne peut entrer que par un appel en fournissant $id_commande mais pas pas une url

Parameters
$id_commande : int = null

Identifiant de la commande

Tags
uses
commande_inserer()
uses
commande_modifier()
Return values
array<string|int, mixed>

Identifiant de la commande et message d'erreur eventuel

commande_inserer()

Crée une nouvelle commande et retourne son identifiant

commande_inserer([null $id_parent = null ][, array<string|int, mixed> $champs = [] ]) : int|bool

Les notifications par email sont traitées après l'insertion en base et l'appel des pipelines

Parameters
$id_parent : null = null

Paramètre inutilisé, présent pour compatibilité avec api modifier objet

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

Couples des champs/valeurs par défaut

Tags
uses
commandes_notifier()
pipeline_appel

pre_insertion

pipeline_appel

post_insertion

used-by
action_editer_commande_dist()
used-by
commande_insert()
used-by
creer_commande_encours()
Return values
int|bool
  • Identifiant de la commande si succès
  • False en cas d'erreur

commande_modifier()

Appelle les fonctions de modification d'une commande

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

Identifiant de la commande

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

Couples des champs/valeurs à modifier

Tags
uses
commande_instituer()
uses
objet_modifier_champs()
used-by
action_editer_commande_dist()
used-by
revision_commande()
used-by
commande_set()
used-by
commande_lier_auteur_dist()
Return values
mixed|string

$err Message d'erreur éventuel

commande_instituer()

Instituer une commande

commande_instituer(int $id_commande, array<string|int, mixed> $c[, bool $calcul_details = true ]) : mixed|string

Modifie des éléments à part que sont l'auteur, la date, le statut

Parameters
$id_commande : int

Identifiant de la commande

$c : array<string|int, mixed>

Couples champ/valeur à modifier

$calcul_details : bool = true

(?) Inutilisé

Tags
uses
editer_commande_details()
uses
commandes_notifier()
pipeline_appel

pre_edition

pipeline_appel

post_edition

used-by
commande_modifier()
used-by
instituer_commande()
used-by
action_instituer_commande()
Return values
mixed|string

editer_commande_details()

Fabrique la requête d'institution de la commande

editer_commande_details(int $id_commande, array<string|int, mixed> $champs[, bool $cond = true ]) : void

Modifie la commande en calculant les dépendances des détails

Parameters
$id_commande : int

Identifiant de la commande

$champs : array<string|int, mixed>

Couples des champs/valeurs à modifier

$cond : bool = true

(?) inutilisé

Tags
used-by
commande_instituer()

revision_commande()

Enregistre une modification d'une commande

revision_commande(int $id_commande[, array<string|int, mixed> $c = false ]) : mixed|string
Parameters
$id_commande : int

Identifiant de la commande

$c : array<string|int, mixed> = false

Couples des champs/valeurs modifiées

Tags
uses
commande_modifier()
deprecated

Alias de 'commande_modifier' pour rétro-compatibilité

Return values
mixed|string

commande_insert()

Crée une nouvelle commande

commande_insert([array<string|int, mixed> $champs = [] ]) : mixed
Parameters
$champs : array<string|int, mixed> = []

Couples des champs/valeurs par défaut

Tags
deprecated

Alias de 'commande_inserer' pour rétro-compatibilité

uses
commande_inserer()

commande_set()

Appelle les fonctions de modification d'une commande

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

Identifiant de la commande

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

Couples des champs/valeurs à modifier

Tags
uses
commande_modifier()
deprecated

Alias de 'commande_modifier' pour rétro-compatibilité

instituer_commande()

Modifie des éléments à part que sont l'auteur, la date, le statut

instituer_commande(int $id_commande, array<string|int, mixed> $c[, bool $calcul_details = true ]) : mixed
Parameters
$id_commande : int

Identifiant de la commande

$c : array<string|int, mixed>

Couples des champs/valeurs à modifier

$calcul_details : bool = true

(?) Inutilisé

Tags
deprecated

Alias de 'commande_instituer' pour rétro-compatibilité

uses
commande_instituer()

        
On this page

Search results