eZpedia : Learning

eZ Publish Security

Tue, 21 Aug 2012 08:33:35 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

For a general description of security, we recommend Computer security on Wikipedia.

eZ publish is very secure! The U.S Department of Defense uses eZ publish!

Securing eZ publish

eZ Publish Security Advisories

eZ Publish Security Advisories ( https://share.ez.no/community-project/security-advisories ) - keeping your eZ Publish installation up-to-date with the latest release and security patches is a good way to ensure the underlying code base is stable & secure.

File Permissions

"Also in productive environments the extension directory should not be any longer writeable to apache cause of security." -- [email protected]

Installation directory permission
File storage settings in site.ini.append.php , for cache/image files within the var directory:

span style="background-color: yellow;"> [FileSettings]
StorageFilePermissions=664
StorageDirPermissions=775
LogFilePermissions=660

Web server user/group should only be on var/, unless making template/ini changes via admin interface.

Database Permissions

Use a separate user for each eZ publish installation
Reduce user database server permissions to minimum.
- Forum: MySQL Database Privileges Required

Module view security

There are several module views are available to anonymous users by default which can expose information about your software and website:

ezinfo/about contains the version of eZ Publish, and all extensions used by your website, as well as information about copyright, license, contributors, etc.
content/browse can allow a user to explore the node structure of your site, to access information which is not linked on your site.
user/register, user/activate, user/success, and user/forgotpassword can also be disabled if you don't need user registration on the front-end, to prevent spammers clogging up your system, or people accidentally using it

There are several ways to disable these module views for anonymous users - both are by changing settings in site.ini:

Remove if from [RoleSettings] PolicyOmitList (require policy access)
Add it to [SiteAccessRules] Rules disable list (disable it totally)

PolicyOmitList

You can reset the site.ini:[RoleSettings] PolicyOmitList array with a settings override to exclude the module entirely thus preventing it's use and index from other external sources (engines, bots, etc)

Here is an example from a settings/override/site.ini.append.php file:

span style="background-color: yellow;"> [RoleSettings]
PolicyOmitList[]
PolicyOmitList[]=user/login
PolicyOmitList[]=user/logout
PolicyOmitList[]=user/register
PolicyOmitList[]=user/activate
PolicyOmitList[]=user/success
PolicyOmitList[]=user/forgotpassword
PolicyOmitList[]=layout
PolicyOmitList[]=manual
# PolicyOmitList[]=ezinfo
PolicyOmitList[]=paypal/notify_url
PolicyOmitList[]=switchlanguage

You might choose for example to leave this enabled in development settings while disabled directly in production settings.

You could also add a new user group and coresponding new role for that group called say 'Developers' and within the role add a policy for ezinfo module and the read function. Save and clear caches. Now all developer group users can use ezinfo and everyone else gets access denied errors instead.

SiteAccessRules

If you want to completely disable a module view so no-one can use it, you can reset the site.ini:[SiteAccessRules] Rules array with a settings override, e.g:

span style="background-color: yellow;"> [SiteAccessRules]
Rules[]
Rules[]=access;enable
Rules[]=module;all
Rules[]=access;disable
Rules[]=module;ezinfo/about
Rules[]=module;content/browse

HTTP Headers

eZ Publish adds an HTTP header "X-Powered-By: eZ Publish" - you can override this.

In eZ Publish 4.7 you can change a setting in config.php:

&nbsp;/*** Enable usage of "X-Powered-By" headers.
* Optional. Defaults to true.
*/
define( 'CLUSTER_HEADER_X_POWERED_BY', false );

In eZ Publish 4.6 & below, in your settings/override/site.ini.append.php file by adding the following (and while we're at it, let's turn off the webserver identifier):

span style="background-color: yellow;"> [HTTPHeaderSettings]
# Enable/disable custom HTTP header data.
CustomHeader=enabled
 
# Only apply custom headers for anonymous users&nbsp;
OnlyForAnonymous=enabled
 
# Header list. Contains all HTTP which should override standard ones.
HeaderList[]
HeaderList[]=X-Powered-By
HeaderList[]=Server
 
X-Powered-By[]
X-Powered-By[/]= 
 
Server[]
Server[/]=

eZ publish Administration

Browser security

SSL

Use an browser and web server which supports ssl/https. Require all login and admin usage use ssl.
The use of ssl protects the clear text information (username and password) during transmission.

ACL

Use an httpd browser based authentication realm to protect eZ publish
The use of two forms of authentication, ACL and eZ reduces greatly the chance someone can compromise eZ publish

eZ publish Users, Groups, Roles and Permissions

Do not use the 'admin' user. This is similar to the unix-like operating system's rule to use a non-privileged user as much as possible.
If you need more permissions, create a group called say 'ez-admin', and add a new user 'eza-john' to the group. Add permissions as needed to your group/user roles.

Example #1 - Email Abuse

Security related topics

External resources

Guide to becoming fluent in eZ

Fri, 31 Dec 2010 10:20:07 GMT

Introduction

You desire to know this beast that is eZ
You don't know where to start
You know you must act

eZ publish is not intended for the faint of heart by any means. eZ publish is a challenge for many while for others it is a natural extension of one's own 'way' of solving complex software problems. eZ publish rewards people who stick to their studies in eZ publish, scale upwards in their ability to comprehend and develop withing complex software designs used in eZ publish.

Roles

eZ publish web site end user - Responsibility: n/a
eZ publish content editor - Responsibility: Installation content creation and modification
eZ publish administrator - Responsibility: Entire eZ system
eZ publish template developer - Responsibility: Extend and modify eZ templates to meet needs
eZ publish developer - Responsibility: Extend and modify eZ to meet unique needs
eZ publish server administrator - Responsibility: eZ dependencies, Apache/PHP/MySQL/OS/Network

Paths

Read as much as possible from the sea of information available on the subject of eZ
Learn to search for specific solutions or mentions
Learn eZ publish template language (tpl)
Read all the new, updated and all the issues reported on issues.ez.no, comment. encourage support for the issues which interest you. After a perioud of time shaddowing all the issues reported and discussed you might begin to be able to start fixing issues both privately or publicly.
Discuss and report issues, defects and bugs on ez.no
Contribute documentation on subjects you know
Learn to develop eZ publish solutions as extensions
Learn to kernel hack eZ successfully and how to create, use and apply patches to stock eZ kernel files
Test your ability to use the information you have learned effectively
Contribute source code examples, extensions and feature configurations back to the community

Goals

Master a general understanding of using eZ, configuration and implementation
Master an advanced understanding of all things eZ, ability to implement any functionality the eZ way

Avoid

Complaining too quickly
Being unclear
Being unorganized
Ignoring the details

Looking Back

Leave a trail for another developer or user to follow via the forums, blogs and wiki
Summarize the problems, solutions, experiences and etc in howto style documentation in the wiki and in the forums

References

Please read this amazing guide, it's suggestions are key fundamentals, 10 golden rules for starting with open source

eZ Publish Best Practices

Wed, 24 Feb 2010 08:44:35 GMT

Best Practices

Document External Dependencies

Write down anything and everything you may need in the future.

Name, Date, Version Number, Dependencies, Description, Details

Web Server and Dependencies Configuration
eZ publish Configuration
eZ publish cache / static / proxy server Configuration
3rd Party Software Configuration
Operating System Configuration
Server Network Configuration - IP Addresses*

Backing up eZ publish

Always keep a complete backup of everything which makes up your eZ publish installation (database, var dir, settings, extensions, etc)!

eZ publish in production! A look at backup best practices.

Disable Hosting of Installation
Clear cache (Important)
Dump Database to .sql file
Copy eZ publish installation Directory
Package Database Dump and eZ publish installation in dated (in file name) directory

Using Subversion to maintain eZ publish

This path is often preferred as it gives maximum control to merge development into an existing site with only minor conflicts.

'Missing Directory Structure Example #1'

'Missing Directory Structure Example #2'

Developers

Thu, 10 Sep 2009 21:38:13 GMT

This article will give you an overview of the different possibilities for adding new functionality into eZ Publish.

Along with questions from the new-developer perspective trying to understand where to implement eZ Publish extension functionality to reach 'n' varying custom eZ Publish programming goals.

Debugging

Before you start to program, you should read the debugging tips. You'll have to learn how to adjust your site's configuration settings to make it easier to debug your new code and to track errors.

Extensions

Create segmented functionality and avoid future upgrade conflicts by implementing your solutions as an extension instead of changing base eZ Publish files (core/kernel).

Settings

Creating a new setting, types of settings, settings overrides, settings security and dynamic settings creation via php.

Security

Making eZ Publish secure, issues, experiences and footnotes.

Plugins

What are plugins? Give example of an eZ Publish plugin.

Login handlers

A login handler handles authentication of a user. The login handler is provided with a login id and a password, and returns a valid eZ Publish user for the system to use. This information can be used to authenticate against an external system.

Single Sign On handlers

An SSO handler is useful if you want to validate based on some other property of the user than login id/password, such as referring URL or client IP address. Or to support SSO; for example, if the session has some sort of token from an SSO server.

Datatypes

A datatype is the smallest possible entity of storage. It determines how a specific type of information should be validated, stored, retrieved, formatted and so on. eZ Publish comes with a collection of fundamental datatypes that can be used to build powerful and complex content structures.

In addition, it is possible to extend the system by creating custom datatypes for special needs. Custom datatypes have to be programmed in PHP. However, the built in datatypes are usually sufficient enough for typical scenarios. The following table gives an overview of the most basic datatypes that come with eZ Publish.

Workflow event types

What is a workflow event type? Give examples of when to create a workflow event.

Content action handlers

What is a content action handler? With a content action handler you can extend the content/action view.

Content edit handlers

What is a content edit handler? With a content edit handler you can extend the content/edit view.

Search engines

With the Lucene search plugin or other eZ search plugin you can customize and extend searching in eZ Publish completely!

Extended attribute filters

Extended attribute filters are used in combination with template fetch functions and applies custom filters...

Designs

eZ Publish uses designs as the basis of storing design related resources including templates, javascript, stylesheets, images, and siteroot files.

Templates

eZ Publish uses templates as the basis of website design. Templates plug directly into eZ Publish and are programed in eZ Template language (also known as tpl, eztpl). Templates represent the display formating, templating and internationalization layer of eZ Publish.

While simply elegant to use templates are a very powerful tool comprised of even more powerful tools and information. eZ Publish templates come with a large number of built in template features. This allows functionality to be implemented very quickly and simply. While larger templates may benefit in reduced performance load in implementing some functionality as a custom extension.

Template operators

Template operators plug into the Template system in eZ Publish and are programmed in PHP. Template Operators can take input, transform it, and return a result to the template. eZ Publish comes with a lot of built in template operators.

Template functions

Template functions are built in language constructs, functions which provide features within the template language.

Notifications

When to use notifications?

Notification events

When to use notification events?

Notification handlers

When are notification handlers a way to implement what functionality, wait, what are notification handlers?

Collaboration handlers

What is a collaboration handler?

Image converters

What is an image converter? Which converters are available?

Image analyzers

What is an image analyzer?

Metadata extractors

What is a metadata extractor?

RSS import maps

See the feature doc.

Modules

What is a module, why not to confuse modules and extensions, when are modules needed. Did you know that the eZ Publish kernel is comprised of modules? Did you know you can use these as a reference for your own development?

Scripts

When to write a script and what type? If you need automated execution you would write a cronjob, while if you only supported manual execution you would write a command line script.

Cronjobs

Cronjobs are useful for periodic tasks like updating content, sending emails (notification) and so on. But they are also useful for tasks that have a long runtime which you want to make sure that the execution timeout does not affect the script. Cronjobs can not have parameters.

Command line scripts

A command line script is a php script which can have parameters

Kernel

The eZ Publish kernel is a large set of subsystems. At times one needs to use intimidate knowledge of eZ Publish internals (kernel) to archive certain specific functionality. It is generally _not_ recommended to change the kernel or stock eZ Publish core, because upgrades will be much harder.

API code samples

The code samples will help you getting started with some commonly used parts of the eZ Publish API. They can be really useful in your custom modules, scripts and cronjobs.

Solutions

Solutions to a common need to extend eZ Publish in similar ways. These solutions can be minimal / direct or longer articles with source code examples.

Upgrading

Upgrade experience notes from community member.
Upgrade documentation from eZ systems

Dealing with static strings or ids within template files using custom settings files

Sat, 22 Aug 2009 14:39:03 GMT

Description

One eZ Publish best practice is storing static strings or ids as settings variables loaded in templates instead of storing static strings or ids within templates.

You should review your template files and move these static strings or ids into a settings file and make reference to the custom settings variables you define.

Example

This example should show clearly a basic example of how to store your custom variable contents within a settings file and access them in a template.

Setting

File: s ettings/override/example_com.ini.append.php

<?php /* #?ini charset="utf-8"?
 
[CustomNodeIDs]
NodeName001=42
NodeName002=84
NodeName003=11
ClassIdentifier=article
 
 
*/ ?>

Template

File: design/standard/templates/pagelayout.tpl

{def $node_name_001 = ezini( 'CustomNodeIDs', 'NodeName001', 'example_com.ini' )}
{if is_set( $node_name_001 )}
    [...display something...]
{else}
   [...display something else...]
{/if}

Reference

Template Operator: ezini

User Documentation

Sat, 22 Aug 2009 12:42:16 GMT

User Manuals

eZ systems User Manual

Articles

eZ community Articles

Tutorials

A popular blog about eZ Publish with detailed examples, https://serwatka.net/blog
A blog about eZ Publish with template development training articles, https://www.wascou.org/wascou/Tutorials
- Like these great article for new users about template best practices and syntax-exercises.
A blog about eZ Publish with various development related articles mostly in French, https://pwet.fr/blog
- Like this great template development and debug article, some_tips_about_the_ez_publish_debug

Markup Syntax

XML Tags

HOWTO Troubleshoot eZ Publish Extensions

Sat, 22 Aug 2009 10:23:02 GMT

You might have to double check certain things when an extension does not seem to work.

Whitespace in INI files

The INI system does not automatically trim values, so any trailing whitespace behind a setting value will be part of the value.

Consider an extension called "myextension" containing template operators. In the site.ini.append.php of the extension, you will find something like this:

[TemplateSettings]
ExtensionAutoloadPath[]=myextension

This will instruct the template system to look for a file extension/ezxajax/autoloads/eztemplateautoload.php. In this file, there's information on which classes in the extension contain which template operators.

However, if there is a space behind ExtensionAutoloadPath[]=myextension, it will try to find the file "extension/myextension /autoloads/eztemplateautoload.php", which of course does not exists.

Setting arrays being cleared by other INI files

Consider the following code:

TemplateSettings]
ExtensionAutoloadPath[]
ExtensionAutoloadPath[]=myextension

