Module result reference #

A module view returns an array, $Result; the kernel adds a few keys and hands it to the pagelayout as $module_result (see Module view templates). This page lists every key the kernel's views, eZModule::run() and ezpKernelWeb set, found by searching the kernel for $Result['...'] and $moduleResult['...']. The values in the examples are what content/view/full/96 returned on a development installation.

Contents #

1. Keys every view can set
2. Keys the kernel adds
3. Keys of content views
4. content_info
5. Keys of error results
6. Reading it in the pagelayout
7. Related pages

Keys every view can set #

Keys the kernel adds #

Keys of content views #

eZNodeviewfunctions::generateNodeViewData() (kernel/classes/eznodeviewfunctions.php) builds these for content/view:

content_info #

content_info lets the pagelayout know what the page shows without a fetch. All 25 keys, as a development installation returned them for node 96:

When the page comes from the content view cache, the kernel restores the same $Result from the cache file and sets the override keys again from content_info (eZNodeviewfunctions::contentViewRetrieve()), so content_info is available whether the page was cached or not.

Keys of error results #

A view that fails calls $Module->handleError(), which runs the error view (kernel/private/classes/views/error/view.php). On a development installation, content/view/full/99999999 returned:

errorType and errorNumber also become the override keys error_type and error_number, so error pages can have templates of their own (see Error templates).

Reading it in the pagelayout #

Not run on a development installation: $module_result exists only while the kernel renders a pagelayout for a web request, so this example cannot run in the CLI example renderer. The values it reads are the ones listed in the tables above, which came from running the view.

{* the class of the page, without fetching the node *}
{if is_set( $module_result.content_info )}
    <body class="class-{$module_result.content_info.class_identifier}">
{else}
    <body class="module-{$module_result.ui_component}">
{/if}

{* the breadcrumb *}
{foreach $module_result.path as $item}
    {if $item.url}<a href={cond( is_set( $item.url_alias ), $item.url_alias, $item.url )|ezurl}>{$item.text|wash}</a>{else}{$item.text|wash}{/if}
    {delimiter} / {/delimiter}
{/foreach}

{$module_result.content}

content_info exists only for content views: test it with is_set() in a pagelayout that also serves other modules.

Related pages #

• Module view templates
• View parameters
• The persistent variable, inside
• Module result and content info
• Breadcrumbs
• Free documentation: this page is free to copy, translate and improve under the GNU FDL 1.3.