HumHub Documentation (unofficial)

HumHubApiClient extends HttpClient
in package

HttpClient

Tags
since
1.5

Table of Contents

Constants

EVENT_AFTER_SEND  = 'afterSend'
EVENT_BEFORE_SEND  = 'beforeSend'
FORMAT_CURL  = 'curl'
CURL format
FORMAT_JSON  = 'json'
JSON format
FORMAT_RAW_URLENCODED  = 'raw-urlencoded'
urlencoded by PHP_QUERY_RFC3986 query string, like name1=value1&name2=value2
FORMAT_URLENCODED  = 'urlencoded'
urlencoded by RFC1738 query string, like name1=value1&name2=value2
FORMAT_XML  = 'xml'
XML format

Properties

$baseUrl  : mixed
$behaviors  : array<string|int, Behavior>
$contentLoggingMaxSize  : int
$formatters  : array<string|int, mixed>
$parsers  : array<string|int, mixed>
$requestConfig  : array<string|int, mixed>
$responseConfig  : array<string|int, mixed>
$transport  : Transport
$_behaviors  : array<string|int, Behavior>|null
$_events  : array<string|int, mixed>
$_eventWildcards  : array<string|int, mixed>
$_transport  : Transport|array<string|int, mixed>|string|callable

Methods

__call()  : mixed
Calls the named method which is not a class method.
__clone()  : mixed
This method is called after the object is created by cloning an existing one.
__construct()  : mixed
Constructor.
__get()  : mixed
Returns the value of a component property.
__isset()  : bool
Checks if a property is set, i.e. defined and not null.
__set()  : mixed
Sets the value of a component property.
__unset()  : mixed
Sets a component property to be null.
afterSend()  : mixed
This method is invoked right after request is sent.
attachBehavior()  : Behavior
Attaches a behavior to this component.
attachBehaviors()  : mixed
Attaches a list of behaviors to the component.
batchSend()  : array<string|int, Response>
Performs multiple HTTP requests in parallel.
beforeSend()  : mixed
This method is invoked right before request is sent.
behaviors()  : array<string|int, mixed>
Returns a list of behaviors that this component should behave as.
canGetProperty()  : bool
Returns a value indicating whether a property can be read.
canSetProperty()  : bool
Returns a value indicating whether a property can be set.
className()  : string
Returns the fully qualified name of this class.
createRequest()  : Request
createRequestLogToken()  : string
Composes the log/profiling message token for the given HTTP request parameters.
createResponse()  : Response
Creates a response instance.
delete()  : Request
Creates 'DELETE' request.
detachBehavior()  : Behavior|null
Detaches a behavior from the component.
detachBehaviors()  : mixed
Detaches all behaviors from the component.
ensureBehaviors()  : mixed
Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.
get()  : Request
Creates 'GET' request.
getBehavior()  : Behavior|null
Returns the named behavior object.
getBehaviors()  : array<string|int, Behavior>
Returns all behaviors attached to this component.
getFormatter()  : FormatterInterface
Returns HTTP message formatter instance for the specified format.
getParser()  : ParserInterface
Returns HTTP message parser instance for the specified format.
getTransport()  : Transport
hasEventHandlers()  : bool
Returns a value indicating whether there is any handler attached to the named event.
hasMethod()  : bool
Returns a value indicating whether a method is defined.
hasProperty()  : bool
Returns a value indicating whether a property is defined for this component.
head()  : Request
Creates 'HEAD' request.
init()  : mixed
Initializes the object.
off()  : bool
Detaches an existing event handler from this component.
on()  : mixed
Attaches an event handler to an event.
options()  : Request
Creates 'OPTIONS' request.
patch()  : Request
Creates 'PATCH' request.
post()  : Request
Creates 'POST' request.
put()  : Request
Creates 'PUT' request.
send()  : Response
Performs given request.
setTransport()  : mixed
Sets the HTTP message transport. It can be specified in one of the following forms:
trigger()  : mixed
Triggers an event.
createRequestShortcut()  : Request
attachBehaviorInternal()  : Behavior
Attaches a behavior to this component.

Constants

