XMPPHP_XMPP Class Reference

Inheritance diagram for XMPPHP_XMPP:

Collaboration diagram for XMPPHP_XMPP:

Public Member Functions
	__construct ($host, $port, $user, $password, $resource, $server=null, $printlog=false, $loglevel=null)
	useEncryption ($useEncryption=true)
	autoSubscribe ($autoSubscribe=true)
	message ($to, $body, $type= 'chat', $subject=null, $payload=null)
	presence ($status=null, $show= 'available', $to=null, $type='available', $priority=0)
	subscribe ($jid)
	message_handler ($xml)
	presence_handler ($xml)
	getRoster ()
	getVCard ($jid=Null)
Data Fields
	$server
	$user
	$track_presence = true
	$roster
Protected Member Functions
	features_handler ($xml)
	sasl_success_handler ($xml)
	sasl_failure_handler ($xml)
	resource_bind_handler ($xml)
	roster_iq_handler ($xml)
	session_start_handler ($xml)
	tls_proceed_handler ($xml)
	vcard_get_handler ($xml)
Protected Attributes
	$password
	$resource
	$fulljid
	$basejid
	$authed = false
	$session_started = false
	$auto_subscribe = false
	$use_encryption = true

---

Detailed Description

Definition at line 44 of file XMPP.php.

---

Constructor & Destructor Documentation

__construct	(	$	host,
		$	port,
		$	user,
		$	password,
		$	resource,
		$	server = null,
		$	printlog = false,
		$	loglevel = null
	)

Constructor

Parameters:

string	$host
integer	$port
string	$user
string	$password
string	$resource
string	$server
boolean	$printlog
string	$loglevel

Reimplemented in XMPPHP_XMPPOld.

Definition at line 113 of file XMPP.php.

Here is the call graph for this function:

---

Member Function Documentation

autoSubscribe

(

$

autoSubscribe = true

)

Turn on auto-authorization of subscription requests.

Parameters:

boolean

$autoSubscribe

Definition at line 152 of file XMPP.php.

features_handler

(

$

xml

)

[protected]

Features handler

Parameters:

string

$xml

Definition at line 273 of file XMPP.php.

Here is the call graph for this function:

getRoster

(

)

Retrieves the roster

Definition at line 334 of file XMPP.php.

Here is the call graph for this function:

getVCard

(

$

jid = Null

)

Retrieves the vcard

Definition at line 400 of file XMPP.php.

Here is the call graph for this function:

message	(	$	to,
		$	body,
		$	type = 'chat',
		$	subject = null,
		$	payload = null
	)

Send XMPP Message

Parameters:

string	$to
string	$body
string	$type
string	$subject

Definition at line 164 of file XMPP.php.

Here is the call graph for this function:

message_handler

(

$

xml

)

Message handler

Parameters:

string

$xml

Definition at line 226 of file XMPP.php.

Here is the call graph for this function:

presence	(	$	status = null,
		$	show = 'available',
		$	to = null,
		$	type = 'available',
		$	priority = 0
	)

Set Presence

Parameters:

string	$status
string	$show
string	$to

Definition at line 190 of file XMPP.php.

Here is the call graph for this function:

presence_handler

(

$

xml

)

Presence handler

Parameters:

string

$xml

Definition at line 244 of file XMPP.php.

Here is the call graph for this function:

resource_bind_handler

(

$

xml

)

[protected]

Resource bind handler

Parameters:

string

$xml

Definition at line 318 of file XMPP.php.

Here is the call graph for this function:

roster_iq_handler

(

$

xml

)

[protected]

Roster iq handler Gets all packets matching XPath "iq/{jabber:iq:roster}query'

Parameters:

string

$xml

Definition at line 345 of file XMPP.php.

Here is the call graph for this function:

sasl_failure_handler

(

$

xml

)

[protected]

SASL feature handler

Parameters:

string

$xml

Definition at line 306 of file XMPP.php.

Here is the call graph for this function:

sasl_success_handler

(

$

xml

)

[protected]

SASL success handler

Parameters:

string

$xml

Definition at line 295 of file XMPP.php.

Here is the call graph for this function:

session_start_handler

(

$

xml

)

[protected]

Session start handler

Parameters:

string

$xml

Definition at line 379 of file XMPP.php.

Here is the call graph for this function:

subscribe

(

$

jid

)

Send Auth request

Parameters:

string

$jid

Definition at line 216 of file XMPP.php.

Here is the call graph for this function:

tls_proceed_handler

(

$

xml

)

[protected]

TLS proceed handler

Parameters:

string

$xml

Definition at line 390 of file XMPP.php.

Here is the call graph for this function:

useEncryption

(

$

useEncryption = true

)

Turn encryption on/ff

Parameters:

boolean

$useEncryption

Definition at line 143 of file XMPP.php.

vcard_get_handler

(

$

xml

)

[protected]

VCard retrieval handler

Parameters:

XML	Object $xml

Definition at line 415 of file XMPP.php.

Here is the call graph for this function:

---

Field Documentation

$authed = false [protected]

Definition at line 78 of file XMPP.php.

$auto_subscribe = false [protected]

Definition at line 84 of file XMPP.php.

$basejid [protected]

Definition at line 73 of file XMPP.php.

$fulljid [protected]

Definition at line 68 of file XMPP.php.

$password [protected]

Definition at line 58 of file XMPP.php.

$resource [protected]

Definition at line 63 of file XMPP.php.

$roster

Definition at line 99 of file XMPP.php.

$server

Definition at line 48 of file XMPP.php.

$session_started = false [protected]

Definition at line 79 of file XMPP.php.

$track_presence = true

Definition at line 94 of file XMPP.php.

$use_encryption = true [protected]

Definition at line 89 of file XMPP.php.

$user

Definition at line 53 of file XMPP.php.

---

The documentation for this class was generated from the following file:

• C:/xampp/htdocs/moodle/lib/jabber/XMPP/XMPP.php