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

object_list_count

Summary

Fetches the number of objects that belong to certain section.

Usage

fetch( 'section', 'object_list_count',
        hash( 'section_id', section_id,							
            [ 'status',     status     ] ) )

Parameters

NameTypeDescriptionRequired
section_id integer The ID number of the target section. Yes.
status string The status of the target objects ('published' by default). No.

Returns

The number of objects (as an integer) that belong to the section.

Description

This function counts the number of objects that belong to a section specified by the "section_id" parameter. The optional "status" parameter works in the same way as in the "object_list" fetch function.

The function returns the count as an integer.

Examples

Example 1

{def $count=fetch( 'section', 'object_list_count',
                   hash( 'section_id', 13 ) )}
 
There are {$count} number of  objects in section number 13.

Outputs the number of published objects that belong to section number 13.

Example 2

{def $count=fetch( 'section', 'object_list_count',
                   hash( 'section_id', 5,
                         'status', 'archived' ) )}
 
There are {$count} number of archived objects in section number 5.

Outputs the number of objects that belong to section number 5 and are moved to the trash.

Balazs Halasy (04/10/2004 1:45 pm)

Julia Shymova (12/07/2007 11:58 am)


Comments

There are no comments.