view_top_list
Summary
Fetches the most popular (most viewed) nodes.
Usage
fetch( 'content', 'view_top_list',
hash( [ 'section_id', section_id, ]
[ 'class_id', class_id, ]
[ 'offset', offset, ]
[ 'limit', limit ] ) )Parameters
| Name | Type | Description | Required |
|---|---|---|---|
| section_id | integer | The ID number of the section. | No. |
| class_id | integer | The ID number of the class. | No. |
| offset | integer | The offset to start at. | No. |
| limit | integer | The number of nodes that should be returned. | No. |
Returns
An array of ezcontentobjecttreenode objects.
Description
This function fetches the most popular (most viewed) nodes. The function returns an array of ezcontentobjecttreenode objects. The "section_id" and "class_id" parameters can be used to filter out objects of certain type and/or objects that belong to a certain section. The "offset" and "limit" parameters can be used to limit the result.
In order to work, this function requires the use of the cronjob script. A part of this script will update the view counters of the nodes by analyzing the Apache log files. The "Scripts[]" array of a configuration override for "cronjob.ini" should include the "updateviewcount.php" script:
... Scripts[]=updateviewcount.php ...
In addition, the logfile settings in "logfile.ini" should match the syntax of the Apache log files.
Examples
Example 1
{def $popular_nodes=fetch( 'content', 'view_top_list',
hash( 'class_id', 2,
'limit', 10,
'offset', 0 ) )}
{foreach $popular_nodes as $popular_node}
{$popular_node.name|wash} <br />
{/foreach}Outputs the names of the ten most popular nodes that encapsulate objects of class number 2.
Contributors
- Balazs Halasy Updated
- Tofik Commenter
Comments (1 historical)
Written by readers of the earlier documentation sites, kept as they were.
View top list
Tofik ·
Is it possible to use parent_node_id instead of section_id as a filter? I tried that, but it gives me weird results