related_objects_count

Written by Balazs Halasy, 03/07/2006 Updated 04/01/2007 by Balazs Halasy

Summary

Fetches the number of related objects.

Usage

fetch( 'content', 'related_objects_count',
   hash( 'object_id',                object_id,
       [ 'attribute_identifier',     attribute_identifier,  ]
       [ 'all_relations',            boolean,               ] ) )

Parameters

Name	Type	Description	Required
object_id	integer	The ID number of the target object.	Yes.
attribute_identifier	mixed	The ID number or class/attribute identifier of the target attribute.	No.
all_relations	mixed	Controls what type of relations that should be feetched, default is FALSE.	No.

Returns

An integer (the number of related objects).

Description

This fetch function operates in almost the same way as the "related_objects" fetch function. The difference is that instead of returning the related objects themselves, it returns the count (the number of related objects that were found). The "related_objects_count" function takes the same parameters as the "related_objects" function with some exceptions (for example sorting is not supported). Please refer to the documentation of the "related_objects" function for a detailed description of the parameters.

Contributors

Balazs Halasy Author 03/07/2006 Updated 04/01/2007

Comments

Add a comment