PHP Class JAXL, JAXL

Author: abhinavsingh

Inheritance: extends XMPPStream

Afficher le fichier Open project: jaxl/JAXL Class Usage Examples

Méthodes publiques

Свойство	Type	Description
$category
$cfg		cached init config array
$features		identity
$lang
$local_ip		env
$log_colorize
$log_dir
$log_level		path variables
$manage_roster		received presence information about the contacts
$manage_subscribe		"none" \| "accept" \| "mutual"
$mode
$pid
$pid_dir
$priv_dir
$retry		where k is a random number between 0 and 2^c - 1.
$roster	XMPPRosterItem[]	Local cache of roster list.
$sock_dir
$status		current status message
$tmp_dir
$type
$xeps		reference to various xep instance objects

Protected Properties

Свойство	Type	Description
$ev	JAXLEvent	Event callback engine for XMPP stream lifecycle.

Méthodes publiques

Méthode	Description
__construct ( array $config )
__destruct ( )
add_cb ( string $ev, callable $cb, integer $priority = 1 ) : string	Add callback.
del_cb ( $ref )
enable_unix_sock ( )
getTransport ( ) : JAXLClientBase
get_pid_file_path ( )
get_roster ( $cb = null )
get_scram_sha1_response ( $pass, $challenge )	http://tools.ietf.org/html/rfc5802#section-5
get_sock_file_path ( )
get_socket_path ( )
get_vcard ( $jid = null, $cb = null )
handle_auth_failure ( string $reason )
handle_auth_mechs ( $stanza, $mechanisms )
handle_auth_success ( )
handle_debug_shell ( $_raw )	security is all upto you, no checks made here
handle_domain_info ( $stanza )
handle_domain_items ( $stanza )
handle_iq ( $stanza )
handle_message ( $stanza )
handle_other ( $event, $args )	TODO: in a lot of cases this will be called, need more checks
handle_presence ( $stanza )
handle_stream_start ( $stanza )
on_unix_sock_accept ( $_c, $addr )	not for public consumption
on_unix_sock_request ( $_c, $_raw )	know what you are doing while in production
require_xep ( array $xeps )
retry ( )
send_chat_msg ( $to, $body, $thread = null, $subject = null )
set_status ( $status, $show = 'chat', $priority = 10 )
signal_handler ( integer $sig )	Signals callback handler.
start ( array $opts = [] )
subscribe ( $to )
subscribed ( $to )
unsubscribe ( $to )
unsubscribed ( $to )
wait_for_cram_md5_response ( $event, $args )	someday this needs to go inside xmpp stream
wait_for_scram_sha1_response ( $event, $args )

Méthodes protégées

Méthode	Description
enable_debug_shell ( )

Method Details

__construct() public méthode

public __construct ( array $config )
$config	array

__destruct() public méthode

public __destruct ( )

add_cb() public méthode

Add callback.

del_cb() public méthode

public del_cb ( $ref )

enable_debug_shell() protected méthode

protected enable_debug_shell ( )

enable_unix_sock() public méthode

public enable_unix_sock ( )

getTransport() public méthode

public getTransport ( ) : JAXLClientBase
Résultat	JAXLClientBase

get_pid_file_path() public méthode

public get_pid_file_path ( )

get_roster() public méthode

public get_roster ( $cb = null )

get_scram_sha1_response() public méthode

http://tools.ietf.org/html/rfc5802#section-5

public get_scram_sha1_response ( $pass, $challenge )

get_sock_file_path() public méthode

public get_sock_file_path ( )

get_socket_path() public méthode

public get_socket_path ( )

get_vcard() public méthode

public get_vcard ( $jid = null, $cb = null )

handle_auth_failure() public méthode

public handle_auth_failure ( string $reason )
$reason	string

handle_auth_mechs() public méthode

public handle_auth_mechs ( $stanza, $mechanisms )

handle_auth_success() public méthode

public handle_auth_success ( )

handle_debug_shell() public méthode

security is all upto you, no checks made here

public handle_debug_shell ( $_raw )

handle_domain_info() public méthode

public handle_domain_info ( $stanza )

handle_domain_items() public méthode

public handle_domain_items ( $stanza )

handle_iq() public méthode

public handle_iq ( $stanza )

handle_message() public méthode

public handle_message ( $stanza )

handle_other() public méthode

TODO: in a lot of cases this will be called, need more checks

public handle_other ( $event, $args )

handle_presence() public méthode

public handle_presence ( $stanza )

handle_stream_start() public méthode

public handle_stream_start ( $stanza )

on_unix_sock_accept() public méthode

not for public consumption

public on_unix_sock_accept ( $_c, $addr )

on_unix_sock_request() public méthode

know what you are doing while in production

public on_unix_sock_request ( $_c, $_raw )

require_xep() public méthode

public require_xep ( array $xeps )
$xeps	array

retry() public méthode

public retry ( )

send_chat_msg() public méthode

public send_chat_msg ( $to, $body, $thread = null, $subject = null )

set_status() public méthode

public set_status ( $status, $show = 'chat', $priority = 10 )

signal_handler() public méthode

Not for public API consumption.

public signal_handler ( integer $sig )
$sig	integer

start() public méthode

public start ( array $opts = [] )
$opts	array

subscribed() public méthode

public subscribed ( $to )

unsubscribe() public méthode

public unsubscribe ( $to )

unsubscribed() public méthode

public unsubscribed ( $to )

wait_for_cram_md5_response() public méthode

someday this needs to go inside xmpp stream

public wait_for_cram_md5_response ( $event, $args )

wait_for_scram_sha1_response() public méthode

public wait_for_scram_sha1_response ( $event, $args )

Property Details

$category public_oe property

public $category

$cfg public_oe property

cached init config array

public $cfg

$ev protected_oe property

Event callback engine for XMPP stream lifecycle.

protected JAXLEvent $ev
Résultat	JAXLEvent

$features public_oe property

identity

public $features

$lang public_oe property

public $lang

$local_ip public_oe property

env

public $local_ip

$log_colorize public_oe property

public $log_colorize

$log_dir public_oe property

public $log_dir

$log_level public_oe property

path variables

public $log_level

$manage_roster public_oe property

received presence information about the contacts

public $manage_roster

$manage_subscribe public_oe property

"none" | "accept" | "mutual"

public $manage_subscribe

$mode public_oe property

public $mode

$pid public_oe property

public $pid

$pid_dir public_oe property

public $pid_dir

$priv_dir public_oe property

public $priv_dir

$retry public_oe property

where k is a random number between 0 and 2^c - 1.

public $retry

$roster public_oe property

Local cache of roster list.

public XMPPRosterItem[] $roster
Résultat	XMPPRosterItem[]

$sock_dir public_oe property

public $sock_dir

$status public_oe property

current status message

public $status

$tmp_dir public_oe property

public $tmp_dir

$type public_oe property

public $type

$xeps public_oe property

reference to various xep instance objects

public $xeps

public add_cb ( string $ev, callable $cb, integer $priority = 1 ) : string
$ev	string	Event to subscribe.
$cb	callable
$priority	integer
Résultat	string