PHP Class Fabiang\Xmpp\Options

Afficher le fichier Open project: fabiang/xmpp Class Usage Examples

Protected Properties

Свойство Type Description
$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

Méthodes publiques

Méthode Description
__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.

Method Details

__construct() public méthode

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

getAddress() public méthode

Get server address.
public getAddress ( ) : string
Résultat string

getAuthenticationClasses() public méthode

Get authentication classes.
public getAuthenticationClasses ( ) : array
Résultat array

getConnection() public méthode

Get connection object.
public getConnection ( ) : Fabiang\Xmpp\Connection\ConnectionInterface
Résultat Fabiang\Xmpp\Connection\ConnectionInterface

getImplementation() public méthode

Get protocol implementation.
public getImplementation ( ) : Fabiang\Xmpp\Protocol\ImplementationInterface
Résultat Fabiang\Xmpp\Protocol\ImplementationInterface

getJid() public méthode

Get users jid.
public getJid ( ) : string
Résultat string

getLogger() public méthode

Get logger instance.
public getLogger ( ) : Psr\Log\LoggerInterface
Résultat Psr\Log\LoggerInterface

getPassword() public méthode

Get password.
public getPassword ( ) : string
Résultat string

getResource() public méthode

Get resource.
public getResource ( ) : string
Résultat string

getTimeout() public méthode

Get timeout for connection.
public getTimeout ( ) : integer
Résultat integer

getTo() public méthode

Get server name.
public getTo ( ) : string
Résultat string

getUsername() public méthode

Get username.
public getUsername ( ) : string
Résultat string

getUsers() public méthode

Get users.
public getUsers ( ) : Fabiang\Xmpp\Protocol\User\User[]
Résultat Fabiang\Xmpp\Protocol\User\User[]

isAuthenticated() public méthode

Is user authenticated.
public isAuthenticated ( ) : boolean
Résultat boolean

setAddress() public méthode

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() public méthode

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

setAuthenticationClasses() public méthode

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

setConnection() public méthode

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

setImplementation() public méthode

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

setJid() public méthode

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

setLogger() public méthode

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

setPassword() public méthode

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

setTimeout() public méthode

Set timeout for connection.
public setTimeout ( integer $timeout ) : Options
$timeout integer Seconds
Résultat Options

setTo() public méthode

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

setUsername() public méthode

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

setUsers() public méthode

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

Property Details

$address protected_oe property

protected string $address
Résultat string

$authenticated protected_oe property

protected bool $authenticated
Résultat boolean

$authenticationClasses protected_oe property

Authentication methods.
protected array $authenticationClasses
Résultat array

$connection protected_oe property

Connection object.
protected ConnectionInterface,Fabiang\Xmpp\Connection $connection
Résultat Fabiang\Xmpp\Connection\ConnectionInterface

$implementation protected_oe property

protected ImplementationInterface,Fabiang\Xmpp\Protocol $implementation
Résultat Fabiang\Xmpp\Protocol\ImplementationInterface

$jid protected_oe property

protected string $jid
Résultat string

$logger protected_oe property

PSR-3 Logger interface.
protected LoggerInterface,Psr\Log $logger
Résultat Psr\Log\LoggerInterface

$password protected_oe property

protected string $password
Résultat string

$timeout protected_oe property

Timeout for connection.
protected int $timeout
Résultat integer

$to protected_oe property

protected string $to
Résultat string

$username protected_oe property

protected string $username
Résultat string

$users protected_oe property

protected array $users
Résultat array