EVENT_AFTER_SEND

public mixed EVENT_AFTER_SEND = 'afterSend'
Tags
event

RequestEvent an event raised right after request has been sent.

EVENT_BEFORE_SEND

public mixed EVENT_BEFORE_SEND = 'beforeSend'
Tags
event

RequestEvent an event raised right before sending request.

FORMAT_CURL

CURL format

public mixed FORMAT_CURL = 'curl'
Tags
since
2.0.9

FORMAT_JSON

JSON format

public mixed FORMAT_JSON = 'json'

FORMAT_XML

XML format

public mixed FORMAT_XML = 'xml'

Properties

$behaviors read-only

public array<string|int, Behavior> $behaviors

List of behaviors attached to this component.

$contentLoggingMaxSize

public int $contentLoggingMaxSize = 2000

maximum symbols count of the request content, which should be taken to compose a log and profile messages. Exceeding content will be truncated.

Tags
see
createRequestLogToken()

$formatters

public array<string|int, mixed> $formatters = []

the formatters for converting data into the content of the specified [[format]]. The array keys are the format names, and the array values are the corresponding configurations for creating the formatter objects.

$parsers

public array<string|int, mixed> $parsers = []

the parsers for converting content of the specified [[format]] into the data. The array keys are the format names, and the array values are the corresponding configurations for creating the parser objects.

$requestConfig

public array<string|int, mixed> $requestConfig = []

request object configuration.

$responseConfig

public array<string|int, mixed> $responseConfig = []

response config configuration.

$transport

public Transport $transport

HTTP message transport instance. Note that the type of this property differs in getter and setter. See [[getTransport()]] and [[setTransport()]] for details.

$_behaviors

private array<string|int, Behavior>|null $_behaviors

the attached behaviors (behavior name => behavior). This is null when not initialized.

$_events

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

the attached event handlers (event name => handlers)

$_eventWildcards

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

the event handlers attached for wildcard patterns (event name wildcard => handlers)

Tags
since
2.0.14

$_transport

private Transport|array<string|int, mixed>|string|callable $_transport = 'yii\httpclient\StreamTransport'

HTTP message transport.

Methods

__call()

Calls the named method which is not a class method.

public __call(string $name, array<string|int, mixed> $params) : mixed

This method will check if any attached behavior has the named method and will execute it if available.

Do not call this method directly as it is a PHP magic method that will be implicitly called when an unknown method is being invoked.

Parameters
$name : string

the method name

$params : array<string|int, mixed>

method parameters

Tags
throws
UnknownMethodException

when calling unknown method

Return values
mixed —

the method return value

__clone()

This method is called after the object is created by cloning an existing one.

public __clone() : mixed

It removes all behaviors because they are attached to the old object.

__construct()

Constructor.

public __construct([array<string|int, mixed> $config = [] ]) : mixed

The default implementation does two things:

  • Initializes the object with the given configuration $config.
  • Call [[init()]].

If this method is overridden in a child class, it is recommended that

  • the last parameter of the constructor is a configuration array, like $config here.
  • call the parent implementation at the end of the constructor.
Parameters
$config : array<string|int, mixed> = []

name-value pairs that will be used to initialize the object properties

__get()

Returns the value of a component property.