ExtensionAutoloadPath[] will re-initialize the setting again as an array, and any items added to the array in previously loaded setting files are lost.

INI settings file syntax errors cause strange results

Settings files can break and halt reading and processing default required settings which is known to developers to cause strange behavior if they introduce settings file syntax errors. Especially in core default settings files like site.ini

Possible symptoms or side affects

Failed database connection attempt
Incomplete or un-expected template and design usage
Anything that requires settings to function fundamentally withing eZ Publish which is not loaded before a ini file reading syntax error will fail in various ways. This covers things like anything within a custom extension, siteaccess, override settings

The solution naturally is to validate your settings files syntax manually (or with custom tools to detect syntax errors within settings files values). Often developers will review in detail their most recently modified settings files chronologically.

Contributing to the community

Sat, 22 Aug 2009 10:02:37 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Question: When should I contribute back to the community?

After reaching a solution or milestone, I often have seen others ask this this question and use these answers to educate when to contribution back comments, documentation or source code to the community.

After reaching a solution, ask yourself if this solution returned back to the community as a contribution would ...

Resolve a failing of the default product or configuration
Be of use found useful by another in a similar situation
Represent a unique response to a general need

eZ Publish PHP doxygen API Documentation

Sat, 22 Aug 2009 09:56:30 GMT

