MediaTekDocuments API REST

Url
in package

Singleton car la récupération des données ne peut se faire qu'une fois Permet de gérer le contenu de l'URL qui sollicite l'API

Table of Contents

Properties

$data  : array<string|int, mixed>
tableau contenant toutes les variables transmises
$dotenv  : Dotenv
accès aux variables d'environnement
$instance  : Url
instance de la classe actuelle
$methodeHTTP  : string
méthode de transfert HTTP utilisé pour accéder à l'API (GET, PUT, POST, DELETE)

Methods

authentification()  : bool
vérifie l'authentification suivant la demande possibilité d'ajouter des 'case' et de nouvelles fonctions si besoin d'un autre type d'authentification
getInstance()  : Url
méthode statique de création de l'instance unique
recupMethodeHTTP()  : string
récupère la méthode HTTP utilisée pour le transfert
recupVariable()  : string|array<string|int, mixed>|null
retour d'une variable avec les caractères spéciaux convertis et au format array si format "json" reçu possibilité d'ajouter d'autres 'case' de conversions
__construct()  : mixed
constructeur privé récupère les variables d'environnement récupère les variables envoyées via l'url
basicAuthentification()  : bool
compare le user/pwd reçu en 'basic auth' avec le user/pwd dans les variables d'environnement
recupAllData()  : array<string|int, mixed>
récupération de toutes les variables envoyées par l'URL nettoyage et retour dans un tableau associatif

Properties

$data

tableau contenant toutes les variables transmises

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

$dotenv

accès aux variables d'environnement

private Dotenv $dotenv

$instance

instance de la classe actuelle

private static Url $instance = \null

$methodeHTTP

méthode de transfert HTTP utilisé pour accéder à l'API (GET, PUT, POST, DELETE)

private string $methodeHTTP

Methods

authentification()

vérifie l'authentification suivant la demande possibilité d'ajouter des 'case' et de nouvelles fonctions si besoin d'un autre type d'authentification

public authentification() : bool
Return values
bool

getInstance()

méthode statique de création de l'instance unique

public static getInstance() : Url
Return values
Url

recupMethodeHTTP()

récupère la méthode HTTP utilisée pour le transfert

public recupMethodeHTTP() : string
Return values
string

recupVariable()

retour d'une variable avec les caractères spéciaux convertis et au format array si format "json" reçu possibilité d'ajouter d'autres 'case' de conversions

public recupVariable(string $nom[, string $format = "string" ]) : string|array<string|int, mixed>|null
Parameters
$nom : string
$format : string = "string"
Return values
string|array<string|int, mixed>|null

__construct()

constructeur privé récupère les variables d'environnement récupère les variables envoyées via l'url

private __construct() : mixed

basicAuthentification()

compare le user/pwd reçu en 'basic auth' avec le user/pwd dans les variables d'environnement

private basicAuthentification() : bool
Return values
bool

true si authentification réussie

recupAllData()

récupération de toutes les variables envoyées par l'URL nettoyage et retour dans un tableau associatif

private recupAllData() : array<string|int, mixed>
Return values
array<string|int, mixed>

        
On this page

Search results