PHP Class Fabiang\Xmpp\Options

Datei anzeigen Open project: fabiang/xmpp Class Usage Examples

Protected Properties

Property 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

Public Methods

Method 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 method

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

getAddress() public method

Get server address.
public getAddress ( ) : string
return string

getAuthenticationClasses() public method

Get authentication classes.
public getAuthenticationClasses ( ) : array
return array

getConnection() public method

Get connection object.
public getConnection ( ) : Fabiang\Xmpp\Connection\ConnectionInterface
return Fabiang\Xmpp\Connection\ConnectionInterface

getImplementation() public method

Get protocol implementation.
public getImplementation ( ) : Fabiang\Xmpp\Protocol\ImplementationInterface
return Fabiang\Xmpp\Protocol\ImplementationInterface

getJid() public method

Get users jid.
public getJid ( ) : string
return string

getLogger() public method

Get logger instance.
public getLogger ( ) : Psr\Log\LoggerInterface
return Psr\Log\LoggerInterface

getPassword() public method

Get password.
public getPassword ( ) : string
return string

getResource() public method

Get resource.
public getResource ( ) : string
return string

getTimeout() public method

Get timeout for connection.
public getTimeout ( ) : integer
return integer

getTo() public method

Get server name.
public getTo ( ) : string
return string

getUsername() public method

Get username.
public getUsername ( ) : string
return string

getUsers() public method

Get users.
public getUsers ( ) : Fabiang\Xmpp\Protocol\User\User[]
return Fabiang\Xmpp\Protocol\User\User[]

isAuthenticated() public method

Is user authenticated.
public isAuthenticated ( ) : boolean
return boolean

setAddress() public method

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 method

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

setAuthenticationClasses() public method

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

setConnection() public method

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

setImplementation() public method

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

setJid() public method

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

setLogger() public method

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

setPassword() public method

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

setTimeout() public method

Set timeout for connection.
public setTimeout ( integer $timeout ) : Options
$timeout integer Seconds
return Options

setTo() public method

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

setUsername() public method

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

setUsers() public method

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

Property Details

$address protected_oe property

protected string $address
return string

$authenticated protected_oe property

protected bool $authenticated
return boolean

$authenticationClasses protected_oe property

Authentication methods.
protected array $authenticationClasses
return array

$connection protected_oe property

Connection object.
protected ConnectionInterface,Fabiang\Xmpp\Connection $connection
return Fabiang\Xmpp\Connection\ConnectionInterface

$implementation protected_oe property

protected ImplementationInterface,Fabiang\Xmpp\Protocol $implementation
return Fabiang\Xmpp\Protocol\ImplementationInterface

$jid protected_oe property

protected string $jid
return string

$logger protected_oe property

PSR-3 Logger interface.
protected LoggerInterface,Psr\Log $logger
return Psr\Log\LoggerInterface

$password protected_oe property

protected string $password
return string

$timeout protected_oe property

Timeout for connection.
protected int $timeout
return integer

$to protected_oe property

protected string $to
return string

$username protected_oe property

protected string $username
return string

$users protected_oe property

protected array $users
return array