Yar_Client::setOpt

(PECL yar >= 1.0.0)

Yar_Client::setOptDéfinit les options du client

Description

public function Yar_Client::setOpt(int $name, mixed $value): Yar_Client|bool

Définit une option sur le client. Les options sont évaluées au moment où un appel est émis, elles peuvent donc être modifiées entre deux appels.

Liste de paramètres

name

L'une des constantes YAR_OPT_* :

value

La valeur de l'option. Une valeur invalide émet une alerte et fait retourner false à l'appel.

Valeurs de retour

Retourne l'objet client lui-même, ce qui permet une interface fluide, ou false si le nom de l'option est inconnu, si la valeur est invalide, ou si l'option ne s'applique pas au protocole avec lequel le client a été créé.

Erreurs / Exceptions

Les conditions qui font retourner false à l'appel émettent également une alerte :

  • YAR_OPT_HEADER, YAR_OPT_RESOLVE et YAR_OPT_PROXY ne fonctionnent qu'avec le protocole HTTP ; les utiliser avec un client tcp:// ou unix:// émet une alerte.

  • YAR_OPT_RESOLVE nécessite en outre libcurl >= 7.21.3.

  • Chaque option attend un type de valeur précis (chaîne, booléen, entier ou tableau), décrit sur la page des constantes.

Exemples

Exemple #1 Exemple avec Yar_Client::setOpt()

<?php

$client = new Yar_Client("http://api.example.com/operator.php");

/* Définit le délai d'expiration à 1s */
$client->setOpt(YAR_OPT_TIMEOUT, 1000);

/* Définit le packager à JSON */
$client->setOpt(YAR_OPT_PACKAGER, "json");

/* Définit des en-têtes personnalisés */
$client->setOpt(YAR_OPT_HEADER, ["X-Api-Key: value"]);

/* Passe par un proxy HTTP */
$client->setOpt(YAR_OPT_PROXY, "127.0.0.1:8888");

/* Appelle le service distant */
$result = $client->some_method("parameter");
?>

Voir aussi

add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top