Path

7x / documentation / ez publish / technical manual / 3.7 / reference / modules / content / fetch functions / related_objects_count

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.

related_objects_count

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

NameTypeDescriptionRequired
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 boolean Controls whether to fetch all types of relations or not, 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.

Balazs Halasy (07/03/2006 11:56 am)

Balazs Halasy (01/04/2007 12:13 pm)

Comments