Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 3.10.x will end 8 November 2021 (12 months).
  • Bug fixes for security issues in 3.10.x will end 9 May 2022 (18 months).
  • PHP version: minimum PHP 7.2.0 Note: minimum PHP version has increased since Moodle 3.8. PHP 7.3.x and 7.4.x are supported too.

Differences Between: [Versions 39 and 310]

XMPPHP: The PHP XMPP Library Copyright (C) 2008  Nathanael C. Fritz This file is part of SleekXMPP. XMPPHP is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

Author: Nathanael C. Fritz fritzy@netflint.net>
Author: Stephan Wentz stephan@jabber.wentz.it>
Author: Michael Garvin gar@netflint.net>
Author: Alexander Birkner (https://github.com/BirknerAlex)
Copyright: 2008 Nathanael C. Fritz
File Size: 848 lines (21 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

XMLStream:: (30 methods):
  __construct()
  __destruct()
  getLog()
  getId()
  useSSL()
  addIdHandler()
  addHandler()
  addXPathHandler()
  addEventHandler()
  connect()
  doReconnect()
  setReconnectTimeout()
  disconnect()
  isDisconnected()
  bufferComplete()
  __process()
  process()
  processTime()
  processUntil()
  Xapply_socket()
  startXML()
  endXML()
  charXML()
  event()
  read()
  send()
  time()
  reset()
  setupParser()
  readyToProcess()


Class: XMLStream  - X-Ref

XMPPHP Main Class

__construct($host = null, $port = null, $printlog = false, $loglevel = null, $is_server = false)   X-Ref
Constructor

param: string  $host
param: string  $port
param: boolean $printlog
param: string  $loglevel
param: boolean $is_server

__destruct()   X-Ref
Destructor
Cleanup connection


getLog()   X-Ref
Return the log instance

return: Log

getId()   X-Ref
Get next ID

return: integer

useSSL($use=true)   X-Ref
Set SSL

return: integer

addIdHandler($id, $pointer, $obj = null)   X-Ref
Add ID Handler

param: integer $id
param: string  $pointer
param: string  $obj

addHandler($name, $ns, $pointer, $obj = null, $depth = 1)   X-Ref
Add Handler

param: string $name
param: string  $ns
param: string  $pointer
param: string  $obj
param: integer $depth

addXPathHandler($xpath, $pointer, $obj = null)   X-Ref
Add XPath Handler

param: string $xpath
param: string $pointer
param:

addEventHandler($name, $pointer, $obj)   X-Ref
Add Event Handler

param: integer $id
param: string  $pointer
param: string  $obj

connect($timeout = 30, $persistent = false, $sendinit = true)   X-Ref
Connect to XMPP Host

param: integer $timeout    Timeout in seconds
param: boolean $persistent
param: boolean $sendinit   Send XMPP starting sequence after connect

doReconnect()   X-Ref
Reconnect XMPP Host


setReconnectTimeout($timeout)   X-Ref
No description

disconnect()   X-Ref
Disconnect from XMPP Host


isDisconnected()   X-Ref
Are we are disconnected?

return: boolean

bufferComplete($buff)   X-Ref
Checks if the given string is closed with the same tag as it is
opened. We try to be as fast as possible here.

param: string $buff Read buffer of __process()
return: boolean true if the buffer seems to be complete

__process($maximum = 5, $return_when_received = false)   X-Ref
Core reading tool

param: mixed   $maximum Limit when to return
param: boolean $return_when_received Immediately return when data have been
return: boolean True when all goes well, false when something fails

process()   X-Ref
Process

return: string

processTime($timeout=NULL)   X-Ref
Process until a timeout occurs

param: integer $timeout Time in seconds
return: string

processUntil($event, $timeout = -1)   X-Ref
Process until a specified event or a timeout occurs

param: string|array $event   Event name or array of event names
param: integer      $timeout Timeout in seconds
return: array Payload

Xapply_socket($socket)   X-Ref
Obsolete?


startXML($parser, $name, $attr)   X-Ref
XML start callback

param: resource $parser
param: string   $name

endXML($parser, $name)   X-Ref
XML end callback

param: resource $parser
param: string   $name

charXML($parser, $data)   X-Ref
XML character callback

param: resource $parser
param: string   $data

event($name, $payload = null)   X-Ref
Event?

param: string $name
param: string $payload

read()   X-Ref
Read from socket


send($msg, $timeout=NULL)   X-Ref
Send to socket

param: string $msg

time()   X-Ref
No description

reset()   X-Ref
Reset connection


setupParser()   X-Ref
Setup the XML parser


readyToProcess()   X-Ref
No description