Documentation du code de SPIP et de ses plugins

Commandes

Commandes

Table of Contents

Functions

commande_arrondir_quantite_dist()  : int
Arrondir la quantite d'une ligne de commande, en fonction de ce que permet l'objet par defaut c'est en entier pour tout le monde, mais un plugin peut etendre cela
commande_generer_reference_dist()  : string
Génère un numéro unique utilisé pour remplir le champ `reference` lors de la création d'une commande.
commande_infos_client_dist()  : array<string|int, mixed>
Informations importantes d'une commande dans un tableau normé, extensible dans un pipeline
commandes_normalise_code_pays()  : mixed|string
Passer les code_pays en code alpha 3 si besoin
commande_lier_auteur_dist()  : mixed|string
Remplit le champ `id_auteur` d'une commande

Functions

commande_arrondir_quantite_dist()

Arrondir la quantite d'une ligne de commande, en fonction de ce que permet l'objet par defaut c'est en entier pour tout le monde, mais un plugin peut etendre cela

commande_arrondir_quantite_dist( $quantite[, string $objet = '' ][, int $id_objet = 0 ]) : int
Parameters
$quantite :
$objet : string = ''
$id_objet : int = 0
Return values
int

Retourne la quantité arrondie

commande_generer_reference_dist()

Génère un numéro unique utilisé pour remplir le champ `reference` lors de la création d'une commande.

commande_generer_reference_dist(int $id_commande[, int $id_auteur = 0 ]) : string

Le numéro retourné est le nombre de secondes écoulées depuis le 1er janvier 1970

Parameters
$id_commande : int
$id_auteur : int = 0

(optionnel) identifiant de l'auteur

Tags
example
$fonction_reference = charger_fonction('generer_reference', 'commande/');
used-by
inc_commandes_reference_dist()
Return values
string

reference de la commande

commande_infos_client_dist()

Informations importantes d'une commande dans un tableau normé, extensible dans un pipeline

commande_infos_client_dist(int $id_commande[, bool $forcer_calcul = false ]) : array<string|int, mixed>

Afin de garder une compatibilité avec les anciens comportements,la fonction recherche déjà les informations en plusieurs endroits, notamment pour les coordonnées.

Parameters
$id_commande : int

Identifiant de la commande

$forcer_calcul : bool = false

Si vrai, force la recherche de toutes les infos même si ça avait déjà été fait dans le même hit

Return values
array<string|int, mixed>

Retourne un tableau avec les clés possibles suivantes, optionnelles suivant ce qui est trouvé :

  • int id_auteur : compte utilisateur de la personne qui a fait la commande
  • string nom : nom complet de la personne ou orga qui a fait la commande
  • array livraison
    • string nom : nom complet de la personne à qui livrer
    • string organisation : nom complet de l'organisation à qui livrer
    • array adresse
      • string voie
      • string complement
      • string code_postal
      • string ville
      • string localite_dependante
      • string zone_administrative
      • string pays : code international
    • string telephone : numero de téléphone pour la livraison
  • array facturation
    • string nom : nom complet de la personne à qui facturer
    • string organisation : nom complet de l'organisation à qui facturer
    • array adresse
      • string voie
      • string complement
      • string code_postal
      • string ville
      • string localite_dependante
      • string zone_administrative
      • string pays : code international
    • string no_tva_intra : numero de TVA intracommunautaire utilisé pour la facturation
    • string telephone : numero de téléphone pour la facturation (contact administratif)

commandes_normalise_code_pays()

Passer les code_pays en code alpha 3 si besoin

commandes_normalise_code_pays( $code_pays) : mixed|string
Parameters
$code_pays :
Return values
mixed|string

commande_lier_auteur_dist()

Remplit le champ `id_auteur` d'une commande

commande_lier_auteur_dist(int $id_commande, int $id_auteur) : mixed|string
Parameters
$id_commande : int

identifiant de la commande

$id_auteur : int

identifiant de l'auteur

Tags
uses
commande_modifier()
used-by
inc_lier_commande_auteur_dist()
Return values
mixed|string

$err Message d'erreur éventuel


        
On this page

Search results