<?php /* #?ini charset="utf-8"?

[ModuleSettings]
# Look for modules/<module>/module.php in this extension
ExtensionRepositories[]=expexample
# The known module names: keeps a URL alias from taking over the module's address
ModuleList[]=expexample

*/ ?>

<?php
/**
 * The expexample module: /expexample/list/<NodeID>[/offset/<n>] and /expexample/about.
 *
 * @copyright Copyright (C) 2026 Example Company
 * @license GNU General Public License v2.0 (or any later version)
 * @package expexample
 */

$Module = array( 'name' => 'Example',
                 'variable_params' => false );

$ViewList = array();

// /expexample/list/2, /expexample/list/2/offset/20: the children of a node, 10 a page
$ViewList['list'] = array(
    'script' => 'list.php',
    'functions' => array( 'read' ),
    'default_navigation_part' => 'ezcontentnavigationpart',
    'params' => array( 'NodeID' ),
    'unordered_params' => array( 'offset' => 'Offset' ) );

// /expexample/about: a page without parameters, for users with the policy expexample/about
$ViewList['about'] = array(
    'script' => 'about.php',
    'functions' => array( 'about' ),
    'params' => array() );

// The policy functions of the module, granted in Roles and policies.
// read takes a limitation by section: a role can allow the list of some sections only.
$SectionID = array(
    'name' => 'Section',
    'values' => array(),
    'class' => 'eZSection',
    'function' => 'fetchList',
    'parameter' => array( false ) );

$FunctionList = array();
$FunctionList['read'] = array( 'Section' => $SectionID );
$FunctionList['about'] = array();

<?php
/**
 * The view expexample/list: the children of a node the current user may read.
 *
 * @copyright Copyright (C) 2026 Example Company
 * @license GNU General Public License v2.0 (or any later version)
 * @package expexample
 */

$Module = $Params['Module'];
$nodeID = (int)$Params['NodeID'];
$offset = max( 0, (int)$Params['Offset'] );   // false when the address has no /offset/<n>
$limit  = 10;

$node = eZContentObjectTreeNode::fetch( $nodeID );
if ( !$node instanceof eZContentObjectTreeNode )
    return $Module->handleError( eZError::KERNEL_NOT_AVAILABLE, 'kernel' );
if ( !$node->canRead() )
    return $Module->handleError( eZError::KERNEL_ACCESS_DENIED, 'kernel' );

// The section limitation of expexample/read: the policy may allow some sections only
$access = eZUser::currentUser()->hasAccessTo( 'expexample', 'read' );
if ( $access['accessWord'] === 'limited' )
{
    $allowed = array();
    foreach ( $access['policies'] as $limitations )
    {
        if ( !isset( $limitations['Section'] ) )
        {
            $allowed = false;   // a policy without the limitation allows every section
            break;
        }
        $allowed = array_merge( $allowed, $limitations['Section'] );
    }
    if ( $allowed !== false && !in_array( $node->attribute( 'object' )->attribute( 'section_id' ), $allowed ) )
        return $Module->handleError( eZError::KERNEL_ACCESS_DENIED, 'kernel' );
}

$children = $node->subTree( array( 'Depth' => 1,
                                   'DepthOperator' => 'eq',
                                   'Offset' => $offset,
                                   'Limit' => $limit,
                                   'SortBy' => $node->sortArray() ) );

$tpl = eZTemplate::factory();
$tpl->setVariable( 'node', $node );
$tpl->setVariable( 'children', $children );
$tpl->setVariable( 'offset', $offset );
$tpl->setVariable( 'limit', $limit );
$tpl->setVariable( 'total', $node->subTreeCount( array( 'Depth' => 1, 'DepthOperator' => 'eq' ) ) );

$Result = array();
$Result['content'] = $tpl->fetch( 'design:expexample/list.tpl' );
$Result['path'] = array( array( 'text' => ezpI18n::tr( 'extension/expexample', 'Example list' ), 'url' => false ),
                         array( 'text' => $node->attribute( 'name' ), 'url' => false ) );

<?php
/**
 * The view expexample/about.
 *
 * @copyright Copyright (C) 2026 Example Company
 * @license GNU General Public License v2.0 (or any later version)
 * @package expexample
 */

$info = expexampleInfo::info();

$tpl = eZTemplate::factory();
$tpl->setVariable( 'version', $info['Version'] );

$Result = array();
$Result['content'] = $tpl->fetch( 'design:expexample/about.tpl' );
$Result['path'] = array( array( 'text' => ezpI18n::tr( 'extension/expexample', 'About the example' ), 'url' => false ) );

{* The view expexample/list. Variables: $node, $children, $offset, $limit, $total *}
<section class="expexample-list">
    <h1>{$node.name|wash}</h1>
    <p>{'%count items'|i18n( 'extension/expexample', '', hash( '%count', $total ) )}</p>
    <ul>
    {foreach $children as $child}
        <li>
            <a href={$child.url_alias|ezurl}>{$child.name|wash}</a>
            <span class="expexample-initials">{$child.name|exp_initials}</span>
        </li>
    {/foreach}
    </ul>
    <nav class="expexample-pages">
    {if $offset|gt( 0 )}
        <a href={concat( 'expexample/list/', $node.node_id, '/offset/', max( sub( $offset, $limit ), 0 ) )|ezurl}>{'Previous'|i18n( 'extension/expexample' )}</a>
    {/if}
    {if sum( $offset, $limit )|lt( $total )}
        <a href={concat( 'expexample/list/', $node.node_id, '/offset/', sum( $offset, $limit ) )|ezurl}>{'Next'|i18n( 'extension/expexample' )}</a>
    {/if}
    </nav>
</section>

{* The view expexample/about. Variables: $version *}
<section class="expexample-about">
    <h1>{'About the example'|i18n( 'extension/expexample' )}</h1>
    <p>{'Version %version'|i18n( 'extension/expexample', '', hash( '%version', $version|wash ) )}</p>
</section>