list_count

Written by Balazs Halasy, 02/06/2004 Updated 04/29/2005 by Balazs Halasy

Summary

Fetches the number of children of a node.

Usage

fetch( 'content', 'list_count',
       hash( 'parent_node_id',     parent_node_id,
           [ 'class_filter_type',  class_filter_type,  ]
           [ 'class_filter_array', class_filter_array, ]
           [ 'attribute_filter',   attribute_filter,   ]
           [ 'main_node_only',     main_node_only,     ] ) )

Parameters

Name	Type	Description	Required
parent_node_id	integer	The ID number of the parent node.	Yes.
class_filter_type	string	The type of class filtering (include/exclude).	No.
class_filter_array	array	The classes that should be filtered.	No.
attribute_filter	mixed	Filter logic for attribute level filtering.	No.
main_node_only	integer	Type of nodes that should be fetched (all or main nodes only).	No.

Returns

An integer (the number of nodes).

Description

This function operates in almost the same way as the "list" fetch function. The difference is that instead of returning the actual nodes, it returns the count (the number of nodes that were found). The "list_count" function takes the same parameters as the "list" function with some exceptions (sorting, grouping, limit/offset, etc. is not supported). Please refer to the documentation of the "list" function for a detailed description of the parameters.

Examples

Example 1

{def $count=fetch( 'content', 'list_count', hash( 'parent_node_id', 42 ) )}
Node number 42 has {$count} number of children.

Outputs the number of nodes that are below node number 42.

Contributors

Balazs Halasy Author 02/06/2004 Updated 04/29/2005
vytis Commenter 05/29/2006
Clemens Commenter 07/29/2009

Comments (2 historical)

Written by readers of the earlier documentation sites, kept as they were.

is [ 'extended_attribute_filter', extended_attribute_filter, ] missing?

vytis · 05/29/2006 10:50 am

is [ 'extended_attribute_filter', extended_attribute_filter, ] mising, or it is not possible to use it in count?
1. Re: is [ 'extended_attribute_filter', extended_attribute_filter, ] missing?
  
  Clemens · 07/29/2009 01:20 pm
  
  I've tried it, and it seems not to be possible. What you could do is |count(); the number of objects you fetched, and if these are limited by using offset or limit, you might consider re-doing the fetch with extended-attribute-filter and without the offset and limit parameters, and then applying |count()....

Comments

Add a comment