Search moodle.org's
Developer Documentation

See Release Notes
Long Term Support Release

  • Bug fixes for general core bugs in 3.9.x will end* 10 May 2021 (12 months).
  • Bug fixes for security issues in 3.9.x will end* 8 May 2023 (36 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.
/lib/horde/framework/Horde/Imap/Client/ -> Ids.php (source)

[Source view]

Differences Between: [Versions 39 and 401] [Versions 39 and 402] [Versions 39 and 403]

Copyright 2011-2017 Horde LLC (http://www.horde.org/) See the enclosed file LICENSE for license information (LGPL). If you did not receive this file, see http://www.horde.org/licenses/lgpl21.

Copyright: 2011-2017 Horde LLC
License: http://www.horde.org/licenses/lgpl21 LGPL 2.1
File Size: 494 lines (12 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

Horde_Imap_Client_Ids:: (21 methods):
  __construct()
  __get()
  __toString()
  add()
  remove()
  isEmpty()
  reverse()
  sort()
  _sort()
  split()
  _resolveIds()
  _toSequenceString()
  _fromSequenceString()
  count()
  current()
  key()
  next()
  rewind()
  valid()
  serialize()
  unserialize()


Class: Horde_Imap_Client_Ids  - X-Ref

An object that provides a way to identify a list of IMAP indices.

__construct($ids = null, $sequence = false)   X-Ref
Constructor.

param: mixed $ids         See self::add().
param: boolean $sequence  Are $ids message sequence numbers?

__get($name)   X-Ref
No description

__toString()   X-Ref
No description

add($ids)   X-Ref
Add IDs to the current object.

param: mixed $ids  Either self::ALL, self::SEARCH_RES, self::LARGEST,

remove($ids)   X-Ref
Removed IDs from the current object.

param: mixed $ids  Either Horde_Imap_Client_Ids object, array, or

isEmpty()   X-Ref
Is this object empty (i.e. does not contain IDs)?

return: boolean  True if object is empty.

reverse()   X-Ref
Reverses the order of the IDs.


sort()   X-Ref
Sorts the IDs.


_sort(&$ids)   X-Ref
Sorts the IDs numerically.

param: array $ids  The array list.

split($length)   X-Ref
Split the sequence string at an approximate length.

param: integer $length  Length to split.
return: array  A list containing individual sequence strings.

_resolveIds($ids)   X-Ref
Resolve the $ids input to add() and remove().

param: mixed $ids  Either Horde_Imap_Client_Ids object, array, or
return: array  An array of IDs.

_toSequenceString($sort = true)   X-Ref
Create an IMAP message sequence string from a list of indices.

Index Format: range_start:range_end,uid,uid2,...

param: boolean $sort  Numerically sort the IDs before creating the
return: string  The IMAP message sequence string.

_fromSequenceString($str)   X-Ref
Parse an IMAP message sequence string into a list of indices.

param: string $str  The IMAP message sequence string.
return: array  An array of indices.

count()   X-Ref
No description

current()   X-Ref
No description

key()   X-Ref
No description

next()   X-Ref
No description

rewind()   X-Ref
No description

valid()   X-Ref
No description

serialize()   X-Ref
No description

unserialize($data)   X-Ref
No description