Documentation du code de SPIP et de ses plugins

SPIP

actions.php

Gestion des actions sécurisées

Table of Contents

Functions

generer_action_auteur()  : array<string|int, mixed>|string
Retourne une URL ou un formulaire securisé
redirige_action_auteur()  : string
Génère une URL ou un formulaire dirigé vers un fichier action (action/xx.php)
redirige_action_post()  : array<string|int, mixed>|string
Retourne une URL ou un formulaire sécurisé en méthode POST
ajax_retour()  : void
Fonction de formatage du contenu renvoyé en ajax

Functions

generer_action_auteur()

Retourne une URL ou un formulaire securisé

generer_action_auteur(string $action[, string $arg = '' ][, string $redirect = '' ][, bool|int|string $mode = false ][, string|int $att = '' ][, bool $public = false ]) : array<string|int, mixed>|string
Parameters
$action : string

Nom du fichier/action appelé (dans le répertoire action)

$arg : string = ''

Arguments pour l'action sécurisée, peut etre vide

$redirect : string = ''

Adresse de redirection souhaitée à la fin du bon déroulement de l’action

$mode : bool|int|string = false
  • -1 : renvoyer action, arg et hash sous forme de array()
  • true ou false : renvoyer une url, avec &amp; (false) ou & (true)
  • string : renvoyer un formulaire
$att : string|int = ''
  • id_auteur pour lequel générer l'action en mode url ou array()
  • attributs du formulaire en mode formulaire
$public : bool = false
Tags
uses
inc_securiser_action_dist()
used-by
redirige_action_auteur()
Return values
array<string|int, mixed>|string

URL, code HTML du formulaire ou tableau (action, arg, hash)

redirige_action_auteur()

Génère une URL ou un formulaire dirigé vers un fichier action (action/xx.php)

redirige_action_auteur(string $action, string $arg, string $ret[, string $gra = '' ][, bool|string|int $mode = false ][, string $atts = '' ][, bool $public = false ]) : string

Le génère à condition que $mode="texte".

Parameters
$action : string

Nom du fichier action/xx.php

$arg : string

Argument passé à l'action, qui sera récupéré par la fonction securiser_action()

$ret : string

Nom du script exec sur lequel on revient après l'action (redirection), que l'on peut récupérer dans une fonction d'action par _request('redirect')

$gra : string = ''

Arguments transmis au script exec de retour arg1=yy&arg2=zz

$mode : bool|string|int = false
  • -1 : renvoyer action, arg et hash sous forme de array()
  • true ou false : renvoyer une url, avec &amp; (false) ou & (true)
  • string : renvoyer un formulaire
$atts : string = ''

?

$public : bool = false

true produit une URL d'espace public false (par défaut) produit une URL d'espace privé

Tags
uses
generer_action_auteur()
Return values
string

Code HTML du formulaire

redirige_action_post()

Retourne une URL ou un formulaire sécurisé en méthode POST

redirige_action_post(string $action, string $arg, string $ret, string $gra, bool|int|string $corps[, string|int $att = '' ]) : array<string|int, mixed>|string
Parameters
$action : string

Nom du fichier/action appelé (dans le répertoire action)

$arg : string

Arguments pour l'action sécurisée

$ret : string

Adresse de redirection souhaitée à la fin du bon déroulement de l’action

$gra : string

Arguments à transmettre, tel que arg1=yy&arg2=zz

$corps : bool|int|string
  • -1 : renvoyer action, arg et hash sous forme de array()
  • true ou false : renvoyer une url, avec &amp; (false) ou & (true)
  • string : renvoyer un formulaire
$att : string|int = ''
  • id_auteur pour lequel générer l'action en mode url ou array()
  • attributs du formulaire en mode formulaire
Return values
array<string|int, mixed>|string

URL, code HTML du formulaire ou tableau (action, arg, hash)

ajax_retour()

Fonction de formatage du contenu renvoyé en ajax

ajax_retour(string $corps[, string $content_type = null ]) : void

Echo la réponse directement

Parameters
$corps : string
$content_type : string = null

permet de definir le type de contenu renvoye. Si rien de précisé, ou si true c'est "text/html" avec un entete xml en plus. La valeur speciale false fournit text/html sans entete xml. Elle equivaut a passer "text/html" comme $content_type

Tags
used-by
exec_info_plugin_dist()
used-by
exec_informer_dist()
used-by
exec_plonger_dist()
used-by
exec_puce_statut_args()
used-by
exec_rechercher_dist()
used-by
exec_selectionner_dist()

        
On this page

Search results