About

eZ Publish PHP source code contains inline documentation. The inline documentation uses the doxygen format. This inline documentation can be processed and used to build html documentation based on the contents of the eZ Publish PHP source code.

This documentation represents an invaluable reference resources for any PHP developer.

Hosted Doxygen Documentation

PubSVN hosts a regularly updated copy of this generated html doxygen documentation which is built from the eZ Publish Trunk Subversion Repository. This documentation offers a unique perspective in looking and searching quickly for information about the eZ Publish PHP source code and available APIs.

https://pubsvn.ez.no/doxygen/

External reference

Project: Doxygen
Doxygen Manual
Download Doxygen Software
Download eZ publish

Documentation

Sat, 22 Aug 2009 09:54:52 GMT

Guide to Doxygen in 5 Minutes

Mon, 10 Aug 2009 05:59:44 GMT

About

Doxygen is used for inline source code documentation.

Doxygen inline source code documentation comments are required by eZ Publish Approved and Certified Extensions.

Example

/*!
  \class BCGoogleAnalyticsOperators bcgoogleanalyticsoperators.php
  \brief Googole Analytics Operators class. These operators provide for simple operators which may be installed into templates to provide google analytics client side javascript dependancies needed to enable eZ Publish to report pageview and webshop order statistics. This class is used and provided by the bcgoogleanalytics extension
  \note Only the operators required to be installed into your pagelayout.tpl for page and order tracking are 'bc_ga_urchin', 'bc_ga_urchinHeader'. The rest of the dependancies are handled internaly.
*/
class BCGoogleAnalyticsOperators
{
    // code...
}

Recommended Tags

\class
\brief
\note
\return
\public
\static
\see
\code
\endcode
\param
\privatesection

Website interface : Override settings

Mon, 10 Aug 2009 01:33:31 GMT

User site access

Template override settings for the user site accesses:

[full_article]
Source=node/view/full.tpl
MatchFile=full/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[full_banner]
Source=node/view/full.tpl
MatchFile=full/banner.tpl
Subdir=templates
Match[class_identifier]=banner
 
[full_comment]
Source=node/view/full.tpl
MatchFile=full/comment.tpl
Subdir=templates
Match[class_identifier]=comment
 
[full_documentation_page]
Source=node/view/full.tpl
MatchFile=full/documentation_page.tpl
Subdir=templates
Match[class_identifier]=documentation_page
 
[full_event]
Source=node/view/full.tpl
MatchFile=full/event.tpl
Subdir=templates
Match[class_identifier]=event
 
[full_feedback_form]
Source=node/view/full.tpl
MatchFile=full/feedback_form.tpl
Subdir=templates
Match[class_identifier]=feedback_form
 
[full_file]
Source=node/view/full.tpl
MatchFile=full/file.tpl
Subdir=templates
Match[class_identifier]=file
 
[full_flash]
Source=node/view/full.tpl
MatchFile=full/flash.tpl
Subdir=templates
Match[class_identifier]=flash
 
[full_folder]
Source=node/view/full.tpl
MatchFile=full/folder.tpl
Subdir=templates
Match[class_identifier]=folder
 
[full_forum]
Source=node/view/full.tpl
MatchFile=full/forum.tpl
Subdir=templates
Match[class_identifier]=forum
 
[full_forum_reply]
Source=node/view/full.tpl
MatchFile=full/forum_reply.tpl
Subdir=templates
Match[class_identifier]=forum_reply
 
[full_forum_topic]
Source=node/view/full.tpl
MatchFile=full/forum_topic.tpl
Subdir=templates
Match[class_identifier]=forum_topic
 
[full_forums]
Source=node/view/full.tpl
MatchFile=full/forums.tpl
Subdir=templates
Match[class_identifier]=forums
 
[full_frontpage]
Source=node/view/full.tpl
MatchFile=full/frontpage.tpl
Subdir=templates
Match[class_identifier]=frontpage
 
[full_gallery]
Source=node/view/full.tpl
MatchFile=full/gallery.tpl
Subdir=templates
Match[class_identifier]=gallery
 
[full_image]
Source=node/view/full.tpl
MatchFile=full/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[full_infobox]
Source=node/view/full.tpl
MatchFile=full/infobox.tpl
Subdir=templates
Match[class_identifier]=infobox
 
[full_link]
Source=node/view/full.tpl
MatchFile=full/link.tpl
Subdir=templates
Match[class_identifier]=link
 
[full_product]
Source=node/view/full.tpl
MatchFile=full/product.tpl
Subdir=templates
Match[class_identifier]=product
 
[full_quicktime]
Source=node/view/full.tpl
MatchFile=full/quicktime.tpl
Subdir=templates
Match[class_identifier]=quicktime
 
[full_real_video]
Source=node/view/full.tpl
MatchFile=full/real_video.tpl
Subdir=templates
Match[class_identifier]=real_video
 
[full_windows_media]
Source=node/view/full.tpl
MatchFile=full/windows_media.tpl
Subdir=templates
Match[class_identifier]=windows_media
 
[line_article]
Source=node/view/line.tpl
MatchFile=line/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[line_banner]
Source=node/view/line.tpl
MatchFile=line/banner.tpl
Subdir=templates
Match[class_identifier]=banner
 
[line_comment]
Source=node/view/line.tpl
MatchFile=line/comment.tpl
Subdir=templates
Match[class_identifier]=comment
 
[line_documentation_page]
Source=node/view/line.tpl
MatchFile=line/documentation_page.tpl
Subdir=templates
Match[class_identifier]=documentation_page
 
[line_event]
Source=node/view/line.tpl
MatchFile=line/event.tpl
Subdir=templates
Match[class_identifier]=event
 
[line_feedback_form]
Source=node/view/line.tpl
MatchFile=line/feedback_form.tpl
Subdir=templates
Match[class_identifier]=feedback_form
 
[line_file]
Source=node/view/line.tpl
MatchFile=line/file.tpl
Subdir=templates
Match[class_identifier]=file
 
[line_flash]
Source=node/view/line.tpl
MatchFile=line/flash.tpl
Subdir=templates
Match[class_identifier]=flash
 
[line_folder]
Source=node/view/line.tpl
MatchFile=line/folder.tpl
Subdir=templates
Match[class_identifier]=folder
 
[line_forum]
Source=node/view/line.tpl
MatchFile=line/forum.tpl
Subdir=templates
Match[class_identifier]=forum
 
[line_forum_reply]
Source=node/view/line.tpl
MatchFile=line/forum_reply.tpl
Subdir=templates
Match[class_identifier]=forum_reply
 
[line_forum_topic]
Source=node/view/line.tpl
MatchFile=line/forum_topic.tpl
Subdir=templates
Match[class_identifier]=forum_topic
 
[line_forums]
Source=node/view/line.tpl
MatchFile=line/forums.tpl
Subdir=templates
Match[class_identifier]=forums
 
[line_gallery]
Source=node/view/line.tpl
MatchFile=line/gallery.tpl
Subdir=templates
Match[class_identifier]=gallery
 
[line_image]
Source=node/view/line.tpl
MatchFile=line/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[line_infobox]
Source=node/view/line.tpl
MatchFile=line/infobox.tpl
Subdir=templates
Match[class_identifier]=infobox
 
[line_link]
Source=node/view/line.tpl
MatchFile=line/link.tpl
Subdir=templates
Match[class_identifier]=link
 
[line_product]
Source=node/view/line.tpl
MatchFile=line/product.tpl
Subdir=templates
Match[class_identifier]=product
 
