SPIP Code

Documentation du code de SPIP et de ses plugins

Big Upload

Identifier
in package
uses LogTrait

Gère l'identification du formulaire

Tags
plugin

Bigup

copyright

2016

author

marcimat

licence

GNU/GPL

Table of Contents

Properties

$auteur  : string
Login ou identifiant de l'auteur qui intéragit
$champ  : string
Nom du champ dans le formulaire qui utilise flow
$formulaire  : string
$formulaire_args  : string
$formulaire_identifiant  : string
Identifie un formulaire par rapport à un autre identique sur la même page ayant un appel différent.
$max_size_file  : int
Taille du fichier maximum
$token  : string
$token_expiration  : int
Expiration du token (en secondes)

Methods

__construct()  : mixed
Constructeur
__get()  : mixed|null
Pouvoir obtenir les propriétés privées sans les modifier.
__isset()  : bool
Pouvoir obtenir les propriétés privées sans les modifier.
debug()  : mixed
depuisArgumentsPipeline()  : Identifier
Constructeur depuis les arguments d'un pipeline
depuisRequest()  : Identifier
Constructeur depuis les paramètres dans l'environnement posté.
error()  : mixed
generer_token_champ()  : string
identifier_auteur()  : string
Identifier l'auteur qui accède
identifier_formulaire()  : string
Calcule un identifiant de formulaire en fonction de ses arguments et du secret du site
info()  : mixed
log()  : mixed
Des logs
obtenir_champ_token()  : bool
Récupère le champ du token
recuperer_configuration()  : mixed
Définit certaines configurations
recuperer_parametres()  : mixed
Retrouve les paramètres pertinents pour gérer le test ou la réception de fichiers.
verifier_token()  : bool
Vérifier le token utilisé
verifier_un_token()  : bool

Properties

$auteur

Login ou identifiant de l'auteur qui intéragit

private string $auteur = ''

$champ

Nom du champ dans le formulaire qui utilise flow

private string $champ = ''

$formulaire_identifiant

Identifie un formulaire par rapport à un autre identique sur la même page ayant un appel différent.

private string $formulaire_identifiant = ''

$max_size_file

Taille du fichier maximum

private int $max_size_file = 0

En Mo

$token_expiration

Expiration du token (en secondes)

private int $token_expiration = 86400

En secondes

Tags
todo

À définir en configuration

Methods

__construct()

Constructeur

public __construct([string $formulaire = '' ][, string $formulaire_args = '' ][, string $token = '' ]) : mixed
Parameters
$formulaire : string = ''

Nom du formulaire.

$formulaire_args : string = ''

Hash du formulaire

$token : string = ''

Jeton d'autorisation

__get()

Pouvoir obtenir les propriétés privées sans les modifier.

public __get(string $property) : mixed|null
Parameters
$property : string
Return values
mixed|null

__isset()

Pouvoir obtenir les propriétés privées sans les modifier.

public __isset(string $property) : bool
Parameters
$property : string
Return values
bool

debug()

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

depuisArgumentsPipeline()

Constructeur depuis les arguments d'un pipeline

public static depuisArgumentsPipeline(array<string|int, mixed> $args) : Identifier

Le tableau d'argument doit avoir 'form' et 'args'. La fonction recalcule le hash du formulaire, qui servira au constructeur normal.

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

Arguments du pipeline, généralement $flux['args']

Return values
Identifier

error()

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

generer_token_champ()

public generer_token_champ(string $champ) : string
Parameters
$champ : string
Return values
string

identifier_auteur()

Identifier l'auteur qui accède

public identifier_auteur() : string

Retrouve un identifiant unique, même pour les auteurs anonymes. Si on connait l'auteur, on essaie de mettre un nom humain pour une meilleure visibilité du répertoire.

Retourne un identifiant d'auteur :

  • {id_auteur}.{login} sinon
  • {id_auteur} sinon
  • 0.{session_id}
Return values
string

identifier_formulaire()

Calcule un identifiant de formulaire en fonction de ses arguments et du secret du site

public identifier_formulaire() : string

Lorsque le formulaire dispose d'une fonction 'identifier', on l'utilise, sinon tout changement dans les arguments, tel que passer tout l'ENV en option, ou la date du calcul créerait un nouvel identifiant à chaque affichage du formulaire. Le cas par exemple se présente sur le formulaire editer_logos.

Dans notre cas ce n'est pas ce que l'on veut.

Tags
see
formulaire__identifier()
Return values
string —

l'identifiant

info()

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

log()

Des logs

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

obtenir_champ_token()

Récupère le champ du token

public obtenir_champ_token() : bool
Tags
note

On permet de le calculer dès la construction de la classe, avant même vérifier la validité du token. Ça permet au constructeur du Cache d'avoir cette info directement, sans utiliser de méthode supplémentaire après la vérification du token.

Return values
bool —

True si le champ est trouvé.

recuperer_configuration()

Définit certaines configurations

public recuperer_configuration() : mixed

recuperer_parametres()

Retrouve les paramètres pertinents pour gérer le test ou la réception de fichiers.

public recuperer_parametres() : mixed

verifier_token()

Vérifier le token utilisé

public verifier_token() : bool

Le token doit arriver, de la forme champ:time:clé De même que formulaire_action et formulaire_action_args

Le temps ne doit pas être trop vieux d'une part, et la clé de sécurité doit évidemment être valide.

Return values
bool

verifier_un_token()

public verifier_un_token(string $token) : bool
Parameters
$token : string
Return values
bool 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results