Documentation du code de SPIP et de ses plugins

Big Upload

Formulaire
in package
Uses LogTrait

Gère les modifications du html d'un formulaire existant

Table of Contents

Properties

$contexte  : array<string|int, mixed>
Contexte d'environnement du formulaire
$formulaire  : string
Code HTML du formulaire
$identifier  : Identifier|null
Identification du formulaire, auteur, champ, tokem

Methods

__construct()  : mixed
Constructeur
completer_attribut()  : string
Ajoute une valeur sur un attribut de balise html
debug()  : mixed
error()  : mixed
exp_attribut_est_expr_valeur()  : string
Exp Regexp : texte $attribut='[expression]' ou $attribut="[expression]"
exp_attribut_est_valeur()  : string
Exp Regexp : texte $attribut='$valeur' ou $attribut="$valeur"
exp_attribut_possede_valeur()  : string
Exp Regexp : texte $attribut='... $valeur ...' ou $attribut="... $valeur ..."
exp_capturer_attribut_name()  : string
Exp Regexp : texte $champ='... $valeur ...' ou $champ="... $valeur ..."
exp_non_fin_balise()  : string
Exp Regexp : du texte mais pas une fin de balise (>)
get()  : string
Retourne le code html du formulaire
info()  : mixed
inserer_attribut()  : string
Ajoute ou remplace un attribut et sa valeur sur une balise html
inserer_js()  : mixed
Insère un script en fin de formulaire
log()  : mixed
Des logs
preparer_input()  : bool|int
Préparer les champs input d'un formulaire déjà existant
preparer_input_class()  : bool|int
Cherche les inputs de type file possédant une certaine la classe css et leur ajoute le token (et autres infos dessus)
regexp_balise_attribut_contenant_valeur()  : string
Regexp : capture une balise ayant un attribut contenant une valeur
regexp_input_classe()  : string
Regexp : capture d'un champ input ayant une classe CSS indiquée
regexp_input_name()  : string
Regexp : capture d'un champ input ayant un champ name indiqué
regexp_input_trouver_name()  : string
Regexp : capture de la valeur de l'attribut 'name' d'une balise input.

Properties

$contexte

Contexte d'environnement du formulaire

private array<string|int, mixed> $contexte = []

Methods

__construct()

Constructeur

public __construct(Identifier $identifier, string $formulaire, array<string|int, mixed> $contexte) : mixed
Parameters
$identifier : Identifier
$formulaire : string

Code HTML du formulaire

$contexte : array<string|int, mixed>

Environnement du formulaire

completer_attribut()

Ajoute une valeur sur un attribut de balise html

public static completer_attribut(string $balise, string $attribut, string $valeur) : string
Parameters
$balise : string
$attribut : string
$valeur : string
Return values
string

Balise HTML complétée

debug()

public static debug(mixed $quoi) : mixed
Parameters
$quoi : mixed

error()

public static error(mixed $quoi) : mixed
Parameters
$quoi : mixed

exp_attribut_est_expr_valeur()

Exp Regexp : texte $attribut='[expression]' ou $attribut="[expression]"

public static exp_attribut_est_expr_valeur(string $attribut, string $valeur) : string
Parameters
$attribut : string
$valeur : string
Tags
uses

exp_attribut_est_valeur();

Return values
string

exp_attribut_est_valeur()

Exp Regexp : texte $attribut='$valeur' ou $attribut="$valeur"

public static exp_attribut_est_valeur(string $attribut, string $valeur[, bool $quote = true ]) : string
Parameters
$attribut : string
$valeur : string
$quote : bool = true

Appliquer preg_quote() ?

Return values
string

exp_attribut_possede_valeur()

Exp Regexp : texte $attribut='... $valeur ...' ou $attribut="... $valeur ..."

public static exp_attribut_possede_valeur(string $attribut, string $valeur[, bool $quote = true ]) : string
Parameters
$attribut : string
$valeur : string
$quote : bool = true

Appliquer preg_quote() ?

Return values
string