[line_quicktime]
Source=node/view/line.tpl
MatchFile=line/quicktime.tpl
Subdir=templates
Match[class_identifier]=quicktime
 
[line_real_video]
Source=node/view/line.tpl
MatchFile=line/real_video.tpl
Subdir=templates
Match[class_identifier]=real_video
 
[line_windows_media]
Source=node/view/line.tpl
MatchFile=line/windows_media.tpl
Subdir=templates
Match[class_identifier]=windows_media
 
[edit_comment]
Source=content/edit.tpl
MatchFile=edit/comment.tpl
Subdir=templates
Match[class_identifier]=comment
 
[edit_file]
Source=content/edit.tpl
MatchFile=edit/file.tpl
Subdir=templates
Match[class_identifier]=file
 
[edit_forum_topic]
Source=content/edit.tpl
MatchFile=edit/forum_topic.tpl
Subdir=templates
Match[class_identifier]=forum_topic
 
[edit_forum_reply]
Source=content/edit.tpl
MatchFile=edit/forum_reply.tpl
Subdir=templates
Match[class_identifier]=forum_reply
 
[highlighted_object]
Source=content/view/embed.tpl
MatchFile=embed/highlighted_object.tpl
Subdir=templates
Match[classification]=highlighted_object
 
[embed_article]
Source=content/view/embed.tpl
MatchFile=embed/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[embed_banner]
Source=content/view/embed.tpl
MatchFile=embed/banner.tpl
Subdir=templates
Match[class_identifier]=banner
 
[embed_file]
Source=content/view/embed.tpl
MatchFile=embed/file.tpl
Subdir=templates
Match[class_identifier]=file
 
[embed_flash]
Source=content/view/embed.tpl
MatchFile=embed/flash.tpl
Subdir=templates
Match[class_identifier]=flash
 
[embed_folder_listwithintrohoriz]
Source=content/view/embed.tpl
MatchFile=embed/folder_listwithintrohoriz.tpl
Subdir=templates
Match[class_identifier]=folder
Match[classification]=listwithintrohoriz
 
[embed_folder_products]
Source=content/view/embed.tpl
MatchFile=embed/folder_products.tpl
Subdir=templates
Match[class_identifier]=folder
Match[classification]=products
 
[itemized_sub_items]
Source=content/view/embed.tpl
MatchFile=embed/itemized_sub_items.tpl
Subdir=templates
Match[classification]=itemized_sub_items
 
[vertically_listed_sub_items]
Source=content/view/embed.tpl
MatchFile=embed/vertically_listed_sub_items.tpl
Subdir=templates
Match[classification]=vertically_listed_sub_items
 
[horizontally_listed_sub_items]
Source=content/view/embed.tpl
MatchFile=embed/horizontally_listed_sub_items.tpl
Subdir=templates
Match[classification]=horizontally_listed_sub_items
 
[itemized_subtree_items]
Source=content/view/embed.tpl
MatchFile=embed/itemized_subtree_items.tpl
Subdir=templates
Match[classification]=itemized_subtree_items
 
[embed_folder]
Source=content/view/embed.tpl
MatchFile=embed/folder.tpl
Subdir=templates
Match[class_identifier]=folder
 
[embed_forum]
Source=content/view/embed.tpl
MatchFile=embed/forum.tpl
Subdir=templates
Match[class_identifier]=forum
 
[embed_gallery]
Source=content/view/embed.tpl
MatchFile=embed/gallery.tpl
Subdir=templates
Match[class_identifier]=gallery
 
[embed_image]
Source=content/view/embed.tpl
MatchFile=embed/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[embed_product]
Source=content/view/embed.tpl
MatchFile=embed/product.tpl
Subdir=templates
Match[class_identifier]=product
 
[embed_quicktime]
Source=content/view/embed.tpl
MatchFile=embed/quicktime.tpl
Subdir=templates
Match[class_identifier]=quicktime
 
[embed_real_video]
Source=content/view/embed.tpl
MatchFile=embed/real_video.tpl
Subdir=templates
Match[class_identifier]=real_video
 
[embed_windows_media]
Source=content/view/embed.tpl
MatchFile=embed/windows_media.tpl
Subdir=templates
Match[class_identifier]=windows_media
 
[embed_inline_image]
Source=content/view/embed-inline.tpl
MatchFile=embed-inline/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[embed_itemizedsubitems_gallery]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/gallery.tpl
Subdir=templates
Match[class_identifier]=gallery
 
[embed_itemizedsubitems_forum]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/forum.tpl
Subdir=templates
Match[class_identifier]=forum
 
[embed_itemizedsubitems_folder]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/folder.tpl
Subdir=templates
Match[class_identifier]=folder
 
[embed_itemizedsubitems_documentation_page]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/documentation_page.tpl
Subdir=templates
Match[class_identifier]=documentation_page
 
[embed_itemizedsubitems_itemized_sub_items]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/itemized_sub_items.tpl
Subdir=templates
 
[embed_horizontallylistedsubitems_article]
Source=node/view/horizontallylistedsubitems.tpl
MatchFile=horizontallylistedsubitems/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[embed_horizontallylistedsubitems_event]
Source=node/view/horizontallylistedsubitems.tpl
MatchFile=horizontallylistedsubitems/event.tpl
Subdir=templates
Match[class_identifier]=event
 
[embed_horizontallylistedsubitems_image]
Source=node/view/horizontallylistedsubitems.tpl
MatchFile=horizontallylistedsubitems/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[embed_horizontallylistedsubitems_product]
Source=node/view/horizontallylistedsubitems.tpl
MatchFile=horizontallylistedsubitems/product.tpl
Subdir=templates
Match[class_identifier]=product
 
[factbox]
Source=content/datatype/view/ezxmltags/factbox.tpl
MatchFile=datatype/ezxmltext/factbox.tpl
Subdir=templates
 
[quote]
Source=content/datatype/view/ezxmltags/quote.tpl
MatchFile=datatype/ezxmltext/quote.tpl
Subdir=templates
 
[table_cols]
Source=content/datatype/view/ezxmltags/table.tpl
MatchFile=datatype/ezxmltext/table_cols.tpl
Subdir=templates
Match[classification]=cols
 
[table_comparison]
Source=content/datatype/view/ezxmltags/table.tpl
MatchFile=datatype/ezxmltext/table_comparison.tpl
Subdir=templates
Match[classification]=comparison
 
[image_galleryline]
Source=node/view/galleryline.tpl
MatchFile=galleryline/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[image_galleryslide]
Source=node/view/galleryslide.tpl
MatchFile=galleryslide/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[article_listitem]
Source=node/view/listitem.tpl
MatchFile=listitem/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[image_listitem]
Source=node/view/listitem.tpl
MatchFile=listitem/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[full_event_calendar]
Source=node/view/full.tpl
MatchFile=full/event_calendar.tpl
Subdir=templates
Match[class_identifier]=event_calendar
 
[line_event_calendar]
Source=node/view/line.tpl
MatchFile=line/event_calendar.tpl
Subdir=templates
Match[class_identifier]=event_calendar
 
[embed_itemizedsubitems_event_calendar]
Source=content/view/itemizedsubitems.tpl
MatchFile=itemizedsubitems/event_calendar.tpl
Subdir=templates
Match[class_identifier]=event_calendar

Admin site access

Template override settings for the admin interface:

[embed_image]
Source=content/view/embed.tpl
MatchFile=embed_image.tpl
Subdir=templates
Match[class_identifier]=image
 
[article]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/article.tpl
Subdir=templates
Match[class_identifier]=article
 
[comment]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/comment.tpl
Subdir=templates
Match[class_identifier]=comment
 
[company]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/company.tpl
Subdir=templates
Match[class_identifier]=company
 
[feedback_form]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/feedback_form.tpl
Subdir=templates
Match[class_identifier]=feedback_form
 
[file]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/file.tpl
Subdir=templates
Match[class_identifier]=file
 
[flash]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/flash.tpl
Subdir=templates
Match[class_identifier]=flash
 
