PHP Class rcrowe\Hippy\Transport\Guzzle

Inheritance: implements rcrowe\Hippy\Transport\TransportInterface

Mostra file Open project: rcrowe/hippy Class Usage Examples

Protected Properties

Property	Type	Description
$endpoint	string
$from	string
$headers	array
$http	Guzzle\Http\ClientInterface
$room	string \| integer
$token	string

Public Methods

Method	Description
__construct ( $token, $room, $from, $endpoint = 'https://api.hipchat.com/v1/' )
getEndpoint ( )
getFrom ( )
getHeaders ( )
getHttp ( ) : Guzzle\Http\ClientInterface	Get the instance of Guzzle used to send the message.
getRoom ( )
getToken ( )
send ( rcrowe\Hippy\Message\MessageInterface $message )
setEndpoint ( $endpoint )
setFrom ( $from )
setHeaders ( array $headers )
setHttp ( Guzzle\Http\ClientInterface $http ) : void	Set the instance of Guzzle used to send the message.
setRoom ( $room )
setToken ( $token )

Protected Methods

Method	Description
getUri ( ) : string	Uri of the request URL to the Hipchat API.

Method Details

__construct() public method

public __construct ( $token, $room, $from, $endpoint = 'https://api.hipchat.com/v1/' )

getEndpoint() public method

public getEndpoint ( )

getFrom() public method

public getFrom ( )

getHeaders() public method

public getHeaders ( )

getHttp() public method

Get the instance of Guzzle used to send the message.

public getHttp ( ) : Guzzle\Http\ClientInterface
return	Guzzle\Http\ClientInterface

getRoom() public method

public getRoom ( )

getToken() public method

public getToken ( )

getUri() protected method

Uri of the request URL to the Hipchat API.

protected getUri ( ) : string
return	string

send() public method

public send ( rcrowe\Hippy\Message\MessageInterface $message )
$message	rcrowe\Hippy\Message\MessageInterface

setEndpoint() public method

public setEndpoint ( $endpoint )

setFrom() public method

public setFrom ( $from )

setHeaders() public method

public setHeaders ( array $headers )
$headers	array

setHttp() public method

Set the instance of Guzzle used to send the message.

public setHttp ( Guzzle\Http\ClientInterface $http ) : void
$http	Guzzle\Http\ClientInterface
return	void

setRoom() public method

public setRoom ( $room )

setToken() public method

public setToken ( $token )

Property Details

$endpoint protected_oe property

protected string $endpoint
return	string

$from protected_oe property

protected string $from
return	string

$headers protected_oe property

protected array $headers
return	array

$http protected_oe property

protected ClientInterface,Guzzle\Http $http
return	Guzzle\Http\ClientInterface

$room protected_oe property

protected string\|int $room
return	string \| integer

$token protected_oe property

protected string $token
return	string