Caution: This documentation is for eZ Publish legacy, from version 3.x to 6.x.
For 5.x documentation covering Platform see eZ Documentation Center, for difference between legacy and Platform see 5.x Architecture overview.

item_list

Summary

Fetches the list of collaboration items

Usage

fetch( 'collaboration', 'item_list',
    hash(
       [ 'sort_by' , sort_by,                 ]
       [ 'limit' , limit,                     ]
       [ 'offset' , offset,                   ]
       [ 'status' , status,                   ]
       [ 'is_read' , is_read,                 ]
       [ 'is_active' , is_active,             ]
       [ 'parent_group_id' , parent_group_id, ]
    )
)
 

Parameters

NameTypeDescriptionRequired
sort_by array The sorting mechanism to use no
limit integer The number of items to return no
offset integer The offset to start at no
status array The status of the items to return no
is_read boolean The read status of the items to return no
is_active boolean The active status of the items to return no
parent_group_id integer The group id of the items no

Returns

An array of eZCollaborationItem.

Description

This function fetches the collaboration items that match the given parameters.

The available status (as integer) are:

  • 1 for active collaboration items
  • 2 for inactive collaboration items
  • 3 for archived collaboration items.

Examples

{fetch( "collaboration", "item_list",
       hash(
               "limit", 10,
               "offset", 0,
               "is_active", true(),
               "status", array( 1 )
        )
)}

Returns the first 10 active collaboration items.

Balazs Halasy (06/02/2004 12:30 pm)

Andrea Melo (16/09/2012 2:02 pm)

Balazs Halasy, Andrea Melo

Comments

There are no comments.