[folder]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/folder.tpl
Subdir=templates
Match[class_identifier]=folder
 
[forum]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/forum.tpl
Subdir=templates
Match[class_identifier]=forum
 
[forum_topic]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/forum_topic.tpl
Subdir=templates
Match[class_identifier]=forum_topic
 
[forum_reply]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/forum_reply.tpl
Subdir=templates
Match[class_identifier]=forum_reply
 
[gallery]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/gallery.tpl
Subdir=templates
Match[class_identifier]=gallery
 
[image]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[link]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/link.tpl
Subdir=templates
Match[class_identifier]=link
 
[person]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/person.tpl
Subdir=templates
Match[class_identifier]=person
 
[poll]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/poll.tpl
Subdir=templates
Match[class_identifier]=poll
 
[product]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/product.tpl
Subdir=templates
Match[class_identifier]=product
 
[review]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/review.tpl
Subdir=templates
Match[class_identifier]=review
 
[quicktime]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/quicktime.tpl
Subdir=templates
Match[class_identifier]=quicktime
 
[real_video]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/real_video.tpl
Subdir=templates
Match[class_identifier]=real_video
 
[weblog]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/weblog.tpl
Subdir=templates
Match[class_identifier]=weblog
 
[windows_media]
Source=node/view/admin_preview.tpl
MatchFile=admin_preview/windows_media.tpl
Subdir=templates
Match[class_identifier]=windows_media
 
[thumbnail_image]
Source=node/view/thumbnail.tpl
MatchFile=thumbnail/image.tpl
Subdir=templates
Match[class_identifier]=image
 
[window_controls]
Source=window_controls.tpl
MatchFile=window_controls_user.tpl
Subdir=templates
Match[navigation_part_identifier]=ezusernavigationpart
 
[windows]
Source=windows.tpl
MatchFile=windows_user.tpl
Subdir=templates
Match[navigation_part_identifier]=ezusernavigationpart
 
[embed-inline_image]
Source=content/view/embed-inline.tpl
MatchFile=embed-inline_image.tpl
Subdir=templates
Match[class_identifier]=image
 
[embed_node_image]
Source=node/view/embed.tpl
MatchFile=embed_image.tpl
Subdir=templates
Match[class_identifier]=image
 
[embed-inline_node_image]
Source=node/view/embed-inline.tpl
MatchFile=embed-inline_image.tpl
Subdir=templates
Match[class_identifier]=image
 
[thumbnail_image_browse]
Source=node/view/browse_thumbnail.tpl
MatchFile=thumbnail/image_browse.tpl
Subdir=templates
Match[class_identifier]=image
 
[thumbnail_banner]
Source=node/view/thumbnail.tpl
MatchFile=thumbnail/image.tpl
Subdir=templates
Match[class_identifier]=banner
 
[thumbnail_banner_browse]
Source=node/view/browse_thumbnail.tpl
MatchFile=thumbnail/image_browse.tpl
Subdir=templates
Match[class_identifier]=banner

Cheatsheets: Template Variable Inspection Operator

Mon, 10 Aug 2009 01:29:55 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

By Object or Attribute Type

By ...
By Content Object as Node
Within pagelayout
Outside pagelayout
During extension execution

Examples

{$templateVariable|attribute(show,1)}

{$node|attribute(show,1)}

{$arrayOfObjects|attribute(show,2)}

Original Idea Notes

Basic (pdf,odf,txt)
Advanced (pdf,odf,txt)
Tree (pdf,odf,txt)

Differences and Abstracting them into understanding

External reference

Doc: Array and object inspection

Debugging Site Template Settings

Mon, 10 Aug 2009 01:25:46 GMT

About

By enabling the Debug setting in site.ini, [TemplateSettings] eZ publish will put XHTML comments in your template output.

Settings

[TemplateSettings]
# Debug=disabled
Debug=enabled

Example

These comments will show you where the parsed output of certain templates starts and stops. An example:

<!-- START: including template: design/corporate_site/override/templates/collectedinfomail/feedback_form.tpl (design:content/collectedinfomail/form.tpl) -->
 
...
 
<!-- STOP: including template: design/corporate_site/override/templates/collectedinfomail/feedback_form.tpl (design:content/collectedinfomail/form.tpl) -->

You can also display these markers as paragraphs on the web page, by using the ShowXHTMLCode setting.

You should disable template debug on production sites. When you're using the notification system or information collector mails, these markers will be put in your mail too, also when the mails are in plain text.

Quick settings toolbar

You can switch Debug on and off with the "Template debug" checkbox of the quick settings toolbar in the admin interface.

External resources

Learning: How to create a design extension

Sun, 09 Aug 2009 11:14:27 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Extension design priority

Each extensions priority is important to consider. To override a design extension like ezwebin you would want to first place your own custom design extension in priority above the ezwebin extension active settings.

Enabling a design extension per site access

A simple example of design extension priority in the site.ini, ExtensionSettings, ActiveAccess settings array of ezpublish settings

[ExtensionSettings]
 ActiveAccessExtensions[]=customdesign
 ActiveAccessExtensions[]=seperatecustomdesign

Enabling a design extension globally

A simple example of design extension priority in the site.ini, ExtensionSettings, ActiveExtensions settings array of ezpublish settings

[ExtensionSettings]
 ActiveExtensions[]=ezauthorize
 ActiveExtensions[]=bcwebsitestatistics
 ActiveExtensions[]=googlesitemaps
 ActiveExtensions[]=ezwebin
 ActiveExtensions[]=ezdhtml
 ActiveExtensions[]=ezodf
 ActiveExtensions[]=ezpaypal
 ActiveExtensions[]=wrap_operator
 ActiveExtensions[]=survey

Creating a custom design extension

A custom design extension is very simple in that one must simply configure to use a single custom design extension which you provide. Often users simply disable the ezwebin extension from the activation settings both globally and per siteaccess. Then enable your custom design extension at least in one active siteaccess settings or globally.

A simple example of design extension priority in the site.ini, ExtensionSettings, ActiveExtensions settings array of ezpublish settings

[ExtensionSettings]
 ActiveExtensions[]=yourcustomdesign
# ActiveExtensions[]=ezwebin
 ActiveExtensions[]=ezdhtml
 ActiveExtensions[]=ezodf

Creating a custom design extension override of base design

Everyone wants to know how to override the default eZ Publish design eZ Webin. eZ Webin is a general design extension which ships in eZ Publish as the default user design extension. The answer starts with the settings. With the correct settings combination you can override the ezwebin design. Often users simply enable their override design extension in a single active siteaccess settings.

Global

Here an example in override/site.ini.append.php

[ExtensionSettings]
ActiveExtensions[]=yourcustomdesign
ActiveExtensions[]=ezwebin
 ActiveExtensions[]=ezdhtml
 ActiveExtensions[]=ezodf

Siteaccess

A simple example of design extension priority in the site.ini, ExtensionSettings, ActiveAccess settings array of ezpublish settings

[ExtensionSettings]
 ActiveAccessExtensions[]=customdesign
  ActiveAccessExtensions[]=seperatecustomdesign
  ActiveAccessExtensions[]=ezwebin

Reference

Forum: Page Layout Extension
Forum: Why the extension doesn't work?

Upgrading Notes

Sun, 09 Aug 2009 10:25:09 GMT

Prerequisits

If you need to upgrade eZ, start here:
https://ez.no/doc/ez_publish/upgrading

Examine this image carefully:
https://ez.no/doc/layout/set/full/ez_publish/upgrading/images/ez_publish_releases

Requirements

Backup the database!

Steps

Then, open Notepad and list your upgrade path, with every stop. You can then copy and paste out of Notepad onto the command line.
Pay particular attention to the scripts listed on each page (for example: upgrading from 3.3-5 to 3.4).
Some of the scripts don't run (due to version conflicts), and some are optional. Read the pages in the upgrade documentation carefully - or you'll have to do it over and over.
Take your time and be patient. The commands below are an example, you'll need to substitute your database access parameters as well as the siteaccess names.

