Overview

Packages

  • Horde
    • Data
  • None
  • Turba

Classes

  • Turba
  • Turba_Api
  • Turba_Driver
  • Turba_Driver_Facebook
  • Turba_Driver_Favourites
  • Turba_Driver_Group
  • Turba_Driver_Imsp
  • Turba_Driver_Kolab
  • Turba_Driver_Ldap
  • Turba_Driver_Prefs
  • Turba_Driver_Share
  • Turba_Driver_Sql
  • Turba_Driver_Vbook
  • Turba_Exception
  • Turba_Factory_Driver
  • Turba_Form_AddContact
  • Turba_Form_Contact
  • Turba_Form_ContactBase
  • Turba_Form_CreateAddressBook
  • Turba_Form_DeleteAddressBook
  • Turba_Form_EditAddressBook
  • Turba_Form_EditContact
  • Turba_Form_EditContactGroup
  • Turba_List
  • Turba_LoginTasks_SystemTask_Upgrade
  • Turba_Object
  • Turba_Object_Group
  • Turba_Test
  • Turba_View_Browse
  • Turba_View_Contact
  • Turba_View_DeleteContact
  • Turba_View_Duplicates
  • Turba_View_EditContact
  • Turba_View_List
  • Overview
  • Package
  • Class
  • Tree

Class Turba_List

The Turba_List:: class provides an interface for dealing with a list of Turba_Objects.

Copyright 2000-2012 Horde LLC (http://www.horde.org/)

See the enclosed file LICENSE for license information (ASL). If you did did not receive this file, see http://www.horde.org/licenses/apache.

Turba_List implements Countable
Package: Turba
Category: Horde
License: ASL
Author: Chuck Hagenbuch chuck@horde.org
Author: Jon Parise jon@csh.rit.edu
Located at List.php
Methods summary
public
# __construct( array $ids = array() )

Constructor.

Constructor.

public
# insert( Turba_Object $object )

Inserts a new object into the list.

Inserts a new object into the list.

Parameters

$object
The object to insert.
public Turba_Object
# reset( )

Resets our internal pointer to the beginning of the list. Use this to hide the internal storage (array, list, etc.) from client objects.

Resets our internal pointer to the beginning of the list. Use this to hide the internal storage (array, list, etc.) from client objects.

Returns

Turba_Object
The next object in the list.
public Turba_Object
# next( )

Returns the next Turba_Object in the list. Use this to hide internal implementation details from client objects.

Returns the next Turba_Object in the list. Use this to hide internal implementation details from client objects.

Returns

Turba_Object
The next object in the list.
public
# sort( array $order = null )

Filters/Sorts the list based on the specified sort routine. The default sort order is by last name, ascending.

Filters/Sorts the list based on the specified sort routine. The default sort order is by last name, ascending.

Parameters

$order
<p>Array of hashes describing sort fields. Each hash has the following fields:</p> <pre>ascending - (boolean) <span class="php-keyword2">Sort</span> direction. field - (string) <span class="php-keyword2">Sort</span> field.</pre>
public
# count( )

Implementation of

Countable::count()
Properties summary
public array $objects

The array containing the Turba_Objects represented in this list.

The array containing the Turba_Objects represented in this list.

# array()
API documentation generated by ApiGen