exp_capturer_attribut_name()

Exp Regexp : texte $champ='... $valeur ...' ou $champ="... $valeur ..."

public static exp_capturer_attribut_name() : string
Return values
string

exp_non_fin_balise()

Exp Regexp : du texte mais pas une fin de balise (>)

public static exp_non_fin_balise() : string
Return values
string

get()

Retourne le code html du formulaire

public get() : string
Return values
string

info()

public static info(mixed $quoi) : mixed
Parameters
$quoi : mixed

inserer_attribut()

Ajoute ou remplace un attribut et sa valeur sur une balise html

public static inserer_attribut(string $balise, string $attribut, string $valeur) : string
Parameters
$balise : string
$attribut : string
$valeur : string
Return values
string

Balise HTML complétée

inserer_js()

Insère un script en fin de formulaire

public inserer_js(string $script) : mixed
Parameters
$script : string

nom du script dans 'javascript/'

log()

Des logs

public static log(mixed $quoi[, int $gravite = _LOG_INFO_IMPORTANTE ]) : mixed
Parameters
$quoi : mixed
$gravite : int = _LOG_INFO_IMPORTANTE

preparer_input()

Préparer les champs input d'un formulaire déjà existant

public preparer_input(string|array<string|int, string> $champs[, array<string|int, mixed> $options = [] ]) : bool|int

Permet d'ajouter à un ou plusieurs champs de type 'file' d'un formulaire dont on reçoit le code HTML et le contexte les éléments nécessaires pour utiliser Bigup dessus.

Pour les noms de champs indiqués, on ajoute :

  • la classe CSS 'bigup'
  • le token
  • l'attribut multiple, si le name se termine par []
  • la liste des fichiers déjà uploadés pour ce formulaire
  • la classe CSS 'pleine_largeur' sur le conteneur .editer.

Le tableau d'option permet de modifier certains comportements.

Parameters
$champs : string|array<string|int, string>

Nom du ou des champs concernés

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

{ @var string $input_class Classe CSS à ajouter aux input file concernés. Par défaut 'bigup' @var string $editer_class Classe CSS à ajouter au conteneur .editer Par défaut 'pleine_largeur' }

Return values
bool|int

False si erreur, sinon nombre de remplacements effectués.

preparer_input_class()

Cherche les inputs de type file possédant une certaine la classe css et leur ajoute le token (et autres infos dessus)

public preparer_input_class(string|array<string|int, mixed> $classes[, array<string|int, mixed> $options = [] ]) : bool|int

On retrouve les names des différents champs, puis on s'appuie sur la fonction principale qui applique les traitements à partir justement du nom du champ.

Parameters
$classes : string|array<string|int, mixed>

Classe CSS ou liste de classes CSS à chercher

$options : array<string|int, mixed> = []
Tags
uses
preparer_input()
Return values
bool|int

False si erreur, sinon nombre de remplacements effectués.

regexp_balise_attribut_contenant_valeur()

Regexp : capture une balise ayant un attribut contenant une valeur

public static regexp_balise_attribut_contenant_valeur(string $balise, string $attribut, string $valeur) : string

<div class="editer editer_{champ}" mais pas "editer editer_{champ}_qqc" ... >

Parameters
$balise : string

Nom de la balise

$attribut : string
$valeur : string
Return values
string

regexp_input_classe()

Regexp : capture d'un champ input ayant une classe CSS indiquée

public static regexp_input_classe(string|array<string|int, mixed> $classes) : string
Parameters
$classes : string|array<string|int, mixed>

Classe CSS ou liste de classes CSS

Return values
string

regexp_input_name()

Regexp : capture d'un champ input ayant un champ name indiqué

public static regexp_input_name(mixed $champ) : string
Parameters
$champ : mixed
Return values
string

regexp_input_trouver_name()

Regexp : capture de la valeur de l'attribut 'name' d'une balise input.

public static regexp_input_trouver_name() : string

La valeur sera dans la clé champ.

Return values
string

        
On this page

Search results