Script

Write a script! Commands will vary between different upgrade paths.

Results

I upgraded from x.y.z to x.y.z and it went fairly smoothly.

Problems

Issues I did encounter

Results

Test

At this time, you should be able to use the admin console.
Go to Setup > Upgrade > and check the database consistency.
Manually run any SQL through the database engine.
Clearing the cache and updating the search index are important.

Where to find eZ Publish extensions

Sun, 09 Aug 2009 03:07:15 GMT

About

A question frequently asked by those who are looking for more information about existing solutions and example software available.

Sources

ez.no
projects.ez.no
pubsvn.ez.no
svn.ez.no
certified extensions
partner products
ez partners
individuals
external repositories (individuals, organizations)

Managing and Cleaning Nice Urls

Sun, 09 Aug 2009 02:40:35 GMT

Problem

I have a user who deleted a page, then added a new one to replace it (with the same name). We have nice urls, and the former url was

/about_us/activity

. When he deleted that and added the new page, the new one’s URL is

about_us/activity__1

Does anyone know how to affect this name, and how to change it back to the original? I suppose I could try to use a redirect, but it would be cleaner if we could just change the page somehow to give it a clean url.

I will make sure the user knows not to delete and re-add pages in the future!

Solution

I personaly have encountered this ‘sideaffect’ from moving / renaming like named objects.

The solution I have found was to ...

1. rename the object to something unique (totaly different)
2. then (again) rename the object to something unique (what i want it to be called)

I just had to make sure I wasn’t renaming the object to anything another object was named in the same container (folder).

Special thanks to participants: Mark Marsiglio, kracker

References

Cleaning Nice Urls

Solutions

Sun, 09 Aug 2009 01:24:16 GMT

eZ publish often requires developers to leverage the past solutions of others to quickly address the need for a specific feature.

We are seeking contributions of documentation and solutions generated during the eZ publish community's day to day development.

Solutions

Search for 'Solution' or review the 'Solution' namespace folder.

Learning

Search for 'Learning'

Development

Search for 'Development'
Search for 'Subversion'

Troubleshooting

Search for 'Troubleshooting'

Debugging

Search for 'Debugging'

Tips

Tips - Short List

Faqs

A general faq for eZ Publish

Installation

Search for 'Installation'

Security

Search for 'Security' documentation which highlights important best practices.

Upgrading

Search for 'Upgrading'

Reference

Missing Feature - Generated based on eZpedia content

Index

Missing Feature - Generated based on eZpedia content

Glossary

Missing Feature - Generated based on eZpedia content

Template language for PHP developers

Wed, 07 Jan 2009 08:26:57 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

This page lists PHP features and their counterpart in the eZ publish template language. With the term "counterpart" we do not mean the usage and features are exactly the same. We just try to list the most similar construct(s).

Variables

PHP	Template language counterpart
$_SERVER	ezservervars
$_GET	ezhttp ezhttp_hasvariable
$_POST	ezhttp ezhttp_hasvariable
$_SESSION	ezhttp ezhttp_hasvariable session_save session_load sessionget sessionset
$_COOKIE	getCookie

Operators

Arithmetic

PHP	Template language counterpart
+	sum
-	sub
*	mul
/	div
%	mod

Comparison

PHP	Template language counterpart
==	eq
!=	ne
<>	ne
<	lt
>	gt
<=	le
>=	ge

Incrementing/decrementing

PHP	Template language counterpart
++	inc
--	dec

Logical

PHP	Template language counterpart
and	and
or	or
not	not
&&	and
\|\|	or

String

PHP	Template language counterpart
.	concat
.=	concat

Array

PHP	Template language counterpart
===	compare
!==	compare

Control structures

PHP	Template language counterpart
if	if
while	while
do-while	do
for	for
foreach	foreach
switch	switch

Functions

The function index of the PHP manual contains all available PHP functions.

The following list has to be ordered alphabetically. Keep this in mind when adding items to it.

PHP	Template language counterpart
array	array hash
array_merge	merge
array_push	append
array_reverse	reverse
array_pop	remove
array_shift	remove
array_slice	extract extract_left extract_right
array_sum	array_sum
array_unique	unique
array_unshift	prepend
arsort	arsort
asort	asort
explode	explode
get_defined_vars	show_variables
header	redirectrelative redirectabsolute
htmlentities	wash encode
implode	implode
in_array	contains
is_null	null
isset	is_set
krsort	krsort
ksort	ksort
mktime	maketime
md5	md5 encode
natcasesort	natcasesort
natsort	natsort
nl2br	nl2br break
ob_get_clean()	set-block append-block
preg_replace	reg_ex_replace
rand	rand randomnum
rsort	rsort
shuffle	shuffle (original shuffle)
sort	sort
str_replace	ezstr_replace
strtolower	downcase
strtoupper	upcase
tidy_parse_string	eztidy
time	currentdate
urlencode	defined by PHPOperatorList encode

Migrating from the eZXML library to PHP 5 DOM

Mon, 22 Dec 2008 20:53:34 GMT

API replacements

DOM Document

eZXML	DOMDocument	Remarks
$xml = new eZXML() $dom = $xml->domTree( $xmlDoc )	$dom = new DOMDocument() $success = $dom->loadXML( $xmlDoc )	there were some extra options which we need to check, like character set conversion

eZDOMDocument	DOMDocument	Remarks
->create_element( $name [, $attributes] )	$element = $dom->createElement( $name ) $element->setAttribute( $attrName, $attrValue )
->createElementNode( $name [, $attributes] )	$element = $dom->createElement( $name ) $element->setAttribute( $attrName, $attrValue ) ...
->createElementTextNode( $name, $text [, $attributes] )	$element = $dom->createElement( $name ) $element->appendChild( $dom->createTextNode( $text ) ) $element->setAttribute( $attrName, $attrValue ) ...
->dump_mem()	->saveXML()
->elementsByNameNS( $name, $namespaceURI )	->getElementsByTagNameNS( $namespaceURI, $name )	can be called on each DOMNode, not only on a DOMDocument
->get_root()	->documentElement	property
->Root	->documentElement	property
->root()	->documentElement	property
->setRoot( $element )	->appendChild( $element )
->toString()	->saveXML()

DOM Node

eZDOMNode	DOMNode and subclasses	Remarks
->append_child( $node )	->appendChild( $node )
->attributeCount()	->attributes->length	see below
->attributes()	->attributes	property, returns DOMNamedNodeMap instead of array now, use $attributes->length property instead of count( $attributes ), see above
->attributeValue( $name )	->getAttribute( $name )
->attributeValueNS( $name, $namespaceURI )	->getAttributeNS( $namespaceURI, $name )	pay attention to the changed order of the function arguments
->Children	->childNodes	property, returns DOMNodeList instead of array now, use $children->length property instead of count( $children )
->children()	->childNodes	see above
->childrenCount()	->childNodes->length
->content()	->textContent	property
->dump_mem()	$element->ownerDocument->saveXML( $element )
$element->dump_mem()	$element->ownerDocument->saveXML( $element)
->elementAttributeValueByName( $name, $attributeName )	$firstElement = $element->getElementsByTagName( $name )->item( 0 ) $attributeValue = $firstElement->getAttribute( $attributeName )
->elementByName( $name )	->getElementsByTagName( $name )->item( 0 )
->elementChildrenByName( $name )	$firstElement = $element->getElementsByTagName( $name )->item( 0 ) $children = $firstElement->childNodes
->first_child()	->firstChild	property
->firstChild()	->firstChild	property
->firstElementByName( $name )	->getElementsByTagName( $name )->item( 0 )	see elementByName
->get_attribute( $name )	->getAttribute( $name )
->get_elements_by_tagname( $name )	->getElementsByTagName( $name )	Returns all descendant elements with the name $name, not only direct children. To get only direct children with the name $name, use DOMXPath or loop over ->childNodes
->hasChildren()	->hasChildNodes()
->lastChild()	->lastChild	property
->localName()	->localName	property
->name()	->localName	property
->namespaceURI()	->namespaceURI	property
->nextSibling()	->nextSibling	property
->node_value()	->nodeValue	property
->parentNode()	->parentNode	property
->prefix(), ->setPrefix( $prefix )	->prefix	writable property
->previousSibling()	->previousSibling	property
->remove_attribute( $name )	->removeAttribute( $name )
->set_attribute( $name, $value )	->setAttribute( $name, $value )
->textContent()	->textContent	property
$element->toString()	$element->ownerDocument->saveXML( $element)
->type()	->nodeType	property, one of the predefined XML_xxx_NODE constants

