PHP Класс Fabiang\Xmpp\Options

Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство Тип Описание
$address string
$authenticated boolean
$authenticationClasses array Authentication methods.
$connection Fabiang\Xmpp\Connection\ConnectionInterface Connection object.
$implementation Fabiang\Xmpp\Protocol\ImplementationInterface
$jid string
$logger Psr\Log\LoggerInterface PSR-3 Logger interface.
$password string
$timeout integer Timeout for connection.
$to string
$username string
$users array

Открытые методы

Метод Описание
__construct ( string $address = null ) Constructor.
getAddress ( ) : string Get server address.
getAuthenticationClasses ( ) : array Get authentication classes.
getConnection ( ) : Fabiang\Xmpp\Connection\ConnectionInterface Get connection object.
getImplementation ( ) : Fabiang\Xmpp\Protocol\ImplementationInterface Get protocol implementation.
getJid ( ) : string Get users jid.
getLogger ( ) : Psr\Log\LoggerInterface Get logger instance.
getPassword ( ) : string Get password.
getResource ( ) : string Get resource.
getTimeout ( ) : integer Get timeout for connection.
getTo ( ) : string Get server name.
getUsername ( ) : string Get username.
getUsers ( ) : Fabiang\Xmpp\Protocol\User\User[] Get users.
isAuthenticated ( ) : boolean Is user authenticated.
setAddress ( string $address ) Set server address.
setAuthenticated ( boolean $authenticated ) Set authenticated.
setAuthenticationClasses ( array $authenticationClasses )
setConnection ( Fabiang\Xmpp\Connection\ConnectionInterface $connection ) Set connection object.
setImplementation ( Fabiang\Xmpp\Protocol\ImplementationInterface $implementation ) Set protocol implementation.
setJid ( string $jid ) Set users jid.
setLogger ( Psr\Log\LoggerInterface $logger ) Set logger instance.
setPassword ( string $password ) Set password.
setTimeout ( integer $timeout ) : Options Set timeout for connection.
setTo ( string $to ) Set server name.
setUsername ( string $username ) Set username.
setUsers ( array $users ) Set users.

Описание методов

__construct() публичный Метод

Constructor.
public __construct ( string $address = null )
$address string Server address

getAddress() публичный Метод

Get server address.
public getAddress ( ) : string
Результат string

getAuthenticationClasses() публичный Метод

Get authentication classes.
public getAuthenticationClasses ( ) : array
Результат array

getConnection() публичный Метод

Get connection object.
public getConnection ( ) : Fabiang\Xmpp\Connection\ConnectionInterface
Результат Fabiang\Xmpp\Connection\ConnectionInterface

getImplementation() публичный Метод

Get protocol implementation.
public getImplementation ( ) : Fabiang\Xmpp\Protocol\ImplementationInterface
Результат Fabiang\Xmpp\Protocol\ImplementationInterface

getJid() публичный Метод

Get users jid.
public getJid ( ) : string
Результат string

getLogger() публичный Метод

Get logger instance.
public getLogger ( ) : Psr\Log\LoggerInterface
Результат Psr\Log\LoggerInterface

getPassword() публичный Метод

Get password.
public getPassword ( ) : string
Результат string

getResource() публичный Метод

Get resource.
public getResource ( ) : string
Результат string

getTimeout() публичный Метод

Get timeout for connection.
public getTimeout ( ) : integer
Результат integer

getTo() публичный Метод

Get server name.
public getTo ( ) : string
Результат string

getUsername() публичный Метод

Get username.
public getUsername ( ) : string
Результат string

getUsers() публичный Метод

Get users.
public getUsers ( ) : Fabiang\Xmpp\Protocol\User\User[]
Результат Fabiang\Xmpp\Protocol\User\User[]

isAuthenticated() публичный Метод

Is user authenticated.
public isAuthenticated ( ) : boolean
Результат boolean

setAddress() публичный Метод

When a address is passed this setter also calls setTo with the hostname part of the address.
public setAddress ( string $address )
$address string Server address

setAuthenticated() публичный Метод

Set authenticated.
public setAuthenticated ( boolean $authenticated )
$authenticated boolean Flag

setAuthenticationClasses() публичный Метод

public setAuthenticationClasses ( array $authenticationClasses )
$authenticationClasses array Authentication classes

setConnection() публичный Метод

Set connection object.
public setConnection ( Fabiang\Xmpp\Connection\ConnectionInterface $connection )
$connection Fabiang\Xmpp\Connection\ConnectionInterface

setImplementation() публичный Метод

Set protocol implementation.
public setImplementation ( Fabiang\Xmpp\Protocol\ImplementationInterface $implementation )
$implementation Fabiang\Xmpp\Protocol\ImplementationInterface

setJid() публичный Метод

Set users jid.
public setJid ( string $jid )
$jid string

setLogger() публичный Метод

Set logger instance.
public setLogger ( Psr\Log\LoggerInterface $logger )
$logger Psr\Log\LoggerInterface PSR-3 Logger

setPassword() публичный Метод

Set password.
public setPassword ( string $password )
$password string

setTimeout() публичный Метод

Set timeout for connection.
public setTimeout ( integer $timeout ) : Options
$timeout integer Seconds
Результат Options

setTo() публичный Метод

This value is send to the server in requests as to="" attribute.
public setTo ( string $to )
$to string

setUsername() публичный Метод

Set username.
public setUsername ( string $username )
$username string

setUsers() публичный Метод

Set users.
public setUsers ( array $users )
$users array User list

Описание свойств

$address защищенное свойство

protected string $address
Результат string

$authenticated защищенное свойство

protected bool $authenticated
Результат boolean

$authenticationClasses защищенное свойство

Authentication methods.
protected array $authenticationClasses
Результат array

$connection защищенное свойство

Connection object.
protected ConnectionInterface,Fabiang\Xmpp\Connection $connection
Результат Fabiang\Xmpp\Connection\ConnectionInterface

$implementation защищенное свойство

protected ImplementationInterface,Fabiang\Xmpp\Protocol $implementation
Результат Fabiang\Xmpp\Protocol\ImplementationInterface

$jid защищенное свойство

protected string $jid
Результат string

$logger защищенное свойство

PSR-3 Logger interface.
protected LoggerInterface,Psr\Log $logger
Результат Psr\Log\LoggerInterface

$password защищенное свойство

protected string $password
Результат string

$timeout защищенное свойство

Timeout for connection.
protected int $timeout
Результат integer

$to защищенное свойство

protected string $to
Результат string

$username защищенное свойство

protected string $username
Результат string

$users защищенное свойство

protected array $users
Результат array