public __get(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a getter: return the getter result
  • a property of a behavior: return the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $value = $component->property;.

Parameters
$name : string

the property name

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is write-only.

see
__set()
Return values
mixed —

the property value or the value of a behavior's property

__isset()

Checks if a property is set, i.e. defined and not null.

public __isset(string $name) : bool

This method will check in the following order and act accordingly:

  • a property defined by a setter: return whether the property is set
  • a property of a behavior: return whether the property is set
  • return false for non existing properties

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing isset($component->property).

Parameters
$name : string

the property name or the event name

Tags
see
https://www.php.net/manual/en/function.isset.php
Return values
bool —

whether the named property is set

__set()

Sets the value of a component property.

public __set(string $name, mixed $value) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value
  • an event in the format of "on xyz": attach the handler to the event "xyz"
  • a behavior in the format of "as xyz": attach the behavior named as "xyz"
  • a property of a behavior: set the behavior property value

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing $component->property = $value;.

Parameters
$name : string

the property name or the event name

$value : mixed

the property value

Tags
throws
UnknownPropertyException

if the property is not defined

throws
InvalidCallException

if the property is read-only.

see
__get()

__unset()

Sets a component property to be null.

public __unset(string $name) : mixed

This method will check in the following order and act accordingly:

  • a property defined by a setter: set the property value to be null
  • a property of a behavior: set the property value to be null

Do not call this method directly as it is a PHP magic method that will be implicitly called when executing unset($component->property).

Parameters
$name : string

the property name

Tags
throws
InvalidCallException

if the property is read only.

see
https://www.php.net/manual/en/function.unset.php

afterSend()

This method is invoked right after request is sent.

public afterSend(Request $request, Response $response) : mixed

The method will trigger the [[EVENT_AFTER_SEND]] event.

Parameters
$request : Request

request instance.

$response : Response

received response instance.

Tags
since
2.0.1

attachBehavior()

Attaches a behavior to this component.

public attachBehavior(string $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior

This method will create the behavior object based on the given configuration. After that, the behavior object will be attached to this component by calling the [[Behavior::attach()]] method.

Parameters
$name : string

the name of the behavior.

$behavior : string|array<string|int, mixed>|Behavior

the behavior configuration. This can be one of the following:

  • a [[Behavior]] object
  • a string specifying the behavior class
  • an object configuration array that will be passed to [[Yii::createObject()]] to create the behavior object.
Tags
see
detachBehavior()
Return values
Behavior —

the behavior object

attachBehaviors()

Attaches a list of behaviors to the component.

public attachBehaviors(array<string|int, mixed> $behaviors) : mixed

Each behavior is indexed by its name and should be a [[Behavior]] object, a string specifying the behavior class, or an configuration array for creating the behavior.

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

list of behaviors to be attached to the component

Tags
see
attachBehavior()

batchSend()

Performs multiple HTTP requests in parallel.

public batchSend(array<string|int, Request> $requests) : array<string|int, Response>

This method accepts an array of the [[Request]] objects and returns an array of the [[Response]] objects. Keys of the response array correspond the ones from request array.

$client = new Client();
$requests = [
    'news' => $client->get('http://domain.com/news'),
    'friends' => $client->get('http://domain.com/user/friends', ['userId' => 12]),
];
$responses = $client->batchSend($requests);
var_dump($responses['news']->isOk);
var_dump($responses['friends']->isOk);
Parameters
$requests : array<string|int, Request>

requests to perform.

Tags
throws
Exception
throws
InvalidConfigException
Return values
array<string|int, Response> —

responses list.

beforeSend()

This method is invoked right before request is sent.

public beforeSend(mixed $request) : mixed
Parameters
$request : mixed

request instance.

Tags
inheritDoc

behaviors()

Returns a list of behaviors that this component should behave as.

public behaviors() : array<string|int, mixed>

Child classes may override this method to specify the behaviors they want to behave as.

The return value of this method should be an array of behavior objects or configurations indexed by behavior names. A behavior configuration can be either a string specifying the behavior class or an array of the following structure:

'behaviorName' => [
    'class' => 'BehaviorClass',
    'property1' => 'value1',
    'property2' => 'value2',
]

Note that a behavior class must extend from [[Behavior]]. Behaviors can be attached using a name or anonymously. When a name is used as the array key, using this name, the behavior can later be retrieved using [[getBehavior()]] or be detached using [[detachBehavior()]]. Anonymous behaviors can not be retrieved or detached.

Behaviors declared in this method will be attached to the component automatically (on demand).

Return values
array<string|int, mixed> —

the behavior configurations.

canGetProperty()

Returns a value indicating whether a property can be read.

public canGetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be read if:

  • the class has a getter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a readable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canSetProperty()
Return values
bool —

whether the property can be read

canSetProperty()

Returns a value indicating whether a property can be set.

public canSetProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property can be written if:

  • the class has a setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a writable property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
Return values
bool —

whether the property can be written

className()

Returns the fully qualified name of this class.

public static className() : string
Tags
deprecated

since 2.0.14. On PHP >=5.5, use ::class instead.

Return values
string —

the fully qualified name of this class.

createRequestLogToken()

Composes the log/profiling message token for the given HTTP request parameters.

public createRequestLogToken(string $method, string $url, array<string|int, mixed> $headers, string $content) : string

This method should be used by transports during request sending logging.

Parameters
$method : string

request method name.

$url : string

request URL.

$headers : array<string|int, mixed>

request headers.

$content : string

request content.

Return values
string —

log token.

createResponse()

Creates a response instance.

public createResponse([string $content = null ][, array<string|int, mixed> $headers = [] ]) : Response
Parameters
$content : string = null

raw content

$headers : array<string|int, mixed> = []

headers list.

Tags
throws
InvalidConfigException
Return values
Response —

request instance.

delete()

Creates 'DELETE' request.

public delete(array<string|int, mixed>|string $url[, array<string|int, mixed>|string $data = null ][, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$data : array<string|int, mixed>|string = null

if array - request data, otherwise - request content.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

detachBehavior()

Detaches a behavior from the component.

public detachBehavior(string $name) : Behavior|null

The behavior's [[Behavior::detach()]] method will be invoked.

Parameters
$name : string

the behavior's name.

Return values
Behavior|null —

the detached behavior. Null if the behavior does not exist.

detachBehaviors()

Detaches all behaviors from the component.

public detachBehaviors() : mixed

ensureBehaviors()

Makes sure that the behaviors declared in [[behaviors()]] are attached to this component.

public ensureBehaviors() : mixed

get()

Creates 'GET' request.

public get(array<string|int, mixed>|string $url[, array<string|int, mixed>|string $data = null ][, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$data : array<string|int, mixed>|string = null

if array - request data, otherwise - request content.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

getBehavior()

Returns the named behavior object.

public getBehavior(string $name) : Behavior|null
Parameters
$name : string

the behavior name

Return values
Behavior|null —

the behavior object, or null if the behavior does not exist

getBehaviors()

Returns all behaviors attached to this component.

public getBehaviors() : array<string|int, Behavior>
Return values
array<string|int, Behavior> —

list of behaviors attached to this component

hasEventHandlers()

Returns a value indicating whether there is any handler attached to the named event.

public hasEventHandlers(string $name) : bool
Parameters
$name : string

the event name

Return values
bool —

whether there is any handler attached to the event.

hasMethod()

Returns a value indicating whether a method is defined.

public hasMethod(string $name[, bool $checkBehaviors = true ]) : bool

A method is defined if:

  • the class has a method with the specified name
  • an attached behavior has a method with the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkBehaviors : bool = true

whether to treat behaviors' methods as methods of this component

Return values
bool —

whether the method is defined

hasProperty()

Returns a value indicating whether a property is defined for this component.

public hasProperty(string $name[, bool $checkVars = true ][, bool $checkBehaviors = true ]) : bool

A property is defined if:

  • the class has a getter or setter method associated with the specified name (in this case, property name is case-insensitive);
  • the class has a member variable with the specified name (when $checkVars is true);
  • an attached behavior has a property of the given name (when $checkBehaviors is true).
Parameters
$name : string

the property name

$checkVars : bool = true

whether to treat member variables as properties

$checkBehaviors : bool = true

whether to treat behaviors' properties as properties of this component

Tags
see
canGetProperty()
see
canSetProperty()
Return values
bool —

whether the property is defined

head()

Creates 'HEAD' request.

public head(array<string|int, mixed>|string $url[, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

init()

Initializes the object.

public init() : mixed
Tags
inheritDoc

off()

Detaches an existing event handler from this component.

public off(string $name[, callable|null $handler = null ]) : bool

This method is the opposite of [[on()]].

Note: in case wildcard pattern is passed for event name, only the handlers registered with this wildcard will be removed, while handlers registered with plain names matching this wildcard will remain.

Parameters
$name : string

event name

$handler : callable|null = null

the event handler to be removed. If it is null, all handlers attached to the named event will be removed.

Tags
see
on()
Return values
bool —

if a handler is found and detached

on()

Attaches an event handler to an event.

public on(string $name, callable $handler[, mixed $data = null ][, bool $append = true ]) : mixed

The event handler must be a valid PHP callback. The following are some examples:

function ($event) { ... }         // anonymous function
[$object, 'handleClick']          // $object->handleClick()
['Page', 'handleClick']           // Page::handleClick()
'handleClick'                     // global function handleClick()

The event handler must be defined with the following signature,

function ($event)

where $event is an [[Event]] object which includes parameters associated with the event.

Since 2.0.14 you can specify event name as a wildcard pattern:

$component->on('event.group.*', function ($event) {
    Yii::trace($event->name . ' is triggered.');
});
Parameters
$name : string

the event name

$handler : callable

the event handler

$data : mixed = null

the data to be passed to the event handler when the event is triggered. When the event handler is invoked, this data can be accessed via [[Event::data]].

$append : bool = true

whether to append new event handler to the end of the existing handler list. If false, the new handler will be inserted at the beginning of the existing handler list.

Tags
see
off()

options()

Creates 'OPTIONS' request.

public options(array<string|int, mixed>|string $url[, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

patch()

Creates 'PATCH' request.

public patch(array<string|int, mixed>|string $url[, array<string|int, mixed>|string $data = null ][, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$data : array<string|int, mixed>|string = null

if array - request data, otherwise - request content.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

post()

Creates 'POST' request.

public post(array<string|int, mixed>|string $url[, array<string|int, mixed>|string $data = null ][, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$data : array<string|int, mixed>|string = null

if array - request data, otherwise - request content.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

put()

Creates 'PUT' request.

public put(array<string|int, mixed>|string $url[, array<string|int, mixed>|string $data = null ][, array<string|int, mixed> $headers = [] ][, array<string|int, mixed> $options = [] ]) : Request
Parameters
$url : array<string|int, mixed>|string

target URL.

$data : array<string|int, mixed>|string = null

if array - request data, otherwise - request content.

$headers : array<string|int, mixed> = []

request headers.

$options : array<string|int, mixed> = []

request options.

Return values
Request —

request instance.

setTransport()

Sets the HTTP message transport. It can be specified in one of the following forms:

public setTransport(Transport|array<string|int, mixed>|string $transport) : mixed
  • an instance of Transport: actual transport object to be used
  • a string: representing the class name of the object to be created
  • a configuration array: the array must contain a class element which is treated as the object class, and the rest of the name-value pairs will be used to initialize the corresponding object properties
  • a PHP callable: either an anonymous function or an array representing a class method ([$class or $object, $method]). The callable should return a new instance of the object being created.
Parameters
$transport : Transport|array<string|int, mixed>|string

HTTP message transport

trigger()

Triggers an event.

public trigger(string $name[, Event|null $event = null ]) : mixed

This method represents the happening of an event. It invokes all attached handlers for the event including class-level handlers.

Parameters
$name : string

the event name

$event : Event|null = null

the event instance. If not set, a default [[Event]] object will be created.

createRequestShortcut()

protected createRequestShortcut(string $method, array<string|int, mixed>|string $url, array<string|int, mixed>|string $data, array<string|int, mixed> $headers, array<string|int, mixed> $options) : Request
Parameters
$method : string
$url : array<string|int, mixed>|string
$data : array<string|int, mixed>|string
$headers : array<string|int, mixed>
$options : array<string|int, mixed>
Tags
throws
InvalidConfigException
Return values
Request —

request instance.

attachBehaviorInternal()

Attaches a behavior to this component.

private attachBehaviorInternal(string|int $name, string|array<string|int, mixed>|Behavior $behavior) : Behavior
Parameters
$name : string|int

the name of the behavior. If this is an integer, it means the behavior is an anonymous one. Otherwise, the behavior is a named one and any existing behavior with the same name will be detached first.

$behavior : string|array<string|int, mixed>|Behavior

the behavior to be attached

Return values
Behavior —

the attached behavior.


        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results