Important notes

The DOMElement::insertBefore function returns the appended node, and you should use it! Otherwise you can get unexpected results or uncaught exceptions (like DOMException with message "Not Found Error").

When looping over the DOMElement::childNodes property, you can not remove or move any of the existing children, or insert new one. This will cause the property to change and your loop will apparently skip certain children or handle certain children twice. Instead of looping directly over childNodes, you can first make an array containing the children and loop over that array to make your modifications. In case you only want to remove certain items, looping over childNodes in reverse order (from the last one to the first one) is a solution as well.

The same applies to the DOMElement::attributes property.

Debugging

Thu, 11 Dec 2008 17:48:30 GMT

PHP

You should turn on the display_errors directive and set error_reporting to E_ALL.

References

If you are crashing PHP, you may be exceeding certain internal limitations or known issues. It is known that eZ publish can encounter these 'reference' related problems.

Xdebug

Xdebug is an advanced debugging package for php. With Xdebug you can use it to obtain advanced information regarding your eZ publish runtime errors, problems or crashes. Many eZ systems senior developers rely on Xdebug to solve day to day eZ publish breakdowns which might cause a customer or user to request support.

Debug output

Enable the eZ publish debug output. If you're working with templates and template overrides you should also make eZ publish show a list of the used templates. You can easily find where the output of certain templates starts and stops with the ShowXHTMLCode setting.

Private debugging

You can selectively turn on the debug output for sites in production, so other visitors don't see it.

By IP

You can turn on the debug output only for certain client IP addresses.

By user ID

This feature is available since eZ publish 3.9.

You can turn on the debug output only for certain user accounts. Add this to your site.ini.append.php:

[DebugSettings]
DebugByUser=enabled
 DebugUserIDList[]
 DebugUserIDList[]=23
 DebugUserIDList[]=42

Now only users with the user/object ID 23 and 42 will see debug output.

Caching

It's recommended that you disable template compilation, the template block cache and the content view cache. You can add the following settings to site.ini.append.php to add aditional toggles for these caches to the quick settings tool:

[DebugSettings]
QuickSettingsList[]=TemplateSettings;TemplateCompile;site.ini;Templace compile
QuickSettingsList[]=TemplateSettings;TemplateCache;site.ini;Templace cache
QuickSettingsList[]=ContentSettings;ViewCaching;site.ini;View cache

Template

You may use a template operator called 'attribute' to display the contents of a variable or data structure.

More information on this operator can be found in the node, 'Learning: Template Debugging'.

{ $foo | attribute( show, 2 ) }

Related extensions

External resources

Development

Tue, 22 Jan 2008 09:57:59 GMT

Getting Help

Suggestion on how to ask for help.

eZ publish Software Design Choices

Template Operator or Template?

Learning eZ

Development

Extending eZ

Development Resources

Extensions

Extension documentation educates how to install and use existing extensions available via subversion.
Tutorial about development of ez publish extensions An Introduction to Developing eZ Publish Extensions
available in english, german and spanish

Administration

Getting eZ

Getting the latest version of eZ publish (bleeding edge, trunk) via subversion
Getting the latest stable version of eZ publish (stable branch + latest release) via packaged release or subversion

Installing eZ

Configuring eZ

Administering eZ

Maintaining eZ

Solution documentation teaches simple solutions to problems or answers to questions previously encountered.

Clustering eZ

Captions of eZ

Promoting eZ

Fri, 24 Aug 2007 02:15:29 GMT

About

There are many ways one may promote eZ

Submitting news

One way is to submit interesting news to any one of the thousands of sites dedicated to news

Digg.com

There is a member of the community which is using digg.com to promote eZ, eZ Publish, eZ Components, the eZ Community and eZ Ecosystem by submitting and digging stories to the news site.

We urge everyone to read these stories, add comments, share them with your friends and 'digg' them.

eZ Development Standards and Guidelines

Mon, 06 Aug 2007 10:39:29 GMT

Standards

Please comply to the following standards when writing code for eZ Publish:

Guidelines

eZ * is an automated solution that ensures that an eZ Publish installation (or a solution based on eZ Publish) is up-to-date and stable.

This is ensured by providing regular updates and constant monitoring of systems status.
Modifications and extensions to eZ Publish must adhere to certain standards in order to be certified to work with the eZ *.
This document describes those standards and provides guidelines for making custom modifications to eZ Publish, with an emphasis on extension development.
To understand and implement these guidelines, you must be an experienced PHP developer with at least intermediate experience with eZ Publish.

From: eZ Development Guidelines

eZ Network Development Guidelines (PDF)

Version 1.2
Updated July 16th 2007
eznetwork_development_guidelines.pdf (369.05 kB)

Package definition

Tue, 01 May 2007 15:42:03 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Format

The package definition is written in an XML dialect. A DTD or XML Schema describing the dialect or currently not available.

Location

The package definition is stored in a package.xml file in the root of a package directory.

Definition parts

The following list describes the different parts of a package definition.

Root element

A package element is used as the root of the XML document. The root element defines the package version and install type.

Version

The version attribute of the package element defines the version of your package.

Install type

Some packages can only be imported and not installed through the admin interface. An example of such packages are the site packages.

Whether a package can be installed or not is defined by the install_type attribute of the package element.

<package version="1.0"
          development="false"
          is_active="true"
          install_type="import">
 
<!-- ... -->
</package>

<package version="1.0"
          development="false"
          is_active="true"
          install_type="install">
 
<!-- ... -->
 
 
</package>

Name

The formal name of your package is defined by the content of the name element. You should only use the characters a to z and and _ in your package name.

<name>ezwebin_extension</name>

Summary

The summary element contains a one-line summary of your package.

<summary>ezwebin extension</summary>

Description

The description element contains an extended description of your package.

<description>ezwebin extension</description>

Vendor

By specifying a vendor in your package, it will be installed in a separate local repository, named after the vendor.

<vendor>eZ systems</vendor>

Type

There are several package types included with eZ publish by default. They are defined in settings/package.ini [PackageSettings] TypeList[]:

Name	Identifier
Content object	contentobject
Content class	contentclass
Site style	sitestyle
Site	site
Patch	patch

In the package definition, the package type is defined by a type child element of the package element:

<type value="site" />

External resources

Package feature documentation: package.xml format

Learning: Template Comments

Wed, 04 Apr 2007 14:00:42 GMT

eZ publish Template Comment Syntax

From: 3.4 Doc Site | https://ez.no/ez_publish/documentation/the_template_language/comments

Comments

Just like in almost any programming language, comments can be used to add explanations, descriptions, etc.

Template comments are not displayed in the resulting (X)HTML output that is generated by eZ publish.

Commented chunks of template text/code will not be interpreted by the template engine.

There is only one way to add template comments, and that is by encapsulating the desired comment by a matching pair of the “{*” and “*}” sequence of characters.

Clearly, a template comment is just like any other template code except that the curly brackets are accompanied by adjacent asterisks. It is possible to comment both single and multiple lines of text/code. Nesting of comments is not supported. In other words, it is not possible to comment a comment.
The following examples demonstrate the use of comments:

Single-line comment

{* This is a comment. *}

Will not produce any output.

Multi-line comment

{* This is a comment 
 
  that spans across
  several lines in
  the template file. *}

