[ Index ]

PHP Cross Reference of moodle-2.8

title

Body

[close]

/lib/zend/Zend/Service/Technorati/ -> ResultSet.php (summary)

Zend Framework LICENSE

Copyright: Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
License: http://framework.zend.com/license/new-bsd New BSD License
Version: $Id$
File Size: 289 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 12 functions

  __construct()
  _init()
  totalResults()
  totalResultsAvailable()
  key()
  next()
  rewind()
  seek()
  valid()
  getXml()
  __sleep()
  __wakeup()

Functions
Functions that are not part of a class:

__construct(DomDocument $dom, $options = array()   X-Ref
Parses the search response and retrieves the results for iteration.

param: DomDocument $dom    the ReST fragment for this object
param: array $options      query options as associative array

_init(DomDocument $dom, $options = array()   X-Ref
Initializes this object from a DomDocument response.

Because __construct and __wakeup shares some common executions,
it's useful to group them in a single initialization method.
This method is called once each time a new instance is created
or a serialized object is unserialized.

param: DomDocument $dom the ReST fragment for this object
param: array $options   query options as associative array

totalResults()   X-Ref
Number of results returned.

return: int     total number of results returned

totalResultsAvailable()   X-Ref
Number of available results.

return: int     total number of available results

key()   X-Ref
Implements SeekableIterator::key().

return: int

next()   X-Ref
Implements SeekableIterator::next().

return: void

rewind()   X-Ref
Implements SeekableIterator::rewind().

return: bool

seek($index)   X-Ref
Implement SeekableIterator::seek().

param: int $index
return: void

valid()   X-Ref
Implement SeekableIterator::valid().

return: boolean

getXml()   X-Ref
Returns the response document as XML string.

return: string   the response document converted into XML format

__sleep()   X-Ref
Overwrites standard __sleep method to make this object serializable.

DomDocument and DOMXpath objects cannot be serialized.
This method converts them back to an XML string.

return: void

__wakeup()   X-Ref
Overwrites standard __wakeup method to make this object unserializable.

Restores object status before serialization.
Converts XML string into a DomDocument object and creates a valid
DOMXpath instance for given DocDocument.

return: void



Generated: Fri Nov 28 20:29:05 2014 Cross-referenced by PHPXref 0.7.1