om_rest_client
in package
Définition de la classe 'om_rest_client'.
Classe générique d'envoi de requêtes REST avec cURL.
Table of Contents
- $acceptedContentType : array<string|int, mixed>
- Contient les différents content-types acceptés en retour des requêtes envoyées par om_rest_client.
- $charset : string
- Charset envoyé dans le header des requêtes HTTP.
- $curl : string
- Identifiant de session cURL.
- $headers : array<string|int, mixed>
- Contenu des headers content_type et http_code.
- $max_log_size : int
- Taille maximum allouée aux données du log en octets.
- $password : string
- Password utilisé dans le contexte d'authentification HTTP Basic.
- $response : array<string|int, mixed>
- Contenu de la réponse de la requête REST.
- $url : string
- Adresse URL qui sera ciblée lors de l'appel à la fonction execute() si un autre URL n'est pas précisé lors de l'appel.
- $username : string
- Username utilisé dans le contexte d'authentification HTTP Basic.
- __construct() : mixed
- Constructeur
- __destruct() : mixed
- Destructeur
- clean_url() : string
- Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .
- close() : void
- Ferme la connexion curl
- execute() : Retourne
- Lance l'appel au webservice
- getAcceptedContentType() : array<string|int, mixed>
- Accesseur de la donnée acceptedContentType
- getCharset() : string
- Accesseur retournant le charset.
- getCurl() : object
- Accesseur de l'objet curl
- getErrorMessage() : string
- Accesseur du message d'erreur curl de l'instance courante
- getHeaders() : array<string|int, mixed>
- Accesseur de la donnée headers
- getMaxLogSize() : int
- Accesseur retournant la taille maximum alloué aux données du log.
- getResponse() : string
- Accesseur de la donnée response
- getResponseCode() : numeric-string|int|float
- Accesseur du code HTTP défini dans la donnée headers
- getResponseContentType() : string
- Accesseur du content-type défini dans la donnée headers
- getUrl() : string
- Accesseur de la donnée url
- log() : void
- Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .
- setAcceptedContentType() : void
- Met à jour les types de contenu acceptés.
- setCharset() : void
- Met à jour le charset.
- setHeaders() : void
- Met à jour le header.
- setResponse() : void
- Met à jour la réponse.
- setUrl() : void
- Met à jour l'URL.
- treatResponse() : null
- Va traiter le retour de l'exécution d'une requête afin d'en extraire les headers et la réponse.
Properties
$acceptedContentType
Contient les différents content-types acceptés en retour des requêtes envoyées par om_rest_client.
private
array<string|int, mixed>
$acceptedContentType
= array('application/xml' => 'xml', 'text/xml' => 'xml', 'application/json' => 'json', 'text/json' => 'json', 'application/html' => 'html', 'text/html' => 'html', 'application/pdf' => 'pdf', 'text/pdf' => 'pdf', 'text/plain' => 'plain', 'image/gif' => 'gif', 'image/jpeg' => 'jpeg', 'image/png' => 'png', 'application/base64' => 'base64')
$charset
Charset envoyé dans le header des requêtes HTTP.
private
string
$charset
$curl
Identifiant de session cURL.
private
string
$curl
$headers
Contenu des headers content_type et http_code.
private
array<string|int, mixed>
$headers
= array('content_type' => "", 'http_code' => "")
$max_log_size
Taille maximum allouée aux données du log en octets.
private
int
$max_log_size
= 500
$password
Password utilisé dans le contexte d'authentification HTTP Basic.
private
string
$password
$response
Contenu de la réponse de la requête REST.
private
array<string|int, mixed>
$response
= ""
$url
Adresse URL qui sera ciblée lors de l'appel à la fonction execute() si un autre URL n'est pas précisé lors de l'appel.
private
string
$url
$username
Username utilisé dans le contexte d'authentification HTTP Basic.
private
string
$username
Methods
__construct()
Constructeur
public
__construct(string $url[, string $username = "" ][, string $password = "" ]) : mixed
Parameters
- $url : string
-
URL cible des requêtes qui seront envoyées par cette instance d'om_rest_client.
- $username : string = ""
-
Optionnel : username en cas d'authentification basic.
- $password : string = ""
-
Optionnel : password en cas d'authentification basic.
Return values
mixed —__destruct()
Destructeur
public
__destruct() : mixed
Return values
mixed —clean_url()
Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .
public
clean_url(string $url) : string
..
Parameters
- $url : string
-
URL à nettoyer.
Return values
string —URL nettoyée
close()
Ferme la connexion curl
public
close() : void
Return values
void —execute()
Lance l'appel au webservice
public
execute(string $method, string $contentType, string $data[, string $url = null ][, array<string|int, mixed> $headers = array() ]) : Retourne
Parameters
- $method : string
-
Type de verbe HTTP (GET, POST, ...).
- $contentType : string
-
Contenu du header HTTP content-type.
- $data : string
-
Données à envoyer dans le cas d'un POST.
- $url : string = null
-
URL cible de la requête. null peut-être passé pour que l'URL défini lors de l'instanciation de la classe soit utilisé.
- $headers : array<string|int, mixed> = array()
-
Autres headers à passer dans la requête.
Return values
Retourne —la réponse du webservice ou -1 en cas d'erreur
getAcceptedContentType()
Accesseur de la donnée acceptedContentType
public
getAcceptedContentType() : array<string|int, mixed>
Return values
array<string|int, mixed> —getCharset()
Accesseur retournant le charset.
public
getCharset() : string
Return values
string —getCurl()
Accesseur de l'objet curl
public
getCurl() : object
Return values
object —getErrorMessage()
Accesseur du message d'erreur curl de l'instance courante
public
getErrorMessage() : string
Return values
string —getHeaders()
Accesseur de la donnée headers
public
getHeaders() : array<string|int, mixed>
Return values
array<string|int, mixed> —getMaxLogSize()
Accesseur retournant la taille maximum alloué aux données du log.
public
getMaxLogSize() : int
Return values
int —(en octets)
getResponse()
Accesseur de la donnée response
public
getResponse() : string
Return values
string —getResponseCode()
Accesseur du code HTTP défini dans la donnée headers
public
getResponseCode() : numeric-string|int|float
Return values
numeric-string|int|float —getResponseContentType()
Accesseur du content-type défini dans la donnée headers
public
getResponseContentType() : string
Return values
string —getUrl()
Accesseur de la donnée url
public
getUrl() : string
Return values
string —log()
Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .
public
log(string $message) : void
..
Parameters
- $message : string
-
Écriture de la chaîne de caractères passé en paramètre .
Return values
void —setAcceptedContentType()
Met à jour les types de contenu acceptés.
public
setAcceptedContentType(array<string|int, mixed> $acceptedContentType) : void
Parameters
- $acceptedContentType : array<string|int, mixed>
-
Setter de la donnée acceptedContentType qui est un tableau de valeur des différents contenus acceptés par la classe.
Return values
void —setCharset()
Met à jour le charset.
public
setCharset(string $charset) : void
Parameters
- $charset : string
-
Setter du charset envoyé dans le header des requêtes HTTP.
Return values
void —setHeaders()
Met à jour le header.
public
setHeaders(array<string|int, mixed> $headers) : void
Parameters
- $headers : array<string|int, mixed>
-
Tableau associatif de headers HTTP.
Return values
void —setResponse()
Met à jour la réponse.
public
setResponse(string $response) : void
Parameters
- $response : string
-
Réponse retournée par l'exécution de la requête.
Return values
void —setUrl()
Met à jour l'URL.
public
setUrl(string $url) : void
Parameters
- $url : string
-
URL qui sera ciblée par défaut lors d'un appel de la méthode execute si l'URL n'est pas passé lors l'appel.
Return values
void —treatResponse()
Va traiter le retour de l'exécution d'une requête afin d'en extraire les headers et la réponse.
private
treatResponse() : null