Will not produce any output.

Nested comments

{* {* Nested comments are not supported! *} This text will be displayed. *}

The following output will be displayed:

This text will be displayed.

Upgrading

Tue, 23 Jan 2007 08:09:59 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

About 'Upgrading eZ publish'

eZ publish is a toolkit which is regularly being improved and updated.

Upgrading eZ publish requires the replacement of the eZ publish base directory files with replacements files.

If you add or modify files in eZ publish your upgrade will be much harder on yourself to maintain functionality while still actually upgrading the eZ publish base files and settings.

Issues surrounding avoiding changes to eZ publish base directory not contained in an extension.

Directories

'extension/' - Most people store their custom modifications to files in the 'extension/' directory within a subdirectory for the purpose or extension. simply avoid storing modified files outside this directory. It is possible and saves limitless hassle during upgrades.

'settings/' - Most people must customize the 'settings/override/' directory and 'settings/siteaccess/'. While many of these setting may be placed within an extension a few custom modifications often must made or put into place in this directory.

'design/' - Most people place their design modifications here instead of instead of inside an extension directory. You can and should store your design as a 'design extension'.

'bin/' - Many customize the 'bin/' directory, they should store their customizations in an extension directory for 'example extension/example/bin/'.

'kernel/' - Many people customize the 'kernel/' and or 'lib/' directory, they should store their customizations in an extension directory for 'example extension/example/patch/3.8/kernel/'. This is a simple way to patch the kernel again simply.

'share/' - Many people may find the need to customize files in this directory which is discouraged. Instead make your modifications within your extension, 'extension/example/share/' or 'extension/example/patch/3.8/share/'.

'cronjobs/' - A few people add or modify files in this directory. While you should instead manage your custom modifications from within your extension, 'extension/example/cronjobs/' or 'extension/example/patch/3.8/cronjobs/'.

'var/' - Everyone stores their files in the var directory. The var directory storage contains files placed in eZ publish content structure. Many users hosting eZ publish on a unix-like-operating-system will store this directory outside of eZ publish, or within an extension, 'extension/example/var/' and use a symbolic, hard link or mount point to link 'var/' to 'extension/example/var/'

Tips

Run the Upgrade Check

Run the 'Upgrade Check' before and after each upgrade. Doing this can protect you from database export / backup / restoration problems and alert you when they occure, perhapse before it is too late.

Upgrade a copy

To avoid a downtime, you can temporarily make your site read-only and use a copy of it to do the actual upgrade on. When you're done you can use the upgraded copy as the new production site.

External references

Upgrade guides

Development resources

Mon, 01 Jan 2007 14:24:01 GMT

on ez.no

Developer
Development Cycle
Roadmap
Specifications
Contributing
Standards
- PHP coding standard
- Template standard
- SQL standard
- Commit log standard
Mailing Lists
Contributions
Reading Materials
- Articles
- News
- Blog
- Forum
- Bug reports
Documentation
- eZ Publish
- Extensions

Support the community!

Sun, 31 Dec 2006 15:05:02 GMT

Support the community!

Support the eZ publish community by getting involved and speaking out!

Do you have ideas for the community, send feedback, adding a suggestion, reporting an issue, signing in and completing a task, all highly encouraged!

Adding new eZ publish documentation (contributed by the community) extends benefits beyond traditional boarders and limitations; reducing tco for everyone.

The very diverse eZ community supported projects, including PubSVN and eZpedia.

Learning: Template Debugging

Sun, 31 Dec 2006 01:19:05 GMT

Attribute

Subject: Template debugging using template operator 'attribute'.

Template Operator: attribute

All eZ publish developers need to understand how to use the operator called attribute. Here are some example of it’s use:

{ $foo | attribute( show, 1 )}

These are some other commonly used examples of it’s syntax and usage.

{$foo|attribute(show)}
 
{$foo|attribute(show,1)}
 
{$foo|attribute(show,2)}
 
{$foo|attribute(show,3)}
 
{$foo|attribute(show,false())}

Production Debuging Tip

Use output your attribute show debug output while working on a production eZ publish installation inside of an html comment.

This provides for display of debug information within the html source code output in an html comment without displaying that same debug information to your web site's users.

<!--
 
{$myvariable|attribute(show,1)}
 
-->

ez.no documentation

Checkout the eZ systems : eZ publish : Technical Manual : 3.8 Template Language : Array and Object inspection.

Sourced from from ez.no 3.4 docs

The template operator attribute can be used to generate a list of attributes from a template variable. You do that by:

{$myvariable|attribute}

i.e.

Variable: module_result.content

{$module_result.content|attribute(show, 1)}

Variable: node

{$node|attribute(show, 1)}

Variable: node.data_map

{$node.data_map|attribute(show, 1)}

Variable: node.object

{$node.object|attribute(show, 1)}

Variable: DesignKeys:used

{$DesignKeys:used|attribute(show, 1)}

This will generate a HTML table with all the attributes and their types. If a type is an array or a new object with attributes it will recursively display those as well until it has displayed 2 levels. Options

By supplying show as the first parameter you get the values of the attributes.

The second parameter determines how many levels it will expand, the default is 2. A value of false, means there is no level limit, this can cause the web server to crash if there are infinite loops in the attributes.

false()

The third controls whether the output should be in HTML or not. Pass false to it to get text output.

false()

Template Variables

Template Variables Set By eZ publish

History of eZ publish

Sat, 30 Dec 2006 18:11:56 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

Creation

eZ publish was created by eZ systems

Created around xyz day / month / year range as a responce to xyz event in xyz's life.

Articles

> Articles about different passages of time and progress using eZ publish.

Note s

Notice: eZ systems was a GNU/Linux software provider with an investment into QT toolkit, even today you can find reminants of the older 2.0 QT GUI Desktop applications for eZ publish from eZ Systems (Long before the current replacement, webdav). The doxygen + translation software dependencies could be viewed in this light.

Learning: How to develop eZ publish solutions within an extension

Wed, 29 Nov 2006 08:02:00 GMT

This is a Stub article. Help the eZ Publish community by expanding it!

BecomeAnArchivist

Tue, 07 Nov 2006 01:55:07 GMT

Archivist

How to become ..

Friendly Introduction

Help:Editors! eZpedia needs editors!

A community members who encounter a problem which turns out to have been solved long ago, not known to the general public, or simply recently uncharted or revisited subject mater. After a time an answer may be found by one, many, most or all independently or collaboratively. The distance between the time exhausted by multiple participants over say 3 months and the time required to document a subject before setting the matter aside is astonishing.

The collaborative sway of the entire eZ publish community, the folks who wake up and find themselves thinking about something eZ related, these are the folks who are all investing (for whatever the benefit) in the 'eZ' platform, these are the same folks who upon encountering a solution have not known how best to share those experiences, situations, solutions.

Suggestions

I tend to create most of my documentation using a very simple method.

Document what you do while you work and the amount of available documentation will increase (as will your knowledge of the systems or tools you use).

Be a history archivist. As you work or watch others in the various methods in the eZ ecosystem; Document all the related key pieces of the information regarding the conversation / problem and solution required to reproduce and resolve the problem (to local text file for example)
Be thorough (if you can), document the participants of the conversation and the date/time (to local text file for example).
Be polite. Ask for permission to submit an entry to the community documentation, Licensed using the GFDL.
Be an author. Review existing nodes for example content formatting, Write up the conversation publish, maintain and promote your node!
Be an editor. Review existing nodes for common spelling, formatting, linking, toc, etc errors. Document errors and or make proof-reading corrections.
Be a maintainer. Maintain, revise, promote your node!
Become a maintainer. Maintain, revise an existing node which has not been maintained (unless it is version specific)

The quality, medium, and quantity of available eZ publish community documentation depends on the contributions made by the very community who needs it.

I think it's a given we really want to encourage people to stop what they are doing right now mid sentence and go create their first node!

If you come back and discuss; well, that's a plus as well ...