\om_rest_client

Définition de la classe 'om_rest_client'.

Classe générique d'envoi de requêtes REST avec cURL.

Summary

Methods
Properties
Constants
__construct()
execute()
__destruct()
close()
getUrl()
getCurl()
getHeaders()
getResponse()
getResponseCode()
getResponseContentType()
getAcceptedContentType()
getErrorMessage()
setHeaders()
setUrl()
setResponse()
setAcceptedContentType()
setCharset()
getCharset()
getMaxLogSize()
clean_url()
log()
No public properties found
No constants found
No protected methods found
No protected properties found
N/A
treatResponse()
$url
$username
$password
$curl
$charset
$max_log_size
$headers
$response
$acceptedContentType
N/A

Properties

$url

$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.

Type

string

$username

$username : string

Username utilisé dans le contexte d'authentification HTTP Basic.

Type

string

$password

$password : string

Password utilisé dans le contexte d'authentification HTTP Basic.

Type

string

$curl

$curl : string

Identifiant de session cURL.

Type

string

$charset

$charset : string

Charset envoyé dans le header des requêtes HTTP.

Type

string

$max_log_size

$max_log_size : integer

Taille maximum allouée aux données du log en octets.

Type

integer

$headers

$headers : array

Contenu des headers content_type et http_code.

Type

array

$response

$response : array

Contenu de la réponse de la requête REST.

Type

array

$acceptedContentType

$acceptedContentType : array

Contient les différents content-types acceptés en retour des requêtes envoyées par om_rest_client.

Type

array

Methods

__construct()

__construct(string  $url, string  $username = "", string  $password = "") 

Constructeur

Parameters

string $url

URL cible des requêtes qui seront envoyées par cette instance d'om_rest_client.

string $username

Optionnel : username en cas d'authentification basic.

string $password

Optionnel : password en cas d'authentification basic.

execute()

execute(string  $method, string  $contentType, string  $data, string  $url = null, array  $headers = array()) : \Retourne

Lance l'appel au webservice

Parameters

string $method

Type de verbe HTTP (GET, POST, ...).

string $contentType

Contenu du header HTTP content-type.

string $data

Données à envoyer dans le cas d'un POST.

string $url

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é.

array $headers

Autres headers à passer dans la requête.

Returns

\Retourne —

la réponse du webservice ou -1 en cas d'erreur

__destruct()

__destruct() 

Destructeur

close()

close() : void

Ferme la connexion curl

getUrl()

getUrl() : string

Accesseur de la donnée url

Returns

string

getCurl()

getCurl() : object

Accesseur de l'objet curl

Returns

object

getHeaders()

getHeaders() : array

Accesseur de la donnée headers

Returns

array

getResponse()

getResponse() : string

Accesseur de la donnée response

Returns

string

getResponseCode()

getResponseCode() : \numeric

Accesseur du code HTTP défini dans la donnée headers

Returns

\numeric

getResponseContentType()

getResponseContentType() : string

Accesseur du content-type défini dans la donnée headers

Returns

string

getAcceptedContentType()

getAcceptedContentType() : array

Accesseur de la donnée acceptedContentType

Returns

array

getErrorMessage()

getErrorMessage() : string

Accesseur du message d'erreur curl de l'instance courante

Returns

string

setHeaders()

setHeaders(array  $headers) : void

Met à jour le header.

Parameters

array $headers

Tableau associatif de headers HTTP.

setUrl()

setUrl(string  $url) : void

Met à jour l'URL.

Parameters

string $url

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.

setResponse()

setResponse(string  $response) : void

Met à jour la réponse.

Parameters

string $response

Réponse retournée par l'exécution de la requête.

setAcceptedContentType()

setAcceptedContentType(array  $acceptedContentType) : void

Met à jour les types de contenu acceptés.

Parameters

array $acceptedContentType

Setter de la donnée acceptedContentType qui est un tableau de valeur des différents contenus acceptés par la classe.

setCharset()

setCharset(string  $charset) : void

Met à jour le charset.

Parameters

string $charset

Setter du charset envoyé dans le header des requêtes HTTP.

getCharset()

getCharset() : string

Accesseur retournant le charset.

Returns

string

getMaxLogSize()

getMaxLogSize() : integer

Accesseur retournant la taille maximum alloué aux données du log.

Returns

integer —

(en octets)

clean_url()

clean_url(string  $url) : string

Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .

..

Parameters

string $url

URL à nettoyer.

Returns

string —

URL nettoyée

log()

log(string  $message) : void

Nettoyer une URL des informations d'authentification HTTP en les remplaçant par .

..

Parameters

string $message

Écriture de la chaîne de caractères passé en paramètre .

treatResponse()

treatResponse() : null

Va traiter le retour de l'exécution d'une requête afin d'en extraire les headers et la réponse.

Returns

null