eZpedia.org : Recently updated

Amazon

Tue, 02 Mar 2010 09:28:32 GMT

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

About

eZ Publish can be used with an Amazon API(s)

Extensions

JV Amazon Advertising allows you to query Amazon huge product catalog by using Amazon Product Advertising API

http://projects.ez.no/jvamazonadvertising

IB Amazon Website Integration extension allows you to integrate products from Amazon with your site. After enabling this extension you've got an oportunity to search products on Amazon using a keyword and product category selection.

http://ez.no/developer/contribs/solutions/ib_amazon_website_integration

xrowCDN connects eZ Publish with a Content Delivery Network

http://projects.ez.no/xrowcdn

Known Issues

References

adminalphabetical

Thu, 25 Feb 2010 22:24:43 GMT

Features

The adminalphabetical extension contains some modified templates for the eZ publish admin interface. In these templates, the google-like navigation is replaced with a navigation based on the Latin alphabet. This makes it easier to step through a large amount of nodes which are typically sorted by name, e.g. a list of users.

License

It was written by Kristof Coomans.

Demo

A live demo will be available soon.

Requirements

adminalphabetical is compatible with the following versions of eZ publish:

3.7.6 or newer in the 3.7 branch
3.8 (coming soon)

Installation

Download

You can download this extension from it's contribution page on ez.no.

Installing the extension

Follow the steps described in the eZ publish technical manual to extract and activate the extension.

Override templates

Now make template overrides for the specific nodes where you want to have alphabetical navigation.
An example for a node with id 100:

[browse_node_100]
Source=content/browse.tpl
MatchFile=content/browse_alphabetical.tpl
Subdir=templates
Match[node]=100
 
[children_node_100]
Source=children.tpl
MatchFile=children_alphabetical.tpl
Subdir=templates
Match[node]=100

Technical notes

During the development of adminalphabetical, bug 8140 was discovered. Due to this bug, the override for the browse template doesn't work on eZ publish versions prior to 3.7.6.

External links

adminalphabetical contribution page on ez.no

Main page

Thu, 25 Feb 2010 19:03:58 GMT

The free eZ Publish encyclopedia that anyone can edit. eZpedia has accumulated 596 english articles since 2006. We encourage you to create an account and create or edit a page yourself. Some folks create an article in the people namespace with their full name as the article name with a brief description of who they are, their interests, goals and objectives.

Ask A Question

Do you have an eZ Publish question, do you need an eZ Publish answer? Simply login and ask your question in our discussion forum. We publicly write free documentation based on your submissions. Posting on eZpedia is a great way to get answers you need and contribute to our freely available community documentation for eZ Publish.

Ecosystem

Read about what is going on within the various eZ Publish related websites on internet.

Checkout the latest reported news on anything eZ Publish via eZpedia (Recently, Email, Rss, Feeds, Updated, Discussion, New), eZ Share (Forums, Blogs, Articles, Tutorials), eZ Projects (WebSVN, ViewVC), PubSVN, eZ Publish Planet, eZ Publish, Developer, News, eZ Systems, Digg, FriendFeed or Twitter!

Recent subversion activity

Track the eZ Publish development progress through the roadmap by reviewing recent subversion activity from pubsvn.ez.no

Last updated: Fri, 12 Mar 2010 03:16:13 +0100

Tagged from eZPublish #384

Related issue:
384

Wed, 10 Mar 2010 12:49:19 +0100

Rev 25163 - reviewboard (1 file(s) modified)

Tagged from eZPublish #384

+ /versions/4.3.0beta2

- Updated: Configured 4.3.0rc1 branch

Wed, 10 Mar 2010 12:40:11 +0100

Rev 25162 - oms (13 file(s) modified)

- Updated: Configured 4.3.0rc1 branch

~ /trunk/bin/php/checkdbfiles.php
~ /trunk/bin/shell/checkversionnumbers.sh
~ /trunk/bin/shell/common.sh
+ /trunk/doc/changelogs/4.3/unstable/CHANGELOG-4.3.0beta2-to-4.3.0rc1
~ /trunk/doc/doxygen/Doxyfile
~ /trunk/kernel/sql/common/cleandata.sql
~ /trunk/lib/version.php
~ /trunk/share/db_data.dba
~ /trunk/support/ezlupdate-qt3/main.cpp
~ /trunk/support/ezlupdate-qt4.5/ezlupdate/main.cpp
~ /trunk/support/ezlupdate-qt4/main.cpp
+ /trunk/update/database/mysql/4.3/unstable/dbupdate-4.3.0beta2-to-4.3.0rc1.sql
+ /trunk/update/database/postgresql/4.3/unstable/dbupdate-4.3.0beta2-to-4.3.0rc1.sql

hiding fieldset for published sorting when the subitem list is ...

Tue, 09 Mar 2010 09:23:43 +0100

Rev 25161 - cpg (1 file(s) modified)

hiding fieldset for published sorting when the subitem list is empty

~ /trunk/design/admin2/templates/children.tpl

separating widgets for creating new content and published ordering into ...

Tue, 09 Mar 2010 09:08:35 +0100

Rev 25160 - cpg (1 file(s) modified)

separating widgets for creating new content and published ordering into two fieldsets

~ /trunk/design/admin2/templates/children.tpl

- Fixed bug #16291: Media library without access to create ...

Related issue:
16291

Tue, 09 Mar 2010 08:52:21 +0100

Rev 25159 - ls (5 file(s) modified)

- Fixed bug #16291: Media library without access to create folders

~ /trunk/design/admin2/templates/children.tpl
~ /trunk/doc/changelogs/4.3/unstable/CHANGELOG-4.3.0beta1-to-4.3.0beta2
~ /trunk/kernel/content/ezcontentfunctioncollection.php
~ /trunk/kernel/content/function_definition.php
~ /trunk/settings/content.ini

Recent discussions

Read what others are discussing

Chinese language of ezpedia.org

2010/02/18 @ 11:46:57 : Xiongjie Chen : Good

Chinese language of ezpedia.org

2010/02/18 @ 11:25:46 : Heath : Taking the initiative ...

Chinese language of ezpedia.org

2010/02/17 @ 08:42:42 : Xiongjie Chen : Thanks Heath

Chinese language of ezpedia.org

2010/02/17 @ 04:19:56 : Heath : Great Idea!

Chinese language of ezpedia.org

2010/02/16 @ 15:18:27 : Mingxing Chen : Greetings from China

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'

Install

Fri, 19 Feb 2010 00:13:08 GMT

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

About

Helpful information about installing the eZ Publish CMS

Articles

References

eZ publish 3.9

Fri, 29 Jan 2010 18:36:29 GMT

News on ez.no

2007-02-22	eZ publish 3.9.1 RC1 released
2007-01-10	Unofficial info	eZ publish 3.9.1 expected in about two weeks, containing a security fix ( bug #9942 )
2006-12-18	Anouncing eZ publish 3.9.0 with the new Website Interface
2006-12-07	RC2 released
2006-11-17	Community newsletter 17/11/2006	release of 3.9.0 expected mid December
2006-11-14	RC1 released
2006-10-30	beta1 released
2006-10-18	alpha1 released
2006-10-06	Community newsletter 06/10/2006	finishing up implementation, included features are certain
2006-06-16	Community newsletter 16/06/2006	updated feature request list
2006-05-24	feature request list

Installation

We recommend to use the setup wizard to perform a new installation of eZ publish 3.9 when you want to use the new Website interface design, because there are some difficulties and inconsistencies with the manual installation procedure. The brave ones can always try to do a manual installation. Please read the 3.9 manual installation forum topic and add your experiences and good advice to it.

Upgrading

Follow the upgrade instructions at ez.no. Carefully read the comments too! They contain some important remarks!

Because of bug #9873 and bug #9952 we recommend you to wait for eZ publish 3.9.1 to upgrade existing sites.

Using old site packages

The site packages used in versions prior to eZ publish 3.9 still can be used for eZ publish 3.9. If you want to use the old site packages instead of the new ones, then add the following settings to settings/override/package.ini.append.php before you start the setup wizard:

[RepositorySettings]
RemotePackagesIndexURL=http://packages.ez.no/ezpublish/3.9legacypackages

New features

Most new features are described in the 3.9 feature docs.

Website interface extension

There's a new site package called Website interface. It is possible to override the default website interface.

Class and template editing are disabled by default since the 3.9.0 release. A solution to this problem is to modify SiteAccessRules to allow advanced editing.

Additional content creation and import features

CSAPI function for quick object creation and publishing. In addition to the toString and fromString datatype functionality.

A function eZContentFunctions::createAndPublishObject was added to the file, kernel/classes/ezcontentfunctions.php (trunk rev. 17475).

This function allows to easily create an object, populate its attributes with data and publish the object at one node location.

The best information available apears to be in the new feature documentation in svn trunk and the source code itself.

See: ezcontentfunctions.php, ezcsvimport.php, ezcsvexport.php

Best Selling Product Fetch

There's also a new extended fetch function providing best selling product information through, 'best_sell_list' fetch function.

Kernel Error Codes

A smaller addition is the new kernel error code values now available.

Setup wizard finish custom text

Site packages can now specify custom text to be shown at the finish screen of the setup wizard (trunk rev. 17478).

Contributor / third party software / extension information

The ezinfo/about view now includes information about contributors, included third party software and the enabled extensions.

Information about contributors is extracted from the source code headers by the updatelicense.sh distribution script and assigned to the variable $contributorSettings in PHP files under var/storage/contributors.

Information about third party software is also extracted from the source code headers and assigned to the variable $thidPartySoftware in var/storage/third_party_software.php.

Extensions can now provide extension information to be displayed on the ezinfo/about view.

External resources

New Interface in eZ publish 3.9
eZ publish now (3.9) demo

PHP Snippet Creating new content objects

Fri, 29 Jan 2010 18:34:49 GMT

Compatibility

This feature is available since eZ publish 3.9.

From eZ Publish 3.9 on, there's also the static method eZContentFunctions::createAndPublishObject() which handles object creation, filling attributes and publishing at one location. The filling of the attributes is handled by the fromString functions implemented by the datatypes. For more information on this, see the fromString and toString feature doc.

Permission checking

If you want to bypass the policy system, then remove the conditional check on $accessResult

Code sample

The following code will create a new content object and an initial draft version. It is based on a part of the action view of the content module (kernel/content/action.php).

The known variables

$contentClassIdentifier: identifier of the content class we want to make an object of
$node: the parent node for the new object's main location in the node tree

$class = eZContentClass::fetchByIdentifier( $contentClassIdentifier );
 
if ( is_object( $class ) )
{
    $contentClassID = $class->attribute( 'id' );
    $parentContentObject =& $node->attribute( 'object' );
 
    $accessResult = $parentContentObject->checkAccess( 'create', $contentClassID, $parentContentObject->attribute( 'contentclass_id' ) ); 
 
    if ( $accessResult == '1' )
    {
        include_once( 'kernel/classes/datatypes/ezuser/ezuser.php' );
        $user =& eZUser::currentUser();
        $userID =& $user->attribute( 'contentobject_id' );
        $sectionID = $parentContentObject->attribute( 'section_id' );
 
        include_once( 'lib/ezdb/classes/ezdb.php' );
        $db =& eZDB::instance();
        $db->begin();
 
        $contentObject =& $class->instantiate( $userID, $sectionID );
        $nodeAssignment = eZNodeAssignment::create( array( 'contentobject_id' => $contentObject->attribute( 'id' ),
                                                           'contentobject_version' => $contentObject->attribute( 'current_version' ),
                                                           'parent_node' => $node->attribute( 'node_id' ),
                                                           'is_main' => 1 ) );
 
        $nodeAssignment->store();
        $db->commit();
    }
}

Now that you have created a new content object, you will probably want to fill it's attributes with data and publish it.

Creating new content objects with php

Fri, 29 Jan 2010 18:33:32 GMT

Compatibility

This feature is available since eZ publish 3.9.

Permission checking

If you want to bypass the policy system, then remove the conditional check on $accessResult

Code sample

The following code will create a new content object and an initial draft version. It is based on a part of the action view of the content module (kernel/content/action.php).

The known variables

$contentClassIdentifier: identifier of the content class we want to make an object of
$node: the parent node for the new object's main location in the node tree

$class = eZContentClass::fetchByIdentifier( $contentClassIdentifier );
 
if ( is_object( $class ) )
{
    $contentClassID = $class->attribute( 'id' );
    $parentContentObject =& $node->attribute( 'object' );
 
    $accessResult = $parentContentObject->checkAccess( 'create', $contentClassID, $parentContentObject->attribute( 'contentclass_id' ) ); 
 
    if ( $accessResult == '1' )
    {
        include_once( 'kernel/classes/datatypes/ezuser/ezuser.php' );
        $user =& eZUser::currentUser();
        $userID =& $user->attribute( 'contentobject_id' );
        $sectionID = $parentContentObject->attribute( 'section_id' );
 
        include_once( 'lib/ezdb/classes/ezdb.php' );
        $db =& eZDB::instance();
        $db->begin();
 
        $contentObject =& $class->instantiate( $userID, $sectionID );
        $nodeAssignment = eZNodeAssignment::create( array( 'contentobject_id' => $contentObject->attribute( 'id' ),
                                                           'contentobject_version' => $contentObject->attribute( 'current_version' ),
                                                           'parent_node' => $node->attribute( 'node_id' ),
                                                           'is_main' => 1 ) );
 
        $nodeAssignment->store();
        $db->commit();
    }
}

Now that you have created a new content object, you will probably want to fill it's attributes with data and publish it.

Import

Fri, 29 Jan 2010 18:32:25 GMT

CSV / DSV

Extensions doing CSV import:

Additional content creation and import features

eZ publish 3.9 comes with new features which make CSV import easier.
CSAPI function for quick object creation and publishing. In addition to the toString and fromString datatype functionality.

A function eZContentFunctions::createAndPublishObject was added to the file, kernel/classes/ezcontentfunctions.php (trunk rev. 17475).

This function allows to easily create an object, populate its attributes with data and publish the object at one node location.

The best information available apears to be in the new feature documentation in svn trunk and the source code itself.

See: ezcontentfunctions.php, ezcsvimport.php, ezcsvexport.php

OpenDocument

Extensions doing OpenDocument import:

OASIS Open Document extension

PowerPoint

see PowerPoint Import

RSS

See RSS.

OPML

See OPML.

XML

Extensions doing XML import:

Import XML Data

Import Framework

Basic classes for abstracting data imports.

Misc

Extensions doing other kinds of import:

References

Simple fromString and toString interface for attributes

Fri, 29 Jan 2010 18:30:50 GMT

Simple fromString and toString interface for attributes

This is a copy of only document available that describes the extremely useful toString and fromString functions of datatypes, which greatly simplify storing and retrieving attributes in php.

This is a design document, so there may be some inaccuracies but it seems to work ok into the 4.2 series. It is recommended to verify the format of not-trivial datatypes by doing toString on attribute of that type with data in it and examining output.

Source: http://pubsvn.ez.no/nextgen/trunk/doc/features/3.9/to_from_string_datatype_functionality.txt

To simplify writing of import export scripts we have added two functions to the ezcontentobjectattribute class. Also related functions with the same name have been added to the datype interfase and to all datatypes in standard eZ Publish distribution exept of ezenum which is now deprecated and ezpackage which is not used.

To show possibilities of these functionality two scripts have been added under bin/php/. These scripts are very simple CSV import/export scripts:
- ezcsvimport.php
- ezcsvexport.php
They are very basic and do not pretend to be fully functional CSV import/export for ezpublish though you can use them to do real import/export. Here is a description of formats which are accepted by the datatypes for
fromString( &$contentObjectAttribute, $string ), and generated by toString( $contentObjectAttribute ) methods.

ezauthor:
To separate one author from another '&' char is used, to separate parts of author data '|' is used. The system escapes '|','&','\' with the '\' char.
Example of toString result:

To make it easy to parse such kind of strings the class ezstringutils is added under lib/ezutils. It has to functions as a members.
explodeStr( $str, $delimiter = '|' ) and implodeStr( $str, $delimiter = '|' ). The first one explodes string to an array with delimiter char, the difference from PHP explode/implode is that these functions do propper escaping/unescaping of all values.

ezbinaryfile:
toString function of this datatype return string of format:
filepath|original_filename
filepath is to a file in filesystem so you can make copy of the file.
original_filename is the original filename of uploaded file as string.
To import binary file to the attribute you need to supply it with full path
to the source file, which will be copied into system.

ezboolean:
Returns and accepts 1 or 0 for true and false accordingly.

ezcountry:
Returns comma-separated list of selected countries locale strings, ex.:
rus-RU,eng-GB,nor-NO

ezdate:
Returns and accepts unix timestamp of the date.

ezdatetime:
Returns and accepts unix timestamp of the date.

ezemail:
Returns and accepts email address.

ezenum:
Not supported (deprecated)

ezfloat:
Returns and accepts float number.

ezimage:
Returns path to file containing original alias (size) of the image, so it can be copied. Accepts full path to original image you want to import, it will be copied into system.

ezinisetting:
Returns and accepts value of an inisetting.

ezinteger:
Returns and accepts integer value.

ezisbn:
Returns and accepts ISBN number as string

ezkeyword:
Returns and accepts comma separated list of keywords.

ezmatrix:
Identical to ezauthor datatype. The columns are sparated with '|' and rows are separated with '&'

ezmedia:
toString function of this datatype return string of format:
filepath|original_filename
filepath is to a file in filesystem so you can make copy of the file.
original_filename is the original filename of uploaded file as string.
To import binary file to the attribute you need to supply it with full path
to the source file, which will be copied into system.

ezmultioption:
The first '&' separated value is the name of multioption set, then each '&' separated string represents
each option in multioption set. This string it self is '|' separated value, that consist of, in this order:
_name_ of the option and the _id_ of option item which should be selected by default. After these two
values we have option_value and additional price for the option item.

ezmultiprice:
The structure of a data handled by this data type is
currency_name_1|value_1|type_of_price_1|currency_name_2|value_2|type_of_price_2|......currency_name_n|value_n|type_of_price_n|
Where currency_name is thre char currency name like EUR,USD and so on,
value is the price in this currency,
and type can be AUTO or CUSTOM dependin on if the price in this currency
has been inserted by user or calculated automaticaly.

ezobjectrelation:
Returns and accepts ID of related object.

ezobjectrelationlist:
'-' separated list of related object ID's.

ezoption:
'|' separated list of name of the option and then | sparated list of option_item|additional item price values.

ezprice:
'|' separated list of price, VAT id, and flag wether VAT is included to the price or not.

ezproductcategory:
Returns '|' separated string with product category name and category id. Accepts just category
name as a papameter.

ezrangeoption:
'|' separated string contains name of the option, start,stop and step values for the option.

ezselection:
'|' separated list of selected item names.

ezstring:
Returns and accepts the string value.

eztext:
Returns and accepts the string value of eztext field.

eztime:
String with the time of the day in HH:MM , 24h format

ezurl:
string containing the url

ezuser:
'|' separated string with user login, email, password hash, and password hash type.

ezxmltext:
Returns valid ez publish xml, and expects the same as input.

Latest News

Wed, 20 Jan 2010 06:30:28 GMT

OpenSearch

Fri, 08 Jan 2010 21:40:02 GMT

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

Introduction

With the recent addition of open search plugins to Firefox and Internet Explorer web browsers can now share the same search plugins!

This means Internet Explorer, Firefox and other browsers can now share search plugins written using the OpenSearch Standard.

Open Search plugins are simple files in xml format and the new standard for cross browser search plugins.

Plugins

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

The following search plugins can be used to quickly search for specific eZ publish information on ez.no and eZpedia.org. These plugins are licensed under the GNU GPL, feel free to reuse these as examples for your own search plugins.

Installation

Click the install button next to the search plugin text link.

Update

We are uncertain at the time of publishing, of the best way to update an installed search plugin.

To date the best method is the removal of the search plugin file in the browser. In firefox you may do this by removing the file on disk (same name), restarting the browser and installing the plugin again.

Usage

After installation, select the search plugin from the dropdown list in the upper right hand corner of your browser and enter a search query.

Using these with eZ publish

The install buttons on this page are a custom tag which accepts the plugin url as an argument passed to the custom tag template which contains the browser form button installation javascript.

<input type="button" value="Install" onclick="javascript:window.external.AddSearchProvider('http://svn.projects.ez.no/opensearch/ezc/ezpedia.xml');" />

Support

Forum: OpenSearch Plugin Development

Browsers

Firefox 2.0
Opera 9.0
Internet Explorer 7.0

Credits

These search plugins, documentation, solution are a direct result of the eZpedia community documentation project, Kristof Coomans and Graham Brookins.

Initial Implementation - Kristof Coomans

Copy and Pasting aka Development - Graham Brookins

License

' GNU GPL'

Copyright

External reference

Cronjob

Mon, 04 Jan 2010 20:34:20 GMT

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

About

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. This is typically used for import-scripts.

The main reason for implementing a import-script or similar as a cronjob is that implementing a cronjob is drastically simpler than a cli script.

What is a cronjob

Cronjobs are tasks that are run at regular intervals. See Wikipedia for a more detailed description. See also the cronjobs documentation on ez.no.

Cronjob vs CLI scripts

Cronjob and CLI scripts are similar in the way that they are both run from the command line. However, there are two important differences between CLI scripts and cronjob scripts:

CLI scripts can have parameters, while cronjob scripts cannot take any parameters
Cronjob scripts set up the environment for you. That means creating a connection to the database, activating a siteaccess and activating extensions. If you implement a CLI script, you need to do all of this yourself.

Examples of CLI scripts are located in ./bin/php/*.php

Examples of Cronjob scripts are located in ./cronjobs/*.php

Implementing a cronjob

In this example, we implement a simple cronjob to import content. To implement this cronjob in an extension we need the following structure:

extension/myimport
|-- cronjobs
|   `-- import.php
`-- settings
    `-- cronjob.ini.append.php

In the cronjob.ini.append.php script we add the following:

[CronjobPart-import]
Scripts[]
Scripts[]=import.php
 
[CronjobSettings]
ExtensionDirectories[]=myimport

In the import.php:

<?php
 
echo "We have liftoff";
 
?>

We activate the extension, and now we can run the script as follows:

php runcronjobs.php -dall import

By using -dall we get the debugoutput, which is very useful for checking php-warnings and other errors.

This is the elements that needs to be in place to have a simple cronjob script. Now you can expand the import.php to do what you want it to do.

Settings

The settings for cronjobs are described in the documentation on ez.no

Running the cronjob

See the documentation on ez.no

References

Examples of simple, basic and advanced cronjobs.
The Cronjob script
Forum: Debugging cronjob php errors
Solution: Running cronjobs.php with parameters in limited environment
Term: cronjobs

Cron Jobs Alternatives

Some hosting companies don’t allow access to cron, but you can find a lot of cron jobs alternatives which are free or paid.
Here are some services:

Module

Thu, 10 Dec 2009 08:04:38 GMT

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

Module development

eZ publish provides for custom applications and components through support of many kinds of different extensions one of which is a module or custom module. Custom modules often use custom settings, designs, classes, cronjobs, workflows, triggers, etc. Custom module classes often extend the persistent object class.

Module extensions

The eZ publish kernel needs to know that your extension contains modules. In extension/ extensionname /settings/module.ini.append:

[ModuleSettings]
ExtensionRepositories[]=extensionname
ModuleList[]=modulename

By putting your module's name in the ModuleList setting array, you make sure that the eZ publish URL system does not reuse your module's URL as the nice URL of a content node.

Module definition

The actual definition of your module has to be placed in a file extension/extensionname/modules/modulename/module.php.

<?php  
 
$Module = array( 'name' => 'mymodule', 'variable_params' => false, 'ui_component_match' => 'module' );
$ViewList = array();
$FunctionList = array(); 
 
?>

The $Module array will contain global settings and data for your module. The following keys in this array are used by eZ publish:

Key	Type	Default	Usage
name	string		Alternative name of the module used in some debug statements (for example: Undefined view mymodule::foo when you try to access a non-existing view).
variable_params	boolean	false	Defines if you want to import variables into the view scipts' symbol table. When false you need to access the variables from the $Params array. You will find more information on this in the chapter "Views"
ui_component_match	string: module\|view	module	The string module (default) or view. Defines wether the module or view name will be used as the default ui_component for all views of this module
function	array		If your module contains only one view, then you can define the view here. The URl to the view will consist of only the module name.

$ViewList will contain the view definitions, you will find more information on views in the next chapter. $FunctionList will contain the policy function definitions, you will find more information on policy functions in the chapter "Policy functions".

Views

Definition

A module can have one or more views. You need to define your views in the $ViewList array. If your module contains only one view, you can also choose to define it with the "function" key in the module definition. If you define your view in this way, actions are not supported.

$ViewList = array();
$ViewList['viewname'] = array(
    'script' => 'myview.php',
     'params' => array( 'param1', 'param2' ),
    'ui_context' => 'navigation',
     'ui_component' => 'myuicomponent',
     'default_navigation_part' => 'ezmynavigationpart',
     'unordered_params' => array( 'param3ModuleName' => 'param3UrlName' , 'param4ModelName' => 'param4UrlName' ),
     'default_action' => array(
         array(
             'name' => '',
             'type' => 'post',
             'parameters' = array( 'postvariablename' ) ),
     'single_post_actions' => array( 'postvariablename' => 'actionname' ),
     'post_actions' => array( 'postvariablename' )
     'post_action_parameters' => array( 'actionname' => array( 'parametername' => 'postvariablename' ) ),
     'post_value_action_parameters' => array( 'actionname' => array( 'parametername' => 'postvariablenamestart' )
);

The keys of the $ViewList array are the names of the views, the values are the view definitions.

The following keys in your view definition are used by eZ publish:

Key	Type	Default	Usage
script	string		Filename of the view's PHP script.
params	array		The names of the parameters you can pass to the view by putting their values in the URL. For example: module/view/parametervalue
ui_context	string	navigation	Defines the UI context of the view.
ui_component	string	module or view name, depending on the "ui_component_match" key in the module definition	Defines the UI component of the view.
default_navigation_part	string		Defines the navigation part string of the view. The view result can override this.
unordered_params	array		The names of the parameters you can pass to the view by putting their name + value in the URL ( For example: module/view/(parametername)/parametervalue ). Please note the mapping here; in the view definition you define the name of the parameter in the url and also the according name for the parameter in the module script.
default_action	array
single_post_actions	array		If the current action is not yet determined it will use the definitions in module.php for finding out the current action. It first looks trough the single_post_actions array in the selected view mode, the key to each element is the name of the post-variable to match, if it matches the element value is set as the action. 'single_post_actions' => array( 'PreviewButton' => 'Preview', 'PublishButton' => 'Publish' )
post_actions	array		If none of these matches it will use the elements from the post_actions array to find a match. It uses the element value for each element to match agains a post-variable, if it is found the contents of the post-variable is set as the action. 'post_actions' => array( 'BrowseActionName' )
post_action_parameters	array
post_value_action_parameters	array

Troubleshooting

Possible debug messages:

error "eZProcess", "PHP script $file does not exist, cannot run" The file specified with the "script" key doesn't exist. Maybe you misspelled it or you forgot to create it.

Policy functions

Coming soon. You can already take a look at http://ez.no/community/forum/developer/limiting_within_viewlist_possible and the policy functions feature documentation.

Fetch functions

See custom fetch.

Module php script

In the module definition you define which php script a module view should run. In that php script you can implement your custom functionality and return to module output as the module result. Usually the module result is the inner part of the pagelayout template. In order to return the module output you have to save the output as $Result['content'].

Module $Result

content	module output
pagelayout	a template file for a custom pagelayout, or a boolean false to skip using a pagelayout
path	see Module Path

Examples

Use a Custom Pagelayout

A module can have a custom pagelayout template located at this path: extension/my_module/design/standard/templates/my_module/pagelayout.tpl. To use it in your module.php:

$Result = array();
$Result['pagelayout'] = 'my_module/pagelayout.tpl';

Module Path

A module can have one or more views. You should to define your views path in the $Result['path'] array.

Examples

No URL

$Result = array();
$Result['path'] = array( array( 'url' => false, 'text' => 'Database Query Manager' ) );

Two levels without URL

$Result['path'] = array(
    array( 'url' => false, 'text' => 'Order ' ),
    array( 'url' => false, 'text' => 'Refund Completed' )
);

Multi-level with URL

$Result['path'] = array(
    array( 'url' => '/', 'text' => 'Home' ),
    array( 'url' => '/account', 'text' => 'My account' ),
    array( 'url' => '/account/addressbook', 'text' => 'Addressbook' )
);

Multi-level with URL and node ID

Adding node IDs to the path will help you to mark parent items as selected in the site menu. In this example "My account" will be selected if node 78 is a folder.

$Result['path'] = array(
    array( 'url' => '/', 'text' => 'Home' ),
    array( 'url' => '/My-account', 'node_id' => 78, 'text' => 'My account' ),
    array( 'url' => false, 'text' => 'Addressbook' )
);

You will also need to set a dummy node ID for the menu selection to work, e.g.

$Result['node_id'] = false;

Operations

...

Troubleshooting

If eZ Publish doesn't seem to want to load your module, then you might want to check out some useful tips to get it to work at the Troubleshooting extensions page.

External reference

Forum: Building a module for EZP 3.9
Forum: Detailed developer's tutorial for writing modules
Forum: Tutorial: How to make module
Forum: How to use a module
Forum: Module parameters
Forum: Extension & module generator
Forum: Module Path
Documentation: Building an eZ publish module
Documentation: Module tutorial (Part 1)

Extended sort

Wed, 02 Dec 2009 12:18:58 GMT

Requirements

For taking proper advantage of this feature you should know something about:

writing an extended_attribute_filter (fetch content list)
SQL
the eZ Publish database layout

Function

There is an undocumented feature in the eZ Publish fetch content list function for sorting on arbitrary sql statements. On regular fetches this feature is not available. However, when including an extended_attribute_filter parameter in the fetch, eZ Publish allows the user to sort on any arbitrary sql clause.

Use

Add an empty 'extended_attribute_filter' parameter in the fetch like this: 'extended_attribute_filter', hash(). Then add a 'sort_by' parameter, like this: 'sort_by', $sql_statement.

The sql string in the $sql_statement variable is inserted directly in the ORDER BY sql clause. Tables included by a regular fetch content list are:

ezcontentobject_tree
ezcontentobject
ezcontentobject_name
ezcontentclass

which means that any fields within these tables can be used in the $sql_statement string. If a sort_by attribute is involved, the ezcontentobject_attribute table are also included.

Furthermore, if required one can add other tables in an extended_attribute_filter's code, giving you access to sort on any field or combination of fields in the database.

Examples

fetch( 'content', 'list', hash( 'parent_node_id', 2,
                                'sort_by', array( 'ezcontentclass.identifier ', true() ),
                                'extended_attribute_filter', hash()
    ) )

This example will sort the resulting node list by the class identifier string. Note that this will not work if the extended_attribute_filter parameter is not included.

fetch( 'content', 'list', hash( 'parent_node_id', 2,
                                'sort_by', array( array( 'cast( a0.data_text as unsigned )', true() ),
                                                  array( 'attribute', true(), 'article/select_attribute' ) ),
                                'extended_attribute_filter', hash()
    ) )

This sorts an attribute of the selection datatype in the article class by the selection id as a number (and not by selection id as a string, as is default for this datatype, which makes the sort fail on id's above 9). The second sort element tricks the fetch into including the ezcontentobject_attribute table in the sql, named as a0, but will not have any effect on the actual sorting.

fetch( 'content', 'list', hash( 'parent_node_id', 2,
                                'sort_by', array( 'obj.name ', true() ),
                                'extended_attribute_filter', hash( 'id', 'ObjectRelationSortFilter',
                                                                   'params', hash( 'relation_attribute_id', 337,
                                                                                   'related_class_attribute_id', 343 ) )
    ) )

Here is an example on how to sort the nodes by an attribute of the related objects in an object relations attribute.

This example requires an extended_attribute_filter to include the right tables, the main function of the code for this follows...see the extended_attribute_filter documentation for setting up this.

function sqlObjectRelationSort($params)
    {
        $sqlTables= ", ezcontentobject_tree AS node
                LEFT JOIN ( ezcontentobject_link AS link, ezcontentobject AS obj, ezcontentobject_attribute AS attr )
                ON ( node.contentobject_id = link.from_contentobject_id AND
                    node.contentobject_version = link.from_contentobject_version AND
                    link.contentclassattribute_id = {$params['relation_attribute_id']} AND
                    link.to_contentobject_id = obj.id AND
                    obj.id = attr.contentobject_id AND
                    obj.current_version = attr.version AND
                    attr.contentclassattribute_id = {$params['related_class_attribute_id']} )";
 
        $sqlJoins = ' ezcontentobject_tree.node_id = node.node_id AND ';
 
        return array( 'tables' => $sqlTables, 'joins'  => $sqlJoins, 'columns' => '' );
    }

As you see, this filter requires two parameters. relation_attribute_id is used to specify the attribute id of the object relation. related_class_attribute_id is used to specify the attribute id of the related object that is to be sorted on. This function requires that all nodes are of the same class, and all related objects in the specified object relation attribute are of the same class.

This can potentially be further expanded to sort on the attributes of the children of the nodes. This is left as an excercise for the reader.

Debugging

Whenever developing extended_attribute_filters or extended sorting, switch on the SQL output in the debug in settings/override/site.ini.append.php:

[DatabaseSettings]
 
SQLOutput=enabled
 
[DebugSettings]
 
DebugOutput=enabled

If you can't immediately see what is wrong, copy the complete sql statement from debug and paste it into your favourite SQL program. It is a lot easier to make the sql work there than to test it against eZ Publish.

Testing eZ Publish - Test System

Fri, 20 Nov 2009 22:20:50 GMT

Warning

The test system is considered ever evolving and backwards incompatible changes may occur. We do invite you to start writing tests for it, just be warned that the tests may need some updating as we evolve the system.

Getting started

Requirements

PHPUnit 3.2.x or newer: http://www.phpunit.de/
eZ Components

Installation

Update to at least trunk rev 22408.
Generate autoloads for the test system:

php bin/php/ezpgenerateautoloads.php -s

Running tests

To run all tests do:

php tests/runtests.php -D mysql://root@localhost/testdb

The -D parameter is required and is used to tell the test system what type of database, username, host and which database to use. Make sure the username you specify is allowed both create and remove the database. The DSN uses the following format:

databasetype://username:password@host/database

If you want to run a single test suite, just point to the directory containing a suite.php file.

php tests/runtests.php -D mysql://root@localhost/testdb tests/tests/kernel

Filter which tests to run

To run a single test you can use the --filter option like this:

php tests/runtests.php -D mysql://root@localhost/testdb --filter=testGlobBrace

In the above example both eZSysTest::testGlobBrace and eZSys::testGlobBraceSupported will be executed. If you only want to execute eZSysTest::testGlobBrace run:

php tests/runtests.php -D mysql://root@localhost/testdb --filter="testGlobBrace$"

This works too:

php tests/runtests.php -D mysql://root@localhost/testdb --filter="eZSysTest::testGlobBrace$"

As of PHPUnit 3 --filter can also be used to filter on test class names. This is a handy way of running all tests in a test case. Example:

php tests/runtests.php -D mysql://root@localhost/testdb --filter="eZSysTest"

List tests

To list all test use the --list-tests option:

php tests/runtests.php --list-tests

You can also narrow the output to only list tests defined in a specific suite:

php tests/runtests.php --list-tests tests/tests/lib/ezutils

Running a group of tests (group annotation)

With PHPUnit you can group different tests together by adding the group annotation to a method's documantion block:

To list all groups run:

php tests/runtests.php --list-groups

To run a group use the -g parameter:

php tests/runtests.php -D mysql://root@localhost/testdb -g issue_13492

Writing tests

Naming conventions

The test system itself follows eZ Components naming conventions defined here: http://ezcomponents.org/contributing/coding_standards#id8.

The tests itself follows the naming conventions of the code that it tests. In this case this means the tests follows the eZ Publish naming convention.

File and directory layout

The file structure used in eZ Publish is mirrored inside the test system. As an example, if you want to write tests for kernel/classes/ezcontentobject.php the test file should be located in tests/tests/kernel/classes/ezcontentobject_test.php. Regression tests for ezcontentobject should be located in tests/tests/kernel/classes/ezcontentobject_regression.php

*_test.php is the suffix used for unit tests. *_regression.php is used for as the suffix for regression tests.

Writing a unit test

The test system comes with a handy CLI script for generating stub tests from an existing class to get you going quickly. As an example, you can generate a stub test from kernel/classes/ezpreferences.php like this:

php tests/toolkit/extras/scripts/create-test-from-class.php \
               -s kernel/classes/ezpreferences.php \
               -d tests/tests/kernel/classes/ezpreferences_test.php

The generated tests/tests/kernel/classes/ezpreferences_test.php file will then look like this:

<?php
 
class eZPreferencesTest extends ezpTestCase
{
    public function __construct()
    {
        parent::__construct();
        $this->setName( "eZPreferences Unit Tests" );
    }
 
    public function testSetValue()
    {
        self::markTestIncomplete( "Not implemented" );
    }
 
    public function testValue()
    {
        self::markTestIncomplete( "Not implemented" );
    }
    // [...]
}
?>

To make the new test case work we need to add it to the appropriate suite.php. For this test case that is tests/tests/kernel/suite.php. Add

$this->addTestSuite( 'eZPreferencesTest' );

to the __construct method of eZKernelTestSuite and remember to regenerate test autoloads. To verify that the new test case is working run 'runtests.php' with -v:

oh:/www/trunk $ php tests/runtests.php -D mysql://root@localhost/testdb -v 
Based on ezcUnitTest in eZ Components
 
PHPUnit 3.3.0 by Sebastian Bergmann.
 
eZ Publish
 eZ Publish Test Suite
  eZ Publish Kernel Test Suite
   eZPreferencesTest
   IIIIIIII
 
[...]

Success! We're now ready to start writing the test by filling in the test* methods.

Normally tests are short and straight forward and should require little or no documentation. Due to the complexity of eZ Publish not all tests ends up being in this way. If you are writing a somewhat complex unit test, please document it a way that makes it easier to understand.

Writing a regression test

Regression tests are created in the same way as with unit tests, except the classes end with "Regression" and the file suffix is _regression.php. When writing a regression test please document it with the following:

Issue number + title of the issue.
Short description of the issue if the title isn't descriptive enough.
If the test is longer than a few lines, include what the test does in order to reproduce the issue.
The result and the expected result.
Link to the issue.

Here's a doc header example taken from testLinksAcrossTranslations():

/**
 * Test scenario for issue #13492: Links are lost after removing version
 *
 * Test Outline
 * ------------
 * 1. Create a Folder in English containing a link (in the short_description attribute).
 * 2. Translate Folder into Norwegian containing another link (not the same link as above.)
 * 3. Remove Folder version 1. (Version 2 is created when translating).
 *
 * @result: short_description in version 2 will have an empty link.
 * @expected: short_description should contain same link as in version 1.
 * @link http://issues.ez.no/13492
 */

If the issue has multiple tests group them together to make it easy to execute all tests for a single issue using the group annotation "@group issue_ISSUE_NUMBER" where ISSUE_NUMBER is the issue ID in the bug tracker. Example:

* @group issue_13492

Using a database

A common thing for tests is to interact with a database. By extending your test class or suite from either ezpDatabaseTestCase or ezpDatabaseTestSuite your test class/suite will become database aware. By default ezpDatabaseTestCase and ezpDatabaseTestSuite sets up a clean database using the dba files included in eZ Publish:

share/db_schema.dba
share/db_data.dba

Inserting your own data

If you need to provide your own schema/data you can override which SQL files is loaded by ezpDatabaseTestSuite by specifing the path to one or more SQL files in the $sqlFiles class method:

Example:

class eZURLAliasMlTest extends ezpDatabaseTestCase
    {
        protected $insertDefaultData = false;
        protected $sqlFiles = array( array( "kernel/sql/", "kernel_schema.sql" ),
                                             "kernel/sql/common/cleandata.sql" );
        // [...]
    }

Setting $insertDefaultData to false tells the test system that it should not attempt to load any data. If $insertDefaultData is not defined or if it's set to true the test system will first load the default data, then load any SQL files defined in $sqlFiles.

The first entry in $sqlFiles, array( "kernel/sql/", "kernel_schema.sql" ) is a way to provide a SQL file for one or more of the supported database types. If you're using MySQL, the test system would try to insert kernel/sql/ mysql/kernel_schema.sql. If the database type is postgresql, the test system would try to insert kernel/sql/ postgresql/kernel_schema.sql, and so forth.

The database type is determined by the -D (--dsn) parameter provided to the test runner.

Note: you can specify $sqlFiles on either your test class or in your suite. The default test runner behaviour is to only create a new database per suite. If you provide $sqlFiles in your test classes you will need start the test runner with the --db-per-test argument.

Providing extra data

In the above exampe we discussed how to override what data gets initially loaded into the test database. If all you need is to provide some additional data you can leverage the ezpTestDatabaseHelper class to load some extra SQL files:

$sqlFiles = array( "myextension/sql/data.sql" );
ezpTestDatabaseHelper::insertSqlData( $this->sharedFixture, $sqlFiles );

Writing tests for an extension

Extensions can include their own tests. When running tests the test runner will not only look for tests inside the tests/ directory, it will also scan each extension looking for a tests/suite.php file inside the extension. The extension does not need to be in the list of active extension (ActiveExtensions[] in site.ini) for it to be included.* The only critera for the extension to be included is that is has a folder "tests/" with a suite.php inside. The suite.php should then include all tests in the extension. Below is an example of a typical extension file layout and where the tests should be located:

extension
    |-- myextension
        |-- autoloads
        |-- design
        |-- modules
        |-- settings
        |-- tests
        |   |-- mytest1.php
        |   |-- mytest2.php
        |   `-- suite.php
        `-- translations

You can specify the path to an extension to only run tests for that extension:

php tests/runtests.php -D mysql://root@localhost/testdb extension/myextension

* Remember that you still might need to regenerate the autoload array for the extension depending on how it's built.

One database per suite

Currently, the default behaviour is that a database is created per suite, not per test. Creating/removing the database easily adds 1-2 seconds of overhead per test on the database management systems that eZ Publish supports out of the box (MySQL, PostgreSQL). However, there's an extension ezsqlite which allows you to use an in-memory SQLite 3 database to run the tests with.

If you pass in the argument --db-per-test to the test runner it will change from the default behaviour, one database per suite, to one database per test. It's strongly encouraged that you write tests that works with both --db-per-test turned on and off.

To illustrate the difference in speed, below is how long it takes to run all tests with --db-per-test:

php tests/runtests.php -D mysql://root@localhost/testdb --db-per-test
PHPUnit 3.3.0 by Sebastian Bergmann.
 
............................................
 
Time: 01:48
 
OK (44 tests, 99 assertions)

And without --db-per-test:

php tests/runtests.php -D mysql://root@localhost/testdb
PHPUnit 3.3.0 by Sebastian Bergmann.
 
............................................
 
Time: 19 seconds
 
OK (44 tests, 99 assertions)

Resources

Payment Gateway

Wed, 28 Oct 2009 11:27:58 GMT

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

About

There are many payment gateway service support available for eZ Publish.

Stable

Authorize.net - Use eZ authorize extension
eCart - Use eCard payment gateway extension
Fianet - Use eZ Fianet connector extension
Mercanet - Use eZ Mercanet extension
Ogone - Use eZ Ogone DirectLink & Subscription extension
Paynet - Use Paynet extension
Paypal - Use eZ paypal extension
Protx - Protx Payment Gateway extension or another proxt extension
Worldpay - Worldpay payment gateway extension
Invoice - Supported in eZ publish by default
Securepay - Use eZ securepay hack of eZ authorize (email kracker)
Iclear - Iclear payment extension
eZSips - Atos Origin SIPS payment gateway extension
eZ Cybermut Payment gateway for Cybermut extension
TeleCash - extensionTeleCash payment gateway
Firstgate/Click&Buy - Firstgate/Click&Buy Payment Gateway Extension
Comdirect / Coposweb gateway for eZ Publish - Part of xrowecommerce
DIRECTebanking v2.0 and DIRECTebanking.com - Paycode v1.0

Ideas

Google Checkout - I've heard of this being asked for in passing
Paypal Pro - I've also heard of this being asked for more directly.
Subscription Payment Gateway Extension
In Development: Saferpay.de Gateway

Experimental

Someone outlined Amazon support in the forums, it would be useful to see a packaged extension based on this contribution.

External reference

Forum: Payment Gateway Type
Forum: Documentation on payment gatways and workflows
Forum: Payment Gateways Pack: eZ integration with major providers
Forum: Payment gateway depending on shopaccounthandler selection
Forum: Payment gateway options based on Price

Workflow event type

Fri, 09 Oct 2009 17:45:40 GMT

Location

In the kernel, workflow event types are located in kernel/classes/workflowtypes. In extensions, custom workflow events are located in the eventtypes directory.

Extensions

How to add your own workflow event type(s) in an extension?

workflow settings file path: myextension/settings/workflow.ini.append.php
- setting: [EventSettings] ExtensionDirectories[]= myextension
- setting: [EventSettings] AvailableEventTypes[]=event_ myevent
design settings path: myextension/settings/design.ini.append.php
- setting: [ExtensionSettings] DesignExtensions[]= myextension
PHP file path: myextension/eventtypes/event/ myevent/ myeventtype.php
PHP class name: MyEventType
template for workflow event edit: design/standard/templates/workflow/eventtype/edit/event_ myevent.tpl
template for workflow event view: design/standard/templates/workflow/eventtype/view/event_ myevent.tpl

(the bold text represents the variable parts of the names, you should alter them for your extension)

Your event type class

Your own event type class needs to extend eZWorkflowEventType. After your class definition, you also need to register it in the system.

include_once( 'kernel/classes/ezworkflowtype.php' );
 
class MyEventType extends eZWorkflowEventType
{
    const WORKFLOW_TYPE_STRING = "myevent";
 
    public function __construct()
    {
        // Set descriptive name
        $this->eZWorkflowEventType( MyEventType::WORKFLOW_TYPE_STRING, 'My event' );
    }
 
    function execute( $process, $event )
    {
        // Do stuff...
 
 
        return eZWorkflowType::STATUS_ACCEPTED;
    }
 
}
 
eZWorkflowEventType::registerEventType( MyEventType::WORKFLOW_TYPE_STRING, 'MyEventType' );

Troubleshooting

If eZ Publish doesn't seem to want to load your workflow event type, then you might want to check out some useful tips to get it to work at the Troubleshooting extensions page.

Question: What documentation about eZ publish do you feel is missing

Wed, 07 Oct 2009 15:35:18 GMT

The Question

I pose this question to the participating members of the eZ publish community.

What documentation, of any type, medium, text/audio/video/interactive/quiz/, kind, etc related to eZ publish do you feel is missing, from the current public offering?

Recommendation for replies: use numbered lists!

Subjects

eZ publish - eZ template Guide (Reference)
eZ publish - eZ xml Guide (Reference)
eZ publish - Pocket Guide (Reference)
API: having an updated (and 100% documentation doxygen)
API: major classes to use and basic exemple (how to create a node/ fetch nodes/move/delete...)
eZ publish - Hacking eZ publish
eZ publish - eZ publish Cookbook
eZ publish - eZ publish Encyclopedia
eZ publish - eZ publish development ('Getting Development with eZ publish') (Advanced Concepts)
eZ publish - Kernel Hooks, Features, Breakdown
eZ publish - Implementation Guide ('What goes where to make eZ go!')
eZ publish - Database Documentation ('Who does what, how and why?','Understanding the eZ publish database data model and primary / foreign key relationships, the eZ way')
eZ publish - Community Contributions (individual, packages) Documentation
eZ publish - eZ and Ajax
eZ publish - SiteDesign Template HTML Default Tab Order
eZ publish - Multiple Sites with or without multiple databases
eZ publish - eZ publish and Subversion (hosting eZ publish site data from svn checkout at production)
eZ publish - SiteDesign as extension (howto + example contribution)
eZ publish - Translated Documentation + Problems Providing Accurate Translations
eZ publish - Operator Documentation
eZ publish - Workflow Documentation
eZ publish - Workflow Event Documentation
eZ publish - Cronjob and CLI Script Documentation
eZ publish - Datatype Documentation (Table of datatypes and uses)
eZ publish - Notifications
eZ publish - User Settings
eZ publish - Using eZ publish functionality (php code) outside of eZ publish itself. Getting Object Information
eZ publish - Comparison with / as a replacement for several dedicated software: blogs, wiki's, image galleries, forums, project management tools (bug systems, ...)
eZ publish - Integrating / connecting to other systems (the ERP plugins, phpBB, ... )
eZ publish - migrating from other systems (Wordpress, ...)

Things already covered

I think we need to discuss with the official doc team first, to know what they want to cover.

In my mind, the first two points (template and xml) are covered by the official doc. If things are missing, I don't think an external doc should fix it, but that should be done within the main doc (might be usefull to open it more to the community, otherwise, comments).

Not find documentation

Whether there are some documentation, I don't know where to look. Currently I'm studying EzPublish extensions, but I don't found yet any documentation about Module Hooks functionallity and implementation

indexing/searching pdf files with accented chars

Thu, 24 Sep 2009 13:57:56 GMT

eZpublish needs external tools for pdf file indexing. Path to that tool is set in binaryfile.ini

Originally i was using the pstotext too, but it does not work well and often gives garbage as output. Better tool is pdftotext from xpdf project, as suggested in this article.

In my case the above was not enough, as pdf files apparently are in iso-8859-1 but eZpublish expects UTF-8 as input.

So, the contents of ezpdftotext should be:

#!/bin/sh
pdftotext $1 -|iconv -f ISO-8859-1 -t UTF-8

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

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

Oracle

Thu, 10 Sep 2009 14:22:36 GMT

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

About

eZ Systems offers an Oracle extension for eZ Publish

External references

Documentation: http://ez.no/doc/extensions/database
Download: http://projects.ez.no/ezoracle/downloads
News: http://projects.ez.no/ezoracle/news
Very old News: eZ Publish Extension for Oracle® Database released under Open Source License ...
Forum: Problems with ezoracle extension installation
Forum: ezoracle extension
Forum: Connection to DataBase out eZ
Forum: PostgreSQL support, is it a yes or no?
Forum: eZpublish Database Extension and Oracle Express Edition

Bookmarked eZ publish Solutions for newbies

Mon, 31 Aug 2009 10:11:15 GMT

This info is quite old, based on eZp 3 series and may be partly obsolete now. Also, ezwebin that was introduced onwards from ez 3.8 breaks many things.

Bookmarks

Editing, creating and removing content from the user page / Tips & Tricks / Customization
http://www.ez.no/ez_publish/documentation/customization/tips_tricks/editing_creating_and_removing_content_from_the_user_page

Re: How Can create, remove, edit a object from the Pagelayout? / How Can create, remove, edit a object from the Pagelayout? / Developer
http://www.ez.no/community/forum/developer/how_can_create_remove_edit_a_object_from_the_pagelayout/re_how_can_create_remove_edit_a_object_from_the_pagelayout

Re: how to create a simple user interface for content creation ? / how to create a simple user interface for content creation ? / Setup & design
http://www.ez.no/community/forum/setup_design/how_to_create_a_simple_user_interface_for_content_creation/re_how_to_create_a_simple_user_interface_for_content_creation__2

Adding an action button / The guestbook / Building an eZ publish site
http://www.ez.no/ez_publish/documentation/building_an_ez_publish_site/the_guestbook/adding_an_action_button

Creating a tree-style appearence / The links page / Building an eZ publish site
http://www.ez.no/ez_publish/documentation/building_an_ez_publish_site/the_links_page/creating_a_tree_style_appearence

Developer toolbar / Specs / Developer
http://www.ez.no/community/developer/specs/developer_toolbar

Adding tree functionality to 3.4 subleft menu template / Setup & design / Forum
http://www.ez.no/community/forum/setup_design/adding_tree_functionality_to_3_4_subleft_menu_template

Left menu, exclude a node / Setup & design / Forum
http://www.ez.no/community/forum/setup_design/left_menu_exclude_a_node

Re: Online editors / Online editors / Suggestions
http://www.ez.no/community/forum/suggestions/online_editors/re_online_editors__34

Using a Different Online Editor / General / Forum
http://ez.no/community/forum/general/using_a_different_online_editor

XMLArea extension development / Developer / Forum
http://ez.no/community/forum/developer/xmlarea_extension_development

Limiting users to 1 site design? / Developer / Forum
http://www.ez.no/community/forum/developer/limiting_users_to_1_site_design

Re: multiple sites on one database / multiple sites on one database / Setup & design
http://www.ez.no/community/forum/setup_design/multiple_sites_on_one_database/re_multiple_sites_on_one_database__3

Changed RootNode and got serious url trouble / Setup & design / Forum
http://www.ez.no/community/forum/setup_design/changed_rootnode_and_got_serious_url_trouble

RootNode and Bread-crumbs / Setup & design / Forum
http://www.ez.no/community/forum/setup_design/rootnode_and_breadcrumbs

Override templates / Custom design / Customization
http://ez.no/ez_publish/documentation/customization/custom_design/override_templates

How to find the parent and grandparent of an object / Incoming / Documentation
http://www.ez.no/ez_publish/documentation/incoming/how_to_find_the_parent_and_grandparent_of_an_object

tree / Content / Data fetching
http://ez.no/ez_publish/documentation/reference/data_fetching/content/tree

Separate pagelayouts for ‘view’ and ‘edit’ - NOT POSSIBLE? / Developer / Forum
http://ez.no/community/forum/developer/separate_pagelayouts_for_view_and_edit_not_possible

Building an eZ publish module / Extensions / Development
http://ez.no/ez_publish/documentation/development/extensions/building_an_ez_publish_module

Redirect inside a tpl file / Developer / ForumBuilding an eZ publish module / Extensions / Development
http://www.ez.no/community/forum/developer/redirect_inside_a_tpl_file

how to use a parameter in a template operator? / Developer / Forum
http://www.ez.no/community/forum/developer/how_to_use_a_parameter_in_a_template_operator

urgent! important! how to store session variables????? / Setup & design / Forum
http://www.ez.no/community/forum/setup_design/urgent_important_how_to_store_session_variables

Function list / Functions / eZ template
http://ez.no/products/ez_publish/documentation/development/libraries/ez_template/functions/function_list

Adding a Remove Button/Image / Tips & Tricks / Customizationist
http://www.ez.no/ez_publish/documentation/customization/tips_tricks/adding_a_remove_button_image

Redirecting after content publishing / Tips & Tricks / Customization
http://ez.no/products/ez_publish/documentation/customization/tips_tricks/redirecting_after_content_publishing

Disabling drafts in user profiles / Developer / Foruming_after_content_publishing
http://www.ez.no/community/forum/developer/disabling_draf

eZContentObject class Referencets_in_user_profiles
http://pubsvn.ez.no/doxygen-3.4/classeZContentObject.html

Creating a new translation / Language and charset / Configuration
http://ez.no/ez_publish/documentation/configuration/conf

what is i18n / Developer / Forumiguration/language_and_charset/creating_a_new_translation
http://www.ez.no/community/forum/developer/what_is_i18n_

Common template issues / Examples / Custom design
http://www.ez.no/ez_publish/documentation/customization/custom_design/examples/common_template_issue

What to do if ez publish loads a blank page or error?

Mon, 31 Aug 2009 10:10:16 GMT

Clear the caches using a shell command (in sites root folder):

php bin/php/ezcache.php --clear-all --purge

Check var/log/error.log and php error log for more information.

eZ Publish

Sun, 23 Aug 2009 18:35:18 GMT

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

For a general description of eZ Publish, we recommend, eZ Publish on Wikipedia.

About

eZ Systems website ez.no is a primary source of resources related to everything eZ Publish.

Install

Checkout this article about Installation it has great 3rd party articles about installing eZ Publish.

Vendors

eZ systems is the creator and primary supplier of eZ Publish software and services. eZ Systems has a number of partners worldwide which also offer additional services, software and support.

Articles

None

References

None

Template logic and settings to provide rounded corners on image aliases

Sun, 23 Aug 2009 17:28:32 GMT

Abstract

Image processing is a very powerful feature of eZpublish. This article shows you how to combine 24 bit PNG images with ImageMagick via the eZpublish image alias system, and to produce images with pre-rendered rounded corners.

Approaches

There are a number of ways of approaching this problem.

It is possible to overlay a mask (a second image with a transparent centre) in an overlaid div, but this solution has one big drawback: Internet Explorer has patchy support for the only image format which has full alpha support, png24. Which means you are stuck with using a gif, and with jagged edges.

A much better way is to get ImageMagick, one of the graphics processors included with EzPublish, to do the work. It is theoretically possible to get ImageMagick to measure the picture and draw the mask, but this is complicated (if anyone gets it to work please let us know). These discussions may be a good starting place if you feel like taking this to the next level:

http://www.imagemagick.org/Usage/thumbnails/#rounded_border

This section of the ImageMagick useage manual gives details on this, but there are hurdles which would need to be overcome, such as getting ImageMagick in EzPublish to read external vector files (.mvg) and some more discussion here.

http://www.imagemagick.org/discourse-server/viewtopic.php?f=1&t=8401

For my particular use case we needed the resulting images to conform to an exact size, so rather than tackling the really hard stuff I elected to get ImageMagick to pull a png24 matt image from the design directory and overlay it on the source image. This is a simpler version of the technique described here:

http://www-128.ibm.com/developerw...y/l-graf2/?ca=dgr-lnxw15GraphicsLine
but as the final image size is pre-determined there is no need to add the corners individually.

Directions

This is what you need to do

Dependencies

The first thing you'll need to do is to establish whether the version of ImageMagick supports the -composite command. In the case of our host, Atvert Systems, we discovered that they were running the default version which shipped with the operating system - 6.0.7.1-16. (and this situation is quite likely for a professional hosting environment where system stability is more of a priority than having the latest versions of all components)

Luckily Karl, who runs Atvert, was very helpful in identifying the problem and he quickly upgraded ImageMagick to version 6.3.2.7-1, which supports the necessary commands.

Images

The next step is to make a test graphic, you can skip this if you are feeling really sure of yourself but I'd recommend it - you'll probably save yourself a few headaches. Make a two layer Photoshop (but make sure you convert the background layer to an normal one in PS's case) or Gimp file, put the word 'front' on one layer and the work 'back' on another, both with transparent backgrounds. Export the two layers as png24s with transparency. Put the 'front' one in your siteaccess images folder - that will eventually be your matt.

You now need to find out the 'fully qualified path' to that folder. It won't be the ftp path. In our case in involved prepending /var/www/html/ to the address you see in an ftp client. It's probably best to contact your hosting provider on this, unless you feel like a lot of guessing.

Settings

Next, open image.ini.append.php. you can do this in either the siteaccess copy or the override copy. Just don't do it in both ! :)

The first thing to add is the filter definition, it goes in the [ImageMagick]
section:

[ImageMagick]
Filters[]=rounded=-compose dst-over -composite -gravity NorthWest /var/www/html/ ... more path goes here ... /design/news_site/images/picmask.png

This makes a filter called 'rounded', makes the destination go over the source, references the overlay to the top left corner and calls the matt image
The -gravity switch may not be necessary.
Next, make an alias for the image which will use the filter:

[AliasSettings]
AliasList[]=mypicturewitharoundedborder

Finally, add the filters to the alias;

[mypicturewitharoundedborder]
Filters[]=geometry/scalewidth=156 Filters[]=geometry/crop=156;90;0;0
Filters[]=rounded=

The final filter applies the mask.

Save and upload the ini file, go to your EzPublish Online Editor, choose an image (the 'back' one you made earlier) choose the mypicturewitharoundedborder alias from the dropdown and publish. When you are happy that it's working delete the 'front' image and replace it with one that does something useful!

Special Thanks

Thanks to Bruce Morrison from DesignIT for his invaluable help in wrangling ImageMagick's sometimes slightly-less-than-intuitive command line syntax.

Community

Sun, 23 Aug 2009 10:02:14 GMT

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

For a general description of community, we recommend Community on Wikipedia.

eZ publish Community

The eZ publish community includes anyone and everyone who has used or uses eZ publish. (Partners, Developers, Users, Customers)

International blogging site

The primary source of eZ Publish related blogging can be found at planetezpublish.org

Localized community sites

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

eZ Components

Sun, 23 Aug 2009 09:39:07 GMT

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

For a general description of eZ Components, we recommend, eZ Publish on Wikipedia or eZ Components on eZComponents.org.

About

eZ Publish

eZ Publish 4 adds a new installation requirements including eZ Components which must be installed and available.

Articles

Reviews

References

TCO

Sun, 23 Aug 2009 08:06:14 GMT

For a general description of total cost of ownership, we recommend, Total cost of ownership on Wikipedia.

eZpedia - Suggestions

Sun, 23 Aug 2009 07:05:25 GMT

Please add your own suggestions! Append your entries to the end of each grouping :)
Please file issue reports (bugs, negative features, failures) on the issues node instead of this node.

Content

Article: squid proxy server(s) setup (as a front end cache/loader) in front of the eZ publish installation to cache static content (binary, anonymous cached templates, etc)
Article: Drafts Explained! From Default Internals to a number of supported alternate configuration
Article: Creating an extension (From design choices to implementation, aka Designing portable eZ solutions within extensions)
Article: Creating a design extension
Article: eZ publish extensions, designs and template override order

Design

Add: Minimal, Small, Unobtrusive + report a problem (css/float/dynamic position as user scrolls the pagelayout) link within pagelayout template
Add: Client Script (Javascript) to support floating left side menus during scroll down very long documents (which these will become). This allows the user to edit a page very quickly and avoid scrolling back to the top of the screen to use the control menus. Client script must be ie/moz compatible.
Add: Powered By eZ * Badge / Image into pagelayout.tpl in navigation / layout or .. an article node
Add: Help sidebar (like current users) with link to editors guidelines and general help (displayed to authenticated users only)
Add: What's changed since my last visit functionality (like ez.no)
Add: node breadcrumbs and back-links
Revise: CSS Style Colors for Source Code Language Highlighting (Ugly default colors, use eZ colors (blue, orange, black, white, ..)
Add: Email this page Icon into pagelayout
Add: PDF of this page Icon into pagelayout.
Add: PDF download of entire site (re-factored for real printing)
Add: Page / Node Ranking (Anonymous vs Authenticated, 1 - 7 stars)
Add: Discussion page for each page
Modify: Templates to use/link to the 'content/history' view instead of deprecated (eZ 3.9) 'content/diff' view (example: this->node(); )
Add: icon to external links, see Simple, accessible external links
Add: CSS classes for unordered lists to show file system structures (very useful to explain where specific extension files should be places), proposed classes: ul.filesystem, li.file (ul.filesystem li is implicitly recognized as a directory). Display filesystem-like icons in these lists instead of the regular list item icon.
Fix: The Ezpedia site's hompage appearance is broken when viewing with IE6 - main content of pages only starts at a vertical position below the end of the left-hand navigation. This means the site's main content appears non-existent unless the user scrolls down the page to find the content. Perhaps this is a problem with DIV settings because the homepage uses columns in the main content area, but other pages do not.

User Settings

Extend: role/group permissions over user created content (self, settings)

Content Markup

None at this time

Content Editing

Add: Moderator Group with ezapprove2 to moderate protected node (add protected node flag in into node class)
Add: Minor Edit (Boolean, into node class) during node edit
Add: 'people' namespace related image for person (re: images in wiki missing feature)

History

Add: replacement for usage of content/history with custom module view which accepts view parameters and displays last possible diff by default.

Search

Add: wiki_article template layout adjustment to include 'related' and or 'tag' search results from one or many (jquery box with tabs) within right side of article (adding container divs to layout for side by side presentation that is helpful not intrusive).
Add: User to set a setting to the affect the number of search results by default for their session (Example, I would use the larger increments to maximize searching time to one page of reading instead of 15 clicks and page loads)

Notifications

None at the moment.

General

Add: Display nodes by owner (consider search by owner)
Add: Google Translate (new extension) to enable members of translate group or automated cronjob to provide auto-translation of en_GB contentobjects from en_GB to known, documented, supported languages (sets).
Add: Tree Browser (outliner, light weight, performance enhanced, descriptive text content toggle in navigation)
Suggest: Notion of tagging (adding weight to dynamic object relations or categorization) (or will 3.9.x object relations help in this kind of effort)
Suggest: Wiki custom extension (name, 'soapTagThreadMessage'). Which provides a pre-configured ssl web service api to authenticate, register, logout, tagCurrentURL (which stores url and scraped thread messages (print view) for storage). UI Component implemented in client side script to hover within layout via (greasemonkey style / ui embedding) with controls to fulfill 'serviceTag' feature set (without requiring redirect of current page). Notion Requires moderator of input content to move tagged urls from 'submitted' into 'categorized' (node). Allows forum users or moderators on ez.no flag threads on ez.no forums or resources for a corresponding documentation (stub) entry should be created for later categorization.

Extended Documentation

Add: Audio Documentation (OGG, MP3) - Tutorials, Training, Demos, Sales, News, Conversations, Comments
Add: Video Documentation (Flash, OGG) - Tutorials, Training, Demos, Presentations, Events

Install

Installation (pending) list of requested extensions, design or other ezpkg.

Install: ezapprove2 extension
Install: ezsvn extension

Upgrades

Upgrade: eZ Publish 4.1
Upgrade: eZ Online Editor 5

Disable

None at the moment.

Implemented

~~Add: Printable page link within anonymous pagelayout template header menu. Only added menu link to registered users template for testing and further refinement.~~
Patch: OE to support default disable of right-click menu, enable with additional OE toolbar button! The reason to do this is to allow for firefox2 to use the spellcheck features without having to disable the online editor. I have a patch for this --kracker. gb@2009/08/21, Implemented suggestion to improve spelling content before migrating to ezoe5.
~~Add: Global Namespace History View - To see all node activity and history not just the current page.~~
Add: Email notifications Sent should include a simple patch style diff to see the scope of the changes rather than require an editor to review and diff the history by hand. Email should also contain a direct link to diff the changed version with the previous version. This is kinda important. Direct link has been requested in #9585.
~~Add: User notifications also include diff in email with history link to revision + previous revision (prolly dup entry from above)~~
~~Add: RSS Feeds (Site wide recently modified entries from each namespace)~~
~~Add: Sitemap link in design~~
~~Add: User draft display. Currently users can not see their own unpublished drafts to resume editing!~~
~~Add: Increase search result number of items per page, to 15 (simple temporary improvement until user control is implemented). gb@2009/08/21, A while ago I added some improvements to this template.~~
Add: User control of search result number of items per page, including large number of items example, 100. Increments: 14, 25, 50, 75, 100. See search (view) page for implementation details. gb@2009/08/21, This was added recently to the template.
User Authentication - Forget password functionality. Added a heading, description and clearly link to the user forget password functionality on the user templates (example: the user login view template)
~~Install: google sitemap extension. I did not enable this specific extension but did enable a cronjob to generate sitemap and submitted it to google.~~
Add: User preference : Add user preference to support creation or modification only in user's chosen language (setting). Which would prevent endless draft language confirmation choices. Default users chosen language 'en_GB' on account creation. Related thread not implementation. Implementation may contain an override template for the template view which can accept the default language to use, within this template you would include a template operator call to a function which would fetch a user's default language selection (en_GB, none / false) and output the control code needed to prevent repative confirmations of a default language preference per editor / user. This may also require a per user (editable) setting of content default langauge.
~~Add: OpenSearch auto-discovery on each page and buttons to add plugins on search page~~
~~Add: Search in content/browse (Note: This seems to be added ... yet the search in any view does not work or return results. This is a bug.)~~
~~Create: Firefox Search Engine plugin for pubsvn.ez.no/wiki (using ez search)~~
~~Create: Firefox Search Engine plugin for pubsvn.ez.no/wiki (using google)~~
~~Add: User Settings Modification (Pagelayout Link)~~
~~Add: user navigation (header) titled 'setting' (link to '/wiki/en/user/settings' url redirection) which links to the user edit view (link ez.no)~~
~~Upgrade: eZ (to 3.9.x upon confirmed stable)~~
~~Upgrade: OE 4.2 (to latest confirmed stable)~~
~~Add: Disclaimer link 'license' in footer to node 'about/disclaimer' saying 'All content licensed under GFDL' and extended description.~~
~~Add: Editor Guideline: Please only ezobject:// to reference specific content objects.~~
~~# Add: search results and advanced search override templates customized to maximize use in large database (google navigator etc) - Example #1~~
~~Disable: (Global) Redirection Debug - Editing is for users which should have overrideable settings. Disabling this by default will improve performance greatly for non-authenticated user-agents.~~
~~Add: custom tag for content markup formatting style 'strike-through'. To be able to strike items in formatting before removal.~~
~~Add: User preference : Disable/Enable Redirection Debug and or debug output - Might prevent endless clicking to confirm redirection attempts, which is essential if draft storage fails.~~
~~Add: Design Header Logo Images : 'eZ publish community documentation' (header) and 'eZ box icon' (sidebar nav)~~
Add: DNS A records for (pubsvn, community) brands. Can this be requested is this possible or desired? I suggest the following entries in order of preference 1. http://ezpedia.org 2. http://edit.ezpedia.org 3. http://doc.community.ez.no 4. http://doc.com.ez.no 5. http://ezpedia.ez.no 6. http://doc.pub.svn.ez.no 7. http://doc.pubsvn.ez.no 1. Also make an another dns entry for alternate content (replace pubsvn static html homepage, rebrand as community 'projects' + repository / svn tools) 1. http://community.ez.no 2. http://com.svn.ez.no 3. http://pub.svn.ez.no 2. Also an entry for sitewide rss agregator (svn tools + wiki) 1. http://rss.community.ez.no 2. http://rss.com.svn.ez.no 3. http://rss.pub.svn.ez.no
~~Add: Stub Flag (boolean, into node class) during node edit~~

Package

Sat, 22 Aug 2009 15:26:21 GMT

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

For a general description of package, we recommend Software package on Wikipedia.

What is a package?

An eZ publish package is used to distribute certain parts of an eZ publish installation to other eZ publish sites. These parts include content classes, content objects, site styles and extensions. The setup wizard also uses packages, the so-called "site packages".

File format

An eZ publish package file can be recognized by it's filename extension .ezpkg. Package files do not have their own MIME type, they are served as the default type application/octet-stream.

Actually a package is a gzipped tar file. The PHP zlib extension is required because it is used to compress and decompress eZ publish packages.

The package file contains a file called package.xml. This file contains the package definition in an XML dialect.

Package management

You can create, install, or remove packages with the online package manager or with the command line package manager.

Compatibility

"Based on my experience, packages between version don't work smoothly. I'd suggest to copy the db and do an update by hand with the provided mysql/postgres sql files + run the php if needed." -- X+

Tip: Avoiding package download errors within setup wizard

If you ever have trouble during the setup wizard downloading default eZ Publish packages like eZ Flow or eZ Webin you can download these packages yourself from http://packages.ez.no/ezpublish/ into the 'packages' directory. Make certain the web server can read and write to all the files in the package directory.

Solutions

Creating, Managing, Deploying and Maintaining eZ publish Packages

External resources

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

Heath

Sat, 22 Aug 2009 13:08:00 GMT

About

I develop php web applications using eZ Publish

I also help others by answering questions on the ez.no forums

I am interested in contributing to your documentation project.

I'm not certain where I will start writing perhaps within your discussions answering questions.

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, http://serwatka.net/blog
A blog about eZ Publish with template development training articles, http://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, http://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.

http://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

kracker

Fri, 21 Aug 2009 17:40:13 GMT

The Quote

I do it, for myself --kracker
The eZ publish community includes anyone and everyone who has used or uses eZ publish. "The eZ publish community reminds me of an idea I found in a Disney film called 'Lilo and Stich' which for a time popularized the phrase 'Ohana' which means family, and family means no one gets left behind or forgotten". --//kracker

An interesting difference in opinion or just the way they chose to run it.
From: http://www.gnu.org/philosophy/stallman-kth.html

<dl><dt>Q:</dt><dd>So it boils down to ownership of  information.  Do you think there are any instances  where, you opinion, it's right  to own information?  </dd><dt>A:</dt><dd>With information that's not generally useful, or is of a personal nature, I would say it's OK. In other words not information about how to do things, but information about what you intend to do. Information whose only value to others is speculative, that is they can take some money away from you, but they can't actually create anything with it. It's perfectly reasonable I'd say to keep that sort of thing secret and controlled.  But in terms  of creative information,  information that people can use or enjoy, and  that  will be used  and enjoyed more the more  people  who   have it, always  we should   encourage  the copying.</dd></dl>

Brutal Thoughts

I should write more.
Most people don't know how to create a design extension or have a reference guide for implimenting functionality by type within an eZ publish (system type) extension
Common problems shared but not addressed by all eZ publish default / stock users, hold everyone back for a long time.
eZ publish documentation needs should have spawned the publishing like book publishing of a lot more than has ...
Order by release number accending for changelogs is a best practice
I think too much.
eZ systems has renamed everything formerly capitalized as {%l%C%s%l} (%l = lower case, %C = capital case, %s = Non breakingspace) to {%l%C%s%C} (%l = lower case, %C = capital case, %s = Non breakingspace) !!!!! This is more confusing than keeping the original standard naming convention for .... everything (but mostly product branding and marketing). This means eZ publish is now eZ Publish, which I think just looks silly all together.
eZ publish preview does not include the full pagelayout to match the default siteacess .... why? This affects layout display positioning among other problems.
The eZ publish forums rock, you can markup your text content entry using hand typed psudo xml markup. You can not use the online editor with them.

A few links

View my wiki user
eZpedia sitemap view.
A blogger with eZ publish lessons learned along the way.
A few thoughts about the eZ publish community through another groups similar conversation
A popular us based remote site stat/ranking report on eZpedia
CMS Requirements evaluation of eZ Publish by GNOME.

My Nodes

eZ publish community suggestions
PubSVN, replacement default node
eZ photos

Notions

Everything eZn (Zen)

Share peace (of mind) here ...

Everything eZ

Documentation is the solution to the current community's problems
Who will stand up and take a stand?

If you experience an issue, side affect, problem (of any kind) and you do not publicly tell someone, you doom some else to the same fate.
What stand will you take to the communities fate?

eZ publish community documentation participation is the only answer I see to turn the tide to what I view as a lack of different types of documentation (targeting each different types of eZ publish users)
What documentation do you need, what kind of user are you, what is your budget and why are you not supporting the community?

Spelling is optional (using Firefox v2.0+)

Promotion

Fri, 21 Aug 2009 16:58:31 GMT

Articles about eZpedia

Promote eZpedia by writing about us online and linking to our site. Here are a few articles about eZpedia.

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


2009-08-21	eZpedia link on Digg	English
2009-08-21	eZpedia link on Reddit	English
2008-01-01	eZpedia ! blog article by Piotrek Karaś	English
2006-12-08	eZ publish community world map (via eZpedia)! blog article by Kristof Coomans	English
2006-11-28	eZpedia ! blog article by Damien Pobel	French

eZpedia - Issues

Fri, 21 Aug 2009 14:32:53 GMT

Please report any issue (bug, negative feature, failure) you may have encountered.
If you have a feature request please edit the suggestion node instead.

Open Bugs

Issue : When switching between site accesses with different languages, the cookie used for the static-caching-with-user-login hack is deleted. Users should be logged in for all site accesses (except for the admin access of course). We can use the solution described in this forum topic.
Issue : Upgrade to eZ Publish 4.1 which includes several view count cronjob bug fixes currently preventing update of view count. (Re: <link href="http://ez.no/developer/forum/setup_design/apache_view_count_incompatible_with_host_config">Bug report</link>)

Missing Features

Missing Feature : Images : Does not allow for image(s) upload during node editing or otherwise
Missing Feature : Editor Version Management : Does not allow for node(s) revert (to last or 'n' revision) or restoration unavailable to any community editor (with namespace permissions)!!

Negative Features

Most of these have to do with eZpedia's current reliance on ezdhtml4 instead of ezoe 5.

Negative Feature : Input Field Spellcheck : OE Right Click Menu (Can not be disabled simply with a checkbox in editor. This prevents Firefox v2.0 spell checking features)
Negative Feature : Permissions and menu links : Left menu displays edit button without first checking user permission to ensure user does indeed have edit permission for that node before displaying the link.

Failures

Most of these have to do with eZpedia's current reliance on ezdhtml4 instead of ezoe 5.

Issue: Text gets removed when trying to put a link on certain text, bug #10090

Past Failures

Most of these have to do with eZpedia's current reliance on ezdhtml4 instead of ezoe 5. Presently these failures do not apear to be occurring (as of 2009/09/16)

Issue: Path to icons is not right in eZ online editor help, bug #9338
Issue: Path to object_insert.png is not right in the eZ Online editor input field, bug #9663

Resolved Issues

Missing Feature: Show namespace before subject if it's not the main namespace, sitewide. This makes it a lot easier to, for example, link to other articles: RSS exists in both the main namespace as the about namespace and we currently don't see the difference in the browse view.
Issue : When switching between different language the host becomes pubsvn.ez.no, To simplified, ezpedia.org should be the unique host and all others accepted hosts should redirect to ezpedia.org. (it's better for SEO too)
Negative Feature : Fatal : OE/eZ input parser fails ... often. Requires user to Go->Back to edit out offending parser errors in ezxml markup and save draft properly.
Issue: When using search in the "insert link" dialog of the eZ Online editor, the link text is lost
Negative feature: drafts of user objects keep polluting the database. We should automatically remove them with a script on a regular basis via cron. Related bug: #9798
Issue : Role Permissions : Account settings editing gives permission denied. Meaning users can't edit their account settings (email, etc)
Issue : Mail headers are sometimes cut off, maybe related to bug #9030
Issue : OE : OE toolbar buttons do not load desired functionality in opened popup window
Negative Feature : Performance : OE Popups are very very slow loading
Negative Feature : Performance : Account activation email, required for login may be slower than expected, but yes it will really eventually send your account activation email --//kracker
Negative Feature : Account Activation : After normal activation, If you login right afterwords in another window. Upon login you get this non-fatal informational error. "Activate account, Sorry, the key submitted was not a valid key. Account was not activated.".
- Which does not affect the now-logged-in user's feature if the error is ignored. --//kracker
- I'll have a look at it, I guess this is a minor bug in eZ (ui_context not being properly set by user/activate, bug #9434). --kristof

Custom Tag

Fri, 21 Aug 2009 13:02:44 GMT

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

Definition

Custom Tag. A custom defined xml tag.

A custom tag represents custom content not stored directly within the content object itself. This can be almost anything you could imagine which makes the custom tag a very flexible solution to storing links to content not stored within the content object.

Example: Latest news box or remote weather box or simply a template with static html/javascript/css source code like an ads banner javascript/html/css source code from a 3rd party vendor.

Custom tags are created within the eZ Publish system before they are inserted into content object content with the Online Editor.

Usage

Here is a basic example of the key parts of creating a new custom tag.

Examples

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

Map Address

External resource

Doc: Custom tags documentation
Doc: Old custom tags community documentation
Forum: Custom Tag
Blog: Inclure une vidéo de DailyMotion, Youtube ou autre dans eZ publish

Snippets

Fri, 21 Aug 2009 12:59:47 GMT

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

Snippets of eZ Publish related source code

About

A place to document existing references of eZ publish related source code snippets.

While a wiki is not the best place to store and maintain software source code snippets often it is one of the quickest ways to quickly distribute example solution source code snippets.

eZpedia offers the 'snippets' namespace folder a quick place to store snippets of example source code (in just about any language; php, eztpl, ezini, ezphp, sql, javascript, bash, perl, etc).

While this page documents existing snippets of source code from various locations like the forums and eZpedia, there is a new project to collect and refine example snippets of eZ Publish related source code snippets (of any lanugage) at projects.ez.no/ezsnippets

External references

PHP

Those seaking eZ Publish API code samples in PHP would be wise to also study the eZ publish source code and doxygen api documentation.

Forum: Create a binary file within eZ using PHP
Forum: Create a binay image file within eZ using PHP
Forum: Create a folder within eZ using PHP
eZpedia: Snippet: eZ cli data creation script (unstable)
eZpedia: Snippet: eZ cli lorem ipsum data creation script (unstable)
snipplr.com: ez-publish snippets

Javascript

Forum: Javascript click to enlarge image example snippet

Discussions

Fri, 21 Aug 2009 06:04:34 GMT

Discussions about eZ Publish on eZpedia

Note: Take notice to the 'Discussion' links which appear within the 'This article' box on the left side menu only when discussion forums have been created for specific topic discussions.

General discussions can be found in our main discussion forum.

You can always check the latest discussions view for the most recent activity.

News

Fri, 21 Aug 2009 03:32:27 GMT

Changelog

All about eZpedia's changes, improvements and additions.

2009-08-20 - Update - eZpedia adds list of latest pubsvn.ez.no nextgen repository activity to revised home page layout. Added display of issues related to the svn commits displayed. Also adds latest latest pubsvn.ez.no nextgen repository activity rss feed. Also added standard feed icons to templates with eZpedia.

2009-08-19 - Update - eZpedia adds list of latest updated discussions to revised home page layout. Also adds latest discussion rss feed.

2009-08-17 - Update - eZpedia adds list of latest updated articles to revised home page layout. Also adds latest updated content rss feed.

2009-08-16 - Update - eZpedia re-enables support for content diff notification emails. This allows you to see what changed without going to site.

2009-08-16 - Content - eZpedia adds language support for ger-DE, pol-PL and por-PT language translations.

2009-08-09 - Content - eZpedia reorganizes content into minimal namespaces

2009-04-01 - Upgrade - eZpedia upgrades to eZ Publish 4.0.3

2007-08-21 - Upgrade - eZpedia upgrades to eZ publish 3.9.5

2007-09-04 - Upgrade - eZpedia upgrades to eZ publish 3.9.3

2007-01-01 - Press - 'Happy New Year' from the eZ community!

2006-12-19 - Upgrade - eZpedia upgrades to eZ publish 3.9.0.

The following new features in the 3.9 branch will be quite useful for the wiki:
History view, Class/classattribute name translation
XML block: improved custom attributes, Improvements to related objects added from XML block text field, other new features

2006/12/08 - Press - Announced eZpedia on ez.no forum!

2006/11/10 - Content - Added news node!

2006/11/13 - eZpedia updated to the latest eZ online editor 4.1.5

2006/11/09 - Performance - Improved oe performance and toolbar button issue, bug fix.

2006/11/06 - Upgrade - eZ publish to version 3.8.6 + eZ publish online editor to version 4.1.4 + Lucene search plugin

Recent discussions

Chinese language of ezpedia.org

2010/02/18 @ 11:46:57 : Xiongjie Chen : Good

Chinese language of ezpedia.org

2010/02/18 @ 11:25:46 : Heath : Taking the initiative ...

Chinese language of ezpedia.org

2010/02/17 @ 08:42:42 : Xiongjie Chen : Thanks Heath

Chinese language of ezpedia.org

2010/02/17 @ 04:19:56 : Heath : Great Idea!

Chinese language of ezpedia.org

2010/02/16 @ 15:18:27 : Mingxing Chen : Greetings from China

Performance Tuning eZ Publish 4

Fri, 21 Aug 2009 00:02:53 GMT

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

About

Recommended eZ Publish 4 Apache configuration improvements for best possible production web server performance.

Topics

Application / Web Server

Apache

The basis of Apache PHP application server configuration requires virtual host configuration be stored within Apache solely.

The htacess Problem

The basis of Apache PHP application server configuration best practices for performance is preventing the use of htaccess configuration usage as not-possible as it prevents best practices and reasonable performance.

This is because .htaccess files are check per http request, ie: per file included on webserver from browser within html page (including html page) ie many many times per requested page to set any required httpd / php application configuration variables / conditions / etc (ie: loading the web server configuration) from direct disk access each time (not cached).

This represents a tremendous systemic performance problem that can only be resolved by relocating all configuration changes to the Apache virtual host configuration file and disabling .htaccess file access completely.

Remember htacess files configuration syntax is almost always different than the same applicable syntax within an apche virtual host configuration file.

Disable htaccess

Here is an example of how to disable htacess file access using the AllowOverride None setting. This example would be added within your virtual host configuration file for your we eZ Publish installation within Apache.

<Directory /var/www/path/to/ezpublish>
  Options Indexes FollowSymLinks MultiViews
  AllowOverride None
  Order allow,deny
  allow from all
</Directory>

Recommended Apache Modules

mod_expire - Greatly improves performance
mod_rewrite - Greatly improves application server flexibility and provides for clean user friendly aka nice urls.

PHP

I recommend increasing the following default php.ini variables to increase default limits to prevent future performance and upload limits from being reached as the default configuration is insufficient.

memory_limit
max_input_time
upload_max_filesize
post_max_size

Database Server

A word on database performance improvements.

MYSQL
PGSQL
ORACLE
MSSQL

References

Doc: x
Article: x
Forum: x
Forum: x

Coding standards

Thu, 20 Aug 2009 22:59:04 GMT

What follows is based on certified results and has been tested and proven in practice. Please discuss any corrections and additionally needed information before making changes.

About

About software coding standards

General

Enforcing a software coding convention is a recommended best prance

What convention should I use?

The answer is simple. It's your choice. Your free to choose.

Yet it is strongly recommended that you follow the recommended convention.

If you are creating an ezpublish extension / site use the ezpublish conventions as they are directly applicable.

However if you are creating an ezcomponent itself you will want to use the ezcomponents conventions as they are directly applicable.

eZ Publish

eZ publish has it's own coding standard convention. This convention has evolved over time but the documentation regarding these improved methodologies.

eZ Components

eZ Components also has it's own coding standard convention

External references

Dated List

Thu, 20 Aug 2009 20:44:41 GMT

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

Alphabetical list

Thu, 20 Aug 2009 20:41:32 GMT

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

Introduction

Thu, 20 Aug 2009 18:30:32 GMT

Welcome to eZpedia!

eZpedia is a community driven effort who's goal is to create complete sets of freely available 'eZ Publish' documentation created and maintained by the community for the community.

Namespaces: Updated, New | eZ, Solution, Learning, Project, People, About, Template, Help, Snippet (eZp3), Spotlight, Historical, Minutes

If your looking for a general overview of eZpedia review the contents of each namespace.

Subjects

Read and update documentation on any eZ subject current or otherwise, created by the members of the community or from eZ Systems

Learn! Start learning and practicing developer, development and extension documentation which educates how add new or extend existing functionality within eZ Publish
Search! For solutions to questions previously solved and best practices
Study! The source code api documentation and api source code snippets
Report! Review and report unique issues using eZ Systems' issue management site for all their products (eZ Publish, eZ Components, eZ Newsletter, Online Editor, eZ Find)
Review! Changelogs
Read! The list of latest commits to the eZ Publish public subversion repository via RSS or StatSVN
Download! The latest eZ publish source code, extensions, source code and official releases

Tips

Read! Our faq of documented problems, experiences, references and solutions!
Search! Still searching for answers, experiences or references? Consider searching eZpedia, GooZee, ez.no, or your favorite search engine via helpful browser search plugins with related keywords.
Write! Still can't find a clear answer? Ask your questions in clear, detailed, unique way via the irc and then in forum.
Clear! Try clearing all the cache!
Support! Support eZ community projects!

Wei Dai

Thu, 20 Aug 2009 04:16:19 GMT

About Me:

I come from China and live in China. David Adam is my English Name. :)

Date of Birth: 1979-02-14
Home Town: Xiangtan, Hunan, Provence - Do you know the first Communist Leader of China, Mao? This is where he came from.
Employer: Bysofts Since 2008

I am interested in many things, including philosophy, sociology and economics.I am also a Zend Ceritified PHP5 engineer and Certified eZ Publish Developer. ^_^

What I want to do:

I can translate articles in English into Chinese, write articles in English and Chinese, and perhaps share some extensions from our own projects.

Show your appreciation:

If you want to show your appreciation for the things I help you with ...

Then please think about doing something back:

Correct the mistakes I made in some articles or comments. :)
Support our work, fund development and documentation which meets your own unique needs.
Share your own extensions as free software
Support organizations that support free up control of media and information in China. Pro liberty.

Free your mind and spread freedom.

Thank you!

Website

readtheweb My personal blog on web development and other interesting things.

Graham Brookins

Wed, 19 Aug 2009 18:01:21 GMT

Facts

Date of Birth: 1980-01-24
Home Town: Anchorage, Alaska
Employer: Brookins Consulting, since January 2001

Show your appreciation

If you want to show your appreciation for the things I help you with ...

Then please think about doing something back:

Submit your own extensions as free software
Support our work, fund development and documentation which meets your own unique needs.
Start your own business, work with smart people
Support organizations that come up in support of freedom, rights or nature

Free your mind and spread freedom.

Thank you!

Links of Interest

Audio: IBM: ShortCuts
- Cut #25: Becoming a wiki evangelist
- Cut #24: How to structure a wiki
Map: eZ Publish Community Users

Website

Graham's Blog
Brookins Consulting
Brookins Consulting (Blog)
Brookins Consulting is an eZ Publish Partner
Brookins Consulting public eZ Projects and Contributions

FAQ For eZ Publish 3

Wed, 19 Aug 2009 09:49:07 GMT

This page contains answers to some of the most frequently-asked questions from the forum.

Preventing php maximum execution time exceeded errors

If loading a page takes very long and then finally you get an fatal error "Maximum execution time of 30 seconds exceeded". What to do now?

If your looking for solution to preventing php maximum execution time exceeded errors, Increasing the max_execution_time PHP setting will mostly fix this problem. However, sometimes there are other solutions to the maximum execution time exceeded errors. You may also see this forum thread.

How do I remove index.php from URLs?

Have a look at this article.

Improving eZ publish environment and performance

If your having performance problems review this forum discussion.

Improving web server performance

If your looking for the very best eZ Publish web server performance have a look at this article on lighttpd.

Disabling language selection when creating content objects

If your looking for a way to disabling language selection durring the creation of content objects in the admin, forum, etc see this forum thread.

Retrieving all packages for eZ Publish 3.8

If your looking for a way to retrieve all packages for an eZ Publish 3.8 installation, consider upgrading x)

Converting encoding from iso-8859-1 to utf-8

If your looking for a way to convert your encoding from iso-8859-1 to utf-8 have a look at this forum thread.

Importing content into eZ Publish

If your looking for solutions to importing content into eZ Publish have a detailed review of this article on import.

Supporting a payment gateway in eZ publish

If your looking for information on how to support a payment gateway in eZ Publish have a thorough review of this article and it's references.

Comparing eZ publish with other software packages

Have a look at this article with references to several different discussions on this topic.

Variable $node is not provided in pagelayout.tpl

This is just one of several different examples of a rather long story ends with the user creating and populating this variable by custom modification within their own pagelayout.tpl as this variable is no longer provided by the default template variables set by eZ Publish internally.

FAQ

Wed, 19 Aug 2009 07:41:11 GMT

This page contains answers to some of the most frequently-asked questions from the forum.

Preventing php maximum execution time exceeded errors

If loading a page takes very long and then finally you get an fatal error "Maximum execution time of 30 seconds exceeded". What to do now?

How do I remove index.php from URLs?

Have a look at this article.

Improving eZ publish environment and performance

If your having performance problems review this forum discussion.

Improving web server performance

If your looking for the very best eZ Publish web server performance have a look at this article on lighttpd.

Disabling language selection when creating content objects

If your looking for a way to disabling language selection durring the creation of content objects in the admin, forum, etc see this forum thread.

Converting encoding from iso-8859-1 to utf-8

If your looking for a way to convert your encoding from iso-8859-1 to utf-8 have a look at this forum thread.

Importing content into eZ Publish

If your looking for solutions to importing content into eZ Publish have a detailed review of this article on import.

Supporting a payment gateway in eZ publish

If your looking for information on how to support a payment gateway in eZ Publish have a thorough review of this article and it's references.

Comparing eZ publish with other software packages

Have a look at this article with references to several different discussions on this topic.

Variable $node is not provided in pagelayout.tpl

Discussion

Wed, 19 Aug 2009 07:07:41 GMT

No known issues related to help currently in discussion.

URL alias name pattern

Tue, 18 Aug 2009 14:54:00 GMT

This is compatible with eZ Publish 3.

Compatibility

The issue described in this article has been addressed in eZ publish 3.10.

The patches described are for eZ publish3.10/3.9/(possibly before) respectively.

Users of eZ Publish 3.10 or greater can simply take advantage of this feature right out of the box.

Current situation

Before eZ Publish 3.10, the object name pattern which you can specify in the content class is also used to create the nice url's. Sometimes this is not really what you want:

clients don't keep the titles at a reasonable size
you use a special character set, of which the characters are not supported in the url

What this patch does

This patch adds a second name pattern to the content class, which is used to create the nice url's. If you don't fill in the URL alias name pattern, the system falls back to the object name pattern. Actually it's quite similar to the "post slug" feature in Wordpress. The patch was merged into the eZ Publish core for version 3.10.0alpha1 and is a standard feature now.

There are other ways to circumvent the issues described above, like using the rule based transformation of characters by the eZCharTransform class, which can be configured in transform.ini. But I only discovered this possibility after making this patch.

Installation

You can download the patched files from the pubsvn community repository.

You can just copy the files for your major eZ publish version from the patches directory over the original files of your eZ publish installation. Make sure you backup the original files first. Afterwards, run the SQL in patches/dbschema.sql on your eZ publish database.

External resources

utf8

Tue, 18 Aug 2009 11:52:45 GMT

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

For a general description of utf8 we recommend utf8 on Wikipedia.

About

utf8

About

Abstraction

Tue, 18 Aug 2009 11:51:35 GMT

For a general description of abstraction we recommend abstraction on Wikipedia.

PHP Snippet Hiding or unhiding subtrees

Tue, 18 Aug 2009 10:56:21 GMT

This is compatible with eZ Publish 4.

About

eZ Publish content object tree node visibility can be changed.

Example code

if ( $node->attribute( 'can_hide' ) )
{
    if ( $node->attribute( 'is_hidden' ) )
    {
        eZContentObjectTreeNode::unhideSubTree( $node );
    }
    else
    {
        eZContentObjectTreeNode::hideSubTree( $node );
    }
}

References

Doc: node visibility

Setting: Disable Dirty Object Draft Edit Show Versions View

Tue, 18 Aug 2009 05:11:50 GMT

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

Need

To ensure that users who are editing their own content objects on the frontend are not bothered by encountering the "existing drafts" window / page.

Solution

One solution may be to use the following setting to provide for the above need.

Setting

Default setting from the setings file, settings/site.ini

[ContentSettings]
# What to do when editing an object that has draft versions newer than the current version.
# Use 'showversions' to select which version to edit, or 'usecurrent' to always edit the current version.
EditDirtyObjectAction=showversions|usecurrent

Solution setting for your setings override file, settings/override/site.ini.append.php

[ContentSettings]
 EditDirtyObjectAction=usecurrent

References

Doc: Reference - EditDirtyObjectAction

PHP eZ Publish API Source code examples

Tue, 18 Aug 2009 05:05:35 GMT

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

This page will give you an overview of code samples which demonstrate how to use the eZ publish API.

Documentation

The eZ Publish PHP API has been documented a number of ways. A popular reference presently is the doxygen generated html documentation hosted on pubsvn.ez.no.

Content

PHP examples related to interactions related to database content access and manipulation.

Objects and the node tree

Fetching data

Manipulating data

creating new objects
putting data into attributes
adding relations
placing objects in the node tree
placing objects at additional locations
updating objects = creating new content object versions
removing objects
moving nodes
hiding and unhiding subtrees
copying objects
assigning sections
changing object ownership

Classes

adding class attributes
reordering class attributes

Charsets

converting external data to the internal charset

Notifications

adding subtree notification rules
removing subtree notification rules
adding collaboration notifications rules
removing collaboration notification rules

Users

Authentication

logging in a specific user
ip based authentication
authenticate with login handlers

Roles

assigning roles

Preferences

setting user preferences
removing user preferences

Template logic to find object by node_id or object_id

Tue, 18 Aug 2009 04:17:46 GMT

Question

How can you 'find' an object, if all that is known is the node_id?

Answer

{{def $my_node=fetch( 'content', 'node', hash( 'node_id', $node.node_id ) )
      $my_object=$my_node.object} 
{$my_node.name|wash}

External reference

Tips Running eZ Publish PHP CLI Scripts

Tue, 18 Aug 2009 02:32:28 GMT

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

Capture all script output to log file: # php /path/to/script | tee ~/ez.script.2006.11.17.001.log
A solution to running php cli scripts or other programs with required arguments in a limited hosting environment.

Tips Running - Cronjobs and scripts with required arguments in limited hosting environment

Tue, 18 Aug 2009 02:28:58 GMT

Previous Title

Running cronjobs and scripts with required arguments / parameters in limited hosting environment

Question

How can I run eZ Publish scripts and cronjobs with parameters on shared hosting without ssh.

You may only be allowed to run php files as a cronjob without any parameters and without the possibility to browse eZ Publish directory.

You also may not have command line access. Yeah, this can be pretty frustrating, but can not find or afford a better hosting solution.

Solution

When your provider doesn't allow you to run cronjob tasks with parameters and when your server runs php-cgi.

In order to run cronjob task with parameters, you can create a separate php file and then create a cronjob task pointing to that file.

Custom Script Example

Here is an example of the solution using the data_import extension as an example.

File: /path/to/ezpublish/extensions/custom/cronjobs/run_custom_cronjob_script.php

<?php
 
$output = shell_exec('cd /path/to/ezpublish/; /path/to/php5 runcronjobs.php import_images_csv');
 
echo "<pre>$output</pre>";
 
?>

The above example creates an output (as seen in the code) so you will know if your import is successful or not.

Web Browser Example

You may for very small tasks be able to run the above file from a web browser as long as the script completes quickly as browser requests do not work well with long running tasks.

The following tasks have been reported to be able to be run from the web browser with success if only limited. Most successes have been reported to resolve around limited execution time.

Scripts: Custom Scripts - Try limiting the execution time
Cronjobs: Data Import - Try limiting how much complicated data import you attempt each time
Database: Dump / Load / Custom SQL- Try using phpmyadmin or other dba tools

References

Template logic to fetch using an attribute filter using the like condition

Tue, 18 Aug 2009 02:21:51 GMT

We have seen this question asked many times and wanted to ensure this question is simpler to answer in the future

Question

How exactly do you use an attribute filter using the like condition?

Solutions

These solutions have been tested but may not be generic, so some modifications to ids etc may be required.

Filter by Class/Attribute Identifier

{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
               depth, 7,
               attribute_filter, array( array( 'article/keywords', 'like', '*string*' ) )
               ) )}
 
{$c|attribute(show,1)}
{$c.0|attribute(show,1)}

Filter by Attribute ID

{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
                depth, 7,
                attribute_filter, array( array( 865, 'like', '*string*' ) )
                ) )}

Filter by dynamic string variable

{def $tag='string'}
{def $c=fetch( 'content', 'tree', hash( 'parent_node_id', 175,
                depth, 7,
                attribute_filter, array( array( 'article/keywords', 'like', concat( '*', $tag, '*' ) ) )
                ) )}

Warning

Be certain to clear cache or disable cache!

References

Forum: How to use an attribute filter like condition?
Doc: Reference, fetch functions, list

Template logic to dynamically generate css stylesheets

Tue, 18 Aug 2009 02:18:01 GMT

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

About

Template logic for dynamically generating css stylesheets

Solutions

...

Reference

Forum: Generating CSS Dynamically...

Template logic to display content object tree node locations

Tue, 18 Aug 2009 02:16:44 GMT

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

Question

'Is there any attribute or other way to find out, if an object has more than one locations?'

Solution

The assigned nodes is available on the object.

Here is an example code that lists all the paths to the assigned nodes:

{foreach $node.object.assigned_nodes as $assignednode}
  {$assignednode.path_identification_string} <br />
{/foreach}<span class="line"></span></pre>

The $node variable has the following available information:
http://ez.no/doc/ez_publish/techn...ence/objects/ezcontentobjecttreenode
The $node.object:
http://ez.no/doc/ez_publish/techn..._8/reference/objects/ezcontentobject

Another Solution

Actually. In your case, you might be able to use the "main_node_only" parameter to the "list" or "tree" fetch to only return the main node of your nodes.
See here:
http://ez.no/doc/ez_publish/techn...modules/content/fetch_functions/list

Reply, "The main_node_only attribute would not work with the particular problem logic I have: I wanted to exclude all "Main Nodes" from the fetch, whose objects are encapsulated by another node (different location)."

External References

Forum: Detecting locations of a node ...

Template logic to display dynamic tertiary menu

Tue, 18 Aug 2009 02:15:06 GMT

Created by Graham Brookins | Brookins Consulting

About

Initial posting of this example ....

This was created for a client who wanted a menu system that was 3 levels deep, server-side collapsable, current menu/document selected style. All I will say is that it works, fairly well. There are some static exceptions with variables you can change or remove the exceptions entirely.

I will post a cleaned up version of the source code with beter comments and less commented out code.

Template

{* ##################################################################################### *}
{* Level 1 : Top Level Node : Submenu List
{* ##################################################################################### *}
 
{* Exclude specials_node_id , static exception *}
{set specials_node_id=118}
 
{let submenu=fetch( content, list, hash( parent_node_id, $module_result.node_id, sort_by,array(array(priority, false() )) ) )
      parent=fetch('content','node', hash('node_id', $module_result.node_id) )
}
 
{* ##################################################################################### *}
 
 
{* ##################################################################################### *}
{* Level 3+ : Reverse Submenu List (Which we are not using now)
{* ##################################################################################### *}
{* These are good rules for reverse *}
{*
{section show=and($DesignKeys:used.parent_node|ne(2), $submenu|count|lt(1))}
 
{set submenu=fetch( content, list, hash( parent_node_id, $DesignKeys:used.parent_node, sort_by,array(array(priority, false() )
)  ))
     parent=fetch('content', 'node', hash('node_id', $module_result.content_info.parent_node_id) )
}
 
{/section}
*}
 
{* END: These are good rules for reverse *}
{* ##################################################################################### *}
 
 
 
{* ##################################################################################### *}
{* Level 3+ : Toplevel Attached Reverse Submenu List (works)
{* ##################################################################################### *}
 
{section show=and($DesignKeys:used.parent_node|ne(2), $module_result.content_info.node_depth|gt(2) )}
 
{*
Depth: {$module_result.content_info.node_depth}<br />
Key: {$DesignKeys:used.parent_node}
*}
 
{* must test each parent per depth or use other to only get top level parents | parent, is not enough, part of prob, *}
{set parent=fetch('content', 'node', hash('node_id', $module_result.content_info.parent_node_id)) }
 
{* same as parent, need testing to only get top level:
   {set submenu=fetch( content, list, hash( parent_node_id, $DesignKeys:used.parent_node )) }
*}
 
{set submenu=fetch( content, list, hash( parent_node_id, $DesignKeys:used.parent_node, sort_by,array(array(priority, false() )
)  )) }
 
{* ##################################################################################### *}
 {* test: if depth is gt(3), then, use depth as a manipulated placer into longer qry *}
  {section show=$module_result.content_info.node_depth|gt(3)}
   {set current_top_level_node_id=$module_result.path.1.node_id}
 
 
    {*
    <br />Depth gt(3), flag set
 
    {set submenu=fetch( content, list, hash( node_id, $current_top_level_node_id )) }
    {set parent=fetch( content, node, hash('node_id', $current_top_level_node_id )) }
    *}
 
    {set parent=fetch(content, node, hash( node_id, $current_top_level_node_id  ))}
    {set submenu=fetch( content, list, hash( parent_node_id, $current_top_level_node_id, sort_by,array(array(priority, false()
 ))   ))}
 
  {/section}
{/section}
{*
<br /><br />
 
{$module_result.path.1.node_id}
{$module_result.path|attribute(show,3)}
{$parent|attribute(show,3)}
*}
 
{*
{$module_result.content_info|attribute(show,3)}
<br />
{$DesignKeys:used|attribute(show,3)}
*}
 
{*
{$DesignKeys:used|attribute(show,2)}
 
{$DesignKeys:used|attribute(show,3)}
*}
 
{* ##################################################################################### *}
{* Level 1 - 2 : Submenu List
{* ##################################################################################### *}
 
{* Don't Show Submenu if on root page *}
{section show=$module_result.node_id|ne(2)}
 
{* Don't show menu if there are no submenu items *}
{section show=$submenu|count|gt(0)}
  <div id="sectheader" style="margin-top: 8px;"><span class="headerw">{$parent.name}</span></div>
 
  {section var=menu loop=$submenu}
 
  {* Exclude: Company: Specials Folder *}
  {section-exclude match=$menu.node_id|eq($specials_node_id)}
 
{*
  {set children=fetch( content, list, hash( parent_node_id, $menu.node_id, sort_by,array(array(priority, false() ))   ))}
  {section show=$children|count|lt(1)}
*}
 
   {switch name=selected match=$menu.node_id}
   {case match=$module_result.node_id}
    <div class="sectmain-match">
   {/case}
   {case}
    <div class="sectmain">
   {/case}
   {/switch}
 
   {switch name=selected match=$menu.node_id}
   {case match=$module_result.node_id}
    <a href={$menu.url_alias|ezroot} class="mainb-match">{$menu.name|shorten( 25 )}</a>
   {/case}
   {case}
    <a href={$menu.url_alias|ezroot} class="mainb">{$menu.name|shorten( 25 )}</a>
   {/case}
   {/switch}
  </div>
 
{* ##################################################################################### *}
{* 3rd Level : tertiary (separate) menus
{* ##################################################################################### *}
{* Don't Show Tertiary if on root page *}
 
 {* Exclude: Company: Specials Folder *}
  {section-exclude match=$menu.node_id|eq($specials_node_id)}
 
   {set parent=fetch(content, node, hash( node_id, $menu.node_id ))}
   {set tertiary=fetch( content, list, hash( parent_node_id, $menu.node_id, sort_by,array(array(priority, false() ))   ))}
 
{* Tertiary Menu  *}
{* Don't show menu if there are no tertiary items *}
{section show=$tertiary|count|gt(0)}
  {section var=tmenu loop=$tertiary}
  {section show=or($menu.node_id|eq($module_result.node_id), $tmenu.node_id|eq($module_result.node_id), and($tmenu.parent_node
_id|eq($menu.node_id), $tmenu.parent_node_id|eq($DesignKeys:used.parent_node))  )}
   {* Exclude: Company: Specials Folder *}
   {section-exclude match=$tmenu.node_id|eq($specials_node_id)}
   {switch name=selected match=$tmenu.node_id}
   {case match=$module_result.node_id}<div class="sectmain-child-match">{/case} {case}<div class="sectmain-child">{/case}
   {/switch}
    <a href={$tmenu.url_alias|ezroot} class="mainb-child" style="padding-left: 10px;">{$tmenu.name|shorten( 25 )}</a></div>
  {/section}
 
  {* End of sub-folder loop. *}
  {/section}
 
 
{* End of dont' show menu if no menus exist *}
{* /section *}
 
 
  {* End of sub-folder loop. *}
  {* /section *}
 
{* End of dont' show menu on root page *}
{/section}
 
  {* ##################################################################################### *}
  {/section}
 
  {* End of sub-folder loop. *}
  {/section}
 
{* End of dont' show menu if no menus exist *}
{/section}
 
{* End of dont' show menu on root page *}
{/section}
 
 
{/let}
 
 
{* ///////////////////////////////////////////////////////////////////// *}

Template Logic to test if a template variable is defined

Tue, 18 Aug 2009 02:08:19 GMT

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

Question

How would one test if a template variable is defined?

Solution

You can use the is_set operator: http://ez.no/doc/ez_publish/techn...rs/variable_and_type_handling/is_set

External reference

Forum: How to test for existence of variable

PHP Snippet Creating new content object versions

Tue, 18 Aug 2009 01:55:33 GMT

This is compatible with eZ Publish 4.

You can update objects by creating new version and publish the new version.

The code

Known variables

$object, instance of class eZContentObject

Sample

$newVersion = $object->createNewVersion();
 
$newData = $object->fetchDataMap( $newVersion->attribute( 'version' ) );
 
// change attributes of new version here, by using $newData data map
 
$result = eZOperationHandler::execute( 'content', 'publish', array( 'object_id' => $object->attribute( 'id' ), 'version' => $newVersion->attribute( 'version' ) ) );

PHP Snippet Fetching ezimage datatype image alias properties

Tue, 18 Aug 2009 01:55:05 GMT

This is compatible with eZ Publish 4.

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

Introduction

Did you know that you can use the eZ Publish kernel api to obtain image alias properties from content object attributes which use the ezimage datatype.

Example

This is a simple php example of how you may use the eZ Publish kernel api to obtain image alias properties. This example comes from a simple example custom module view.

<?php
 
/**
 * File image.php
 *
 * @package image.php
 * @version //autogentag//
 * @copyright Copyright (C) 2007 Brookins Consulting. All rights reserved.
 * @license http://www.gnu.org/licenses/gpl.txt GPL License
 */
 
$Module = $Params['Module'];
 
// START
 
// Assume this type of module/view url:
// www.site.com/myextension/mymodule/myview/1234
// 1234 maps to the view parameter, MyNode (eg: $Params["MyNode"])
 
// 0. Include the necessary files -- I would imagine that some are include
 
include_once( 'kernel/common/template.php' );
 
// 1. Create an instance of the database
$db = eZDB::instance();
 
// 2. Query the node via node id
$my_node = eZContentObject::fetchByNodeID( $Params["MyNode"] );
// $my_node = eZContentObject::fetchByNodeID( '86' );
 
// 3. Get a copy of the data_map
$my_node_data_map = $my_node->fetchDataMap();
 
// 4. Get a reference to the image
$my_node_image = $my_node_data_map["image"];
// $my_node_image_data = $my_node_image->DataText;
 
// Example Usage of the eZ Image Alias Handler Class / System
// include_once( 'kernel/classes/datatypes/ezimage/ezimagealiashandler.php' );
 
// 5. Fetch Alias Handler
$image_alias_handler = new eZImageAliasHandler( $my_node_image );
 
// 6. Fetch Alias Attributes*
 
// 7. Fetch Original Image Path as URI
$my_node_image_uri =  "/" . $image_alias_handler->attributeFromOriginal( 'url' );
 
// 8. Fetch Original Image Dimentions
$my_node_image_width = $image_alias_handler->attributeFromOriginal( 'width' );
$my_node_image_height = $image_alias_handler->attributeFromOriginal( 'height' );
 
// 9. Get the associated link
$my_node_link_object = $my_node_data_map["my_link"];
$my_node_link_url_object = eZURL::fetch( $my_node_link_object->DataInt );
$my_node_link_url=str_replace ( "/", "+", $my_node_link_url_object->attribute( 'url' ) );
 
// 10. Instantiate the template and set the template vars
$tpl = templateInit();
$tpl->setVariable( 'parameters', $Params );
$tpl->setVariable( 'my_node_image_path', $my_node_image_uri );
$tpl->setVariable( 'my_node_image_width', $my_node_image_width );
$tpl->setVariable( 'my_node_image_height', $my_node_image_height );
$tpl->setVariable( 'my_node_link_url', $my_node_link_url );
 
// END
 
// phpinfo();
eZExecution::cleanExit();
 
?>

References

ezimagealiashandler

PHP Snippet Creating new content object language translations

Tue, 18 Aug 2009 01:54:05 GMT

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

About

Incomplete entry

References

PHP Snippet Copying objects

Tue, 18 Aug 2009 01:51:09 GMT

This is compatible with eZ Publish 4.

Code sample

The following code copies an existing object and gives it one location in the node tree. It was taken from the copy view of the content module (kernel/content/copy.php).

The used variables are:

$object: instance of eZContentObject you want to copy
$newParentNodeID: node id of the parent for the new object
$allVersions: true if you want to copy all versions of the object to the new object, false if you only want to copy the currently published version

$db = eZDB::instance();
$db->begin();
$newObject = $object->copy( $allVersions );
 
$curVersion        = $newObject->attribute( 'current_version' );
$curVersionObject  = $newObject->attribute( 'current' );
$newObjAssignments = $curVersionObject->attribute( 'node_assignments' );
unset( $curVersionObject );
 
// remove old node assignments
foreach( $newObjAssignments as $assignment )
{
    $assignment->purge();
}
 
// and create a new one
$nodeAssignment = eZNodeAssignment::create( array(
                                                 'contentobject_id' => $newObject->attribute( 'id' ),
                                                 'contentobject_version' => $curVersion,
                                                 'parent_node' => $newParentNodeID,
                                                 'is_main' => 1
                                                 ) );
$nodeAssignment->store();
 
// publish the newly created object
include_once( 'lib/ezutils/classes/ezoperationhandler.php' );
eZOperationHandler::execute( 'content', 'publish', array( 'object_id' => $newObject->attribute( 'id' ),
                                                          'version'   => $curVersion ) );
// Update "is_invisible" attribute for the newly created node.
$newNode = $newObject->attribute( 'main_node' );
eZContentObjectTreeNode::updateNodeVisibility( $newNode, $newParentNode );
 
$db->commit();

PHP Snippet Assigning sections

Tue, 18 Aug 2009 01:49:24 GMT

This is compatible with eZ Publish 4.

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

To a subtree

eZContentObjectTreeNode::assignSectionToSubTree( $nodeID, $sectionID );
eZContentCacheManager::clearAllContentCache();

To a single node

// Missing example

PHP Snippet Assigning roles

Tue, 18 Aug 2009 01:48:57 GMT

This is compatible with eZ Publish 4.

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

Predefined variables

$roleID: ID of the role
$objectID: id of a user or user group content object you want to assign the role to
$limitIdent: either null, Subtree or Section
$limitValue: either null, a node path string (in case $limitIdent is 'Subtree') or a section id (in case $limitIdent is 'Section')

$role = eZRole::fetch( $roleID );
$role->assignToUser( $objectID, $limitIdent, $limitValue );
 
eZRole::expireCache();
eZContentCacheManager::clearAllContentCache();
eZUser::cleanupCache();

PHP Snippet Adding subtree notification rules

Tue, 18 Aug 2009 01:48:34 GMT

This is compatible with eZ Publish 4.

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

Code sample

The defined variables are:

$nodeID: id of the node for which we want to add a subtree notification rule
$userID: id of the user for which we want to add the notification rule

 
$nodeIDList = eZSubtreeNotificationRule::fetchNodesForUserID( $userID, false );
 
if ( !in_array( $nodeID, $nodeIDList ) )
{
    $rule =& eZSubtreeNotificationRule::create( $nodeID, $userID );
    $rule->store();
}

PHP Snippet Add Location to Object / Add Usergroup to User

Tue, 18 Aug 2009 01:48:11 GMT

This is compatible with eZ Publish 4.

Compatibility

This example works with eZ Publish 4.x

About

This function allows adding a location to an extisting object even adds a usergroup to an existing user. The Code was taken and modified from kernel/content/action.php where it says " if ( $module->isCurrentAction( 'AddAssignment' ) )"

Example

/**
  * Adds User to the chosen Usergroup
  * objectID=UserobjectID
  * newNodeID=usergroupNodeID
  * @param integer $objectID
  * @param unknown_type $newNodeID
  */
 function addLocation($objectID,$newNodeID)
 {
  //$selectedNodeIDArray = eZContentBrowse::result( 'AddNodeAssignment' );
  eZDebug::writeDebug("LocationAdd: objectID".$objectID."\nnewNodeID: ".$newNodeID);
   $object = eZContentObject::fetch( $objectID );
   $nodeID = $object->attribute("main_node_id");
   //$version = $object->currentVersion();
  $ini = eZINI::instance();
  $userClassID = $ini->variable( "UserSettings", "UserClassID" );
  // $node = eZContentObjectTreeNode::fetch( $nodeID );
  $selectedNodeIDArray = array($newNodeID);
        $node = eZContentObjectTreeNode::fetch( $selectedNodeIDArray[0] );
 
  if ( !is_array( $selectedNodeIDArray ) )
            $selectedNodeIDArray = array();
 
        $nodeAssignmentList = eZNodeAssignment::fetchForObject( $objectID, $object->attribute( 'current_version' ), 0, false );
        $assignedNodes = $object->assignedNodes();
 
        $parentNodeIDArray = array();
        $setMainNode = false;
        $hasMainNode = false;
        foreach ( $assignedNodes as $assignedNode )
        {
            if ( $assignedNode->attribute( 'is_main' ) )
                $hasMainNode = true;
 
            $append = false;
            foreach ( $nodeAssignmentList as $nodeAssignment )
            {
                if ( $nodeAssignment['parent_node'] == $assignedNode->attribute( 'parent_node_id' ) )
                {
                    $append = true;
                    break;
                }
            }
            if ( $append )
            {
                $parentNodeIDArray[] = $assignedNode->attribute( 'parent_node_id' );
            }
        }
        if ( !$hasMainNode )
            $setMainNode = true;
 
        $existingNode = eZContentObjectTreeNode::fetch( $nodeID );
        $mainNodeID = $existingNode->attribute( 'main_node_id' );
        $objectName = $object->attribute( 'name' );
 
        $db = eZDB::instance();
        $db->begin();
        $locationAdded = false;
        $node = eZContentObjectTreeNode::fetch( $nodeID );
        foreach ( $selectedNodeIDArray as $selectedNodeID )
        {
            if ( !in_array( $selectedNodeID, $parentNodeIDArray ) )
            {
                $parentNode = eZContentObjectTreeNode::fetch( $selectedNodeID );
                $parentNodeObject = $parentNode->attribute( 'object' );
 
                /*$canCreate = ( ( $parentNode->checkAccess( 'create', $class->attribute( 'id' ), $parentNodeObject->attribute( 'contentclass_id' ) ) == 1 ) ||
                               ( $parentNode->canAddLocation() && $node->canRead() ) );*/
                $canCreate=true;
 
                if ( $canCreate )
                {
                    $insertedNode = $object->addLocation( $selectedNodeID, true );
 
                    // Now set is as published and fix main_node_id
                    $insertedNode->setAttribute( 'contentobject_is_published', 1 );
                    $insertedNode->setAttribute( 'main_node_id', $node->attribute( 'main_node_id' ) );
                    $insertedNode->setAttribute( 'contentobject_version', $node->attribute( 'contentobject_version' ) );
                    // Make sure the url alias is set updated.
                    $insertedNode->updateSubTreePath();
                    $insertedNode->sync();
 
                    $locationAdded = true;
                }
            }
        }
        if ( $locationAdded )
        {
            if ( $object->attribute( 'contentclass_id' ) == $userClassID )
            {
                eZUser::cleanupCache();
            }
        }
        $db->commit();
 
        //include_once( 'kernel/classes/ezcontentcachemanager.php' );
        eZContentCacheManager::clearContentCacheIfNeeded( $objectID );
 
 }

PHP Snippet Adding collaboration notification rules

Tue, 18 Aug 2009 01:47:41 GMT

This is compatible with eZ Publish 4.

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

The following code sample shows you how to create a new collaboration notification rule for a specific user. The known variables are:

$collaborationIdentifier: identifier of the collaboration type, for example ezapprove
$userID: the content object id of the user we want to create the rule for

$existing = eZCollaborationNotificationRule::fetchItemTypeList( $collaborationIdentifier, array( $userID ) );
 
if ( count( $existing ) == 0 )
{
    $rule = eZCollaborationNotificationRule::create( $collaborationIdentifier, $userID );
    $rule->store( );
}

PHP Snippet Adding additional locations for an object

Tue, 18 Aug 2009 01:47:24 GMT

This is compatible with eZ Publish 3.

Compatibility

The code above works with eZ publish 3.8 and 3.9.

Policy checking

You can remove policy checking by removing the conditional structures with $canManageLocations and $canCreate

Code sample

Since eZ publish 3.8, the publish operation doesn't need to be executed anymore when adding new locations for objects which are already in the node tree.

The following code was based on a part of the action view of the content module (kernel/content/action.php). The known variables are:

$node: instance of eZContentObjectTreeNode, which holds the object we want to create new tree leaves for
$selectedNodeIDArray: array with the node ID's of the additional parent nodes

$object =& $node->attribute( 'object' );
$objectID = $object->attribute( 'id' );
 
include_once( 'kernel/classes/datatypes/ezuser/ezuser.php' );
$user =& eZUser::currentUser();
 
$canManageLocations = $object->checkAccess( 'edit' ) || $user->attribute( 'has_manage_locations' );
 
if ( $canManageLocations )
{
 
   $nodeAssignmentList = eZNodeAssignment::fetchForObject( $objectID, $object->attribute( 'current_version' ), 0, false );
 
    $assignedNodes =& $object->assignedNodes();
    $objectID = $object->attribute( 'id' );
 
    $parentNodeIDArray = array();
    $setMainNode = false;
    $hasMainNode = false;
 
    foreach ( $assignedNodes as $assignedNode )
    {
        $assignedNodeID = $assignedNode->attribute( 'node_id' );
        if ( $assignedNode->attribute( 'is_main' ) )
        {
            $hasMainNode = true;
        }
 
        $append = false;
        foreach ( $nodeAssignmentList as $nodeAssignment )
        {
            if ( $nodeAssignment['parent_node'] == $assignedNode->attribute( 'parent_node_id' ) )
            {
                $append = true;
                break;
            }
        }
        if ( $append )
        {
            $parentNodeIDArray[] = $assignedNode->attribute( 'parent_node_id' );
        }
    }
 
    if ( !$hasMainNode )
    {
        $setMainNode = true;
    }
 
    include_once( 'lib/ezdb/classes/ezdb.php');
    $db =& eZDB::instance();
    $db->begin();
    $locationAdded = false;
    foreach ( $selectedNodeIDArray as $selectedNodeID )
    {
        if ( !in_array( $selectedNodeID, $parentNodeIDArray ) )
        {
            $parentNode = eZContentObjectTreeNode::fetch( $selectedNodeID );
            $parentNodeObject =& $parentNode->attribute( 'object' );
 
            $canCreate = ( ( $parentNode->checkAccess( 'create', $object->attribute( 'contentclass_id' ), $parentNodeObject->attribute( 'contentclass_id' ) ) == 1 ) ||
                           ( $parentNode->canAddLocation() && $node->canRead() ) );
 
            if ( $canCreate )
            {
                $insertedNode =& $object->addLocation( $selectedNodeID, true );
 
                // Now set is as published and fix main_node_id
                $insertedNode->setAttribute( 'contentobject_is_published', 1 );
                $insertedNode->setAttribute( 'main_node_id', $node->attribute( 'main_node_id' ) );
                $insertedNode->setAttribute( 'contentobject_version', $node->attribute( 'contentobject_version' ) );
                // Make sure the path_identification_string is set correctly.
                $insertedNode->updateSubTreePath();
                $insertedNode->sync();
 
                $locationAdded = true;
            }
        }
    }
 
    if ( $locationAdded )
    {
        include_once( 'lib/ezutils/classes/ezini.php' );
        $ini =& eZINI::instance();
        $userClassID = $ini->variable( "UserSettings", "UserClassID" );
 
        if ( $object->attribute( 'contentclass_id' ) == $userClassID )
        {
            eZUser::cleanupCache();
        }
    }
    $db->commit();
 
    include_once( 'kernel/classes/ezcontentcachemanager.php' );
    eZContentCacheManager::clearContentCacheIfNeeded( $objectID );
}

PHP Snippet Clearning in-memory object cache

Tue, 18 Aug 2009 01:46:46 GMT

This is compatible with eZ Publish 4.

Clearing the cache

When looping over a big amount of content objects or tree nodes, fetch them in cycles of 100 or less and after each cycle, clear the in-memory object cache:

eZContentObject::clearCache();

External resources

Bug: memory leakage in updatemultilingual.php

PHP Snippet Logging in a specific user

Tue, 18 Aug 2009 01:45:42 GMT

This is compatible with eZ Publish 4.

Code sample

The following code will login the user with the login specified by $login. It is especially useful in cronjob scripts when you need sufficient privileges.

$user = eZUser::fetchByName( $login );
$userID = $user->attribute( 'contentobject_id' );
eZUser::setCurrentlyLoggedInUser( $user, $userID );

Compatibility

In all recent versions of eZ publish the content/read policy limitation list of the current user gets cached in a global array by eZContentObjectTreeNode. When switching users, this cache isn't cleared. This issue has been reported as bug 8388 at ez.no and fixed in eZ Publish 4.1.x.

For your reference you can workaround this problem by clearing the cache yourself with the following code:

if ( isset( $GLOBALS['ezpolicylimitation_list']['content']['read'] ) )
{
    unset( $GLOBALS['ezpolicylimitation_list']['content']['read'] );
}

PHP Snippet Moving a node

Tue, 18 Aug 2009 01:45:16 GMT

This is compatible with eZ Publish 4.

Policy checking

You can remove policy checking by removing the condition with $node->canMoveFrom() && $newParentNode->canMoveTo( $classID ).

Code sample

The following code is based on a part of the action view of the content module (kernel/content/action.php). The known variables are:

$node: the node we're trying to move
$newParentNode: the destination node we want to place our node under

$object = $node->object();
$class = $object->contentClass();
$classID = $class->attribute( 'id' );
 
if ( !in_array( $node->attribute( 'node_id' ), $newParentNode->pathArray() ) )
{
    if ( $node->canMoveFrom() && $newParentNode->canMoveTo( $classID ) )
    {
        eZContentObjectTreeNodeOperations::move( $node->attribute( 'node_id' ), $newParentNode->attribute( 'node_id' ) );
    }
}

PHP Script to delete all nodes under a node in content structure

Tue, 18 Aug 2009 01:44:15 GMT

This is compatible with eZ Publish 4.

About

This is a script to delete all nodes under some tree.
Please note that this script may use large amounts of memory.

A better solution has been developed called, 'batchtool'. Try using batchtool instead of this script snippet example.

Source

<?php
 
require('autoload.php');
 
function deleteNodes( $classID, $parentNodeID, $depth )
{
    global $db;
 
    $deleteIDArray = array();
    $nodeArray =& eZContentObjectTreeNode::subTree( array( 'ClassFilterType' => 'include', 'ClassFilterArray' => $classID, 'Depth' => $depth, ), $parentNodeID );
 
    print("Deleting " . count($nodeArray) . " nodes. If that is not what you want it would be good to press ctrl-c now.. deleting starts in 20 seconds!!\n\n");
     sleep(20);
 
     $deletecount = 0;
    $deleteIDArray = array();
 
     foreach ( $nodeArray as $node )
    {
        print("Deleting node " . $node->attribute( 'main_node_id' ) . ' , "' . $node->attribute( 'url_alias' ) . "'\n");
        eZContentObjectTreeNode::removeSubtrees( array( $node->attribute( 'main_node_id' ) ), false );
        $deletecount++;
        print("$deletecount, ");
    }
}
 
$cli = eZCLI::instance();
 
// change the admin-password! see below ...
 
$script = eZScript::instance( array( 'description' => ( "delete nodes ...\n\n"."delete main nodes ...,\n" ),
'use-session' => false,
'use-modules' => true,
'use-extensions' => true,
'user' => array ( 'login' => 'admin', 'password' => 'ADMINPASS' ),
) );
 
$script->startup();
$options = $script->getOptions();
 
$script->initialize();
set_time_limit( 0 );
 
 
// 'deleteNodes' function, used to remove all nodes under passed node_id
// example usage of 'deleteNodes' function: deleteNodes( $classID, $parentNodeID, $depth )
 
deleteNodes( array( 'article' ), 6713, 10 );
 
?>

Compatible with eZ publish 3

Tue, 18 Aug 2009 01:39:45 GMT

This is compatible with eZ Publish 3.

How to send email to users

Mon, 17 Aug 2009 15:47:09 GMT

About

Often customers ask to send users to website users.

This can be achieved by one of any number of means.

Question

I need to send an email to all registered members of a customer ecommerce site with existing users, forums and shop orders. How can this be achieved?

Solutions

Take a look at the features offered by the more recently updated phplist extension.

References

http://projects.ez.no/phplist

How to enable large file upload support

Mon, 17 Aug 2009 15:31:07 GMT

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

About

Web applications basically must usually be configured to support large file uploads as well as web servers.

I can't begin to remember to forget the first time I configured eZ Publish v1.x and Apache 1.x to support large file uploads.

Example

Here is an example solution

Steps

It sounds like you want to optimize your web server and php configurations together to avoid this error.

Evaluation: Which version of apache are you running?
1. Apache 1.3.x
- This sounds strikingly similar to an apache 1.3 (large file upload) configuration issue I've learned to avoid over the years. set LimitRequestBody to an int (file size in bytes) value larger than your largest file.
- I found I often needed this apache settings change along with the php settings changes to enable large file uploads with apache 1.3
- Based on the size of the file being uploaded. Consider raising the values of the post_max_size to a larger value than the file being uploaded, as well as the value of max_input_time and max_execution_time beyond the amount of time required to complete the upload of the file.
eZ 4.x, Edit ... to enable large file support withing web application.
1. Example missing. Must not be required (per say)

PHP 5.x, Edit relevant php.ini configuration values

max_execution_time = 45     ; Maximum execution time of each script, in seconds
max_input_time = 60 ; Maximum amount of time each script may spend parsing request data
;max_input_nesting_level = 64 ; Maximum input variable nesting level
memory_limit = 258M      ; Maximum amount of memory a script may consume (128MB)
 
; Maximum size of POST data that PHP will accept.
post_max_size = 201M
 
; Whether to allow HTTP file uploads.
file_uploads = On
 
; Temporary directory for HTTP uploaded files (will use system default if not
; specified).
;upload_tmp_dir =
 
; Maximum allowed size for uploaded files.
upload_max_filesize = 201M

Clear eZ Caches and Restart Apache services

References

Issue tracker

Mon, 17 Aug 2009 09:22:57 GMT

About

eZ Systems currently uses the wIT Issue Tracker to track issues regarding any of their projects. According to Derick Rethans wIT uses Pear's Text_Wiki package. The full spectrum of markup can be found at the Text_Wiki sample page.

Site

http://issues.ez.no

Template logic to conditionally hide parts of layout using css

Mon, 17 Aug 2009 08:15:30 GMT

About

Solution which will conditionally hide parts of layout using css while in edit mode.

From: zurgutt

Example

Add this in beginning of pagelayout.tpl

{* define a style by context which can be used to hide elements in each mode (navigation, edit, browse etc.) *}
<style>
.context-hideon-{$module_result.ui_context}
{literal}
{
    display: none;
}
{/literal}
</style>

and then you’ll be able to do something like this

<div id="leftmenu" class="context-hideon-edit">
.. some menu here you dont need while editing content ..
</div>

Can be achieved by overriding templates but hey much cleaner this way.

Detecting and solving content object corruption

Mon, 17 Aug 2009 07:51:53 GMT

About

Dealing with content object corruption or what to do with a corrupt eZ Publish Database?

Solutions

...

External References

Forum: Problem: corrupt contentobjects

How to fetch and display image alias variations in jpeg format

Mon, 17 Aug 2009 07:49:59 GMT

From: kracker and Peter Schnuerer

Date: Wednesday 01 June 2005 8:02:17 pm

Filed under: Images Variation

Was called: Image operator always creates png but I need jpg

Summary

I wrote an extensive thread on altering eZ publish image variation behavior to remove static hard coded values. An interesting (while long winded) thread ...

Reference

Forum: http://ez.no/community/forum/install_configuration/image_always_creates_png_but_i_do_need_jpg

Connecting to Webdav using Microsoft Windows Vista

Mon, 17 Aug 2009 07:46:43 GMT

Problem

I just setup a webdav site. It didn't work. Then I found out that none of my ez webdav sites are working - shocking!

Cause

Well, the reason is: You can't open a webdav site with CTRL+O like it was before at Windows XP and Explorer.

Solution

You need to open, Start -> Computer -> Extras -> add network resource
Choose "web folder" (or is there "webdav" in english?)
Enter the url WITHOUT # at the end! Like, http://webdav.mysite.com/
Save it - works again.

Reference

Forum: webdav and vista

Template logic to display user session switching html form

Mon, 17 Aug 2009 07:43:33 GMT

About

If a user is logged in, display their name + logout button, if not, than display a login form.

Submited via irc by Lukasz Serwatka

{let thisuser=fetch('user','current_user')}
{section show=$thisuser.is_logged_in}
<p>Welcome. You are logged in as {$thisuser.contentobject.name}</p>
<p><a href="/user/logout">Logout</a></p>
{section-else}
<!-- login form goes here -->
{/section}
{/let}

Template logic to display dynamic left menu

Mon, 17 Aug 2009 07:25:01 GMT

I found that another user used this source code with success in the forums, so I thought we all might benefit from the documentation.

Question

I made up a site using a top and a left menu. In the left one there is only one menu level shown. Now I want the next level been shown, too.

Answer

You could try something like this

{def $second_level_children=array()}
{def $root_node_children=fetch('content', 'list', hash('parent_node_id', 2))}
 
{if gt($root_node_children|count,0)}
<ul>
{foreach $root_node_children as $child}
<li>
<a href={$child.url_alias|ezurl()}>{$child.name|wash()}</a>
{if or(eq($child.node_id,$module_result.node_id),eq($module_result.path.1,$child.node_id))}
{set $second_level_children=fetch('content','list',hash('parent_node_id', $child.node_id))}
{if gt($second_level_children|count,0)}
<ul>
{foreach $second_level_children as $child2}
<li><a href={$child2.url_alias|ezurl()}>{$child2.name|wash()}</a></li>
{/foreach}
</ul>
{/if}
{/if}
<li>
{/foreach}
</ul>
{/if}

First fetch the elements of the top level, foreach element check if it's the node that is being viewed or if it's one of its children's node. If so, show its children.
The code above has not been tested, but maybe would give you an idea on how to do it.

References

Dynamic Left Menu

Template logic to fetch recently updated products

Mon, 17 Aug 2009 07:24:22 GMT

Question

How to fetch all objects of class 'product' recently published with object result limit of 3

Answer

Template file, ' design/example/templates/toolbar/full/box_latest_products.tpl'

{def $products=fetch('content', 'list',
                        hash( 'parent_node_id', 61,
                                   'sort_by', array( 'published', false() ),
                                   'limit', 3,
                                   'class_filter_type',  'include',
                                   'class_filter_array', array( 'product' ),
                                   'depth', 3))
}
<h2>Latest Products</h2>
<ul>
{foreach $products as $product}
    {* $product.object|attribute(show,1) *}
    <li><a href={$product.url_alias|ezurl}>{$product.name}</a><br />{$product.object.modified|datetime('custom', '%m/%d/%Y @ %G:%i')}</li>
    {* {$product.count} *}
{/foreach}
</ul>
{undef}

Template logic to exclude a content object node from menus

Mon, 17 Aug 2009 07:22:19 GMT

Or, Looking for a way to hide a content?

Problem

I have many folders in the root eZ publish content tree (or elsewhere) which I do not want to be displayed in the menu.

Is there any way to add a folder to to eZ publish without it showing up in the top menus?

Solution

Using the eZ publish administrator, select Setup→Classes.

Edit your folder class and add checkbox called “Show in menu” (show_in_menu) By default checkbox is checked.

Then replace code in 'design/base/templates/menu/double_top.tpl' If you using double top menu.

{section show=eq( sum( $menu.index, 1 ), $menuitems|count )}
                        <li class="last {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'selected' )}"><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {section-else}
                    <li {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'class="selected"' )}><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {/section}

With

{section show=$menu.object.data_map.show_in_menu.data_int}
                {section show=eq( sum( $menu.index, 1 ), $menuitems|count )}
                        <li class="last {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'selected' )}"><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {section-else}
                    <li {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'class="selected"' )}><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {/section}
        {/section}

If you usign design/base/templates/menu/flat_top menu replace

{section show=eq( sum( $menu.index, 1 ), $menuitems|count )}
                <li class="last {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'selected' )}"><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {section-else}
                <li {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'class="selected"' )}><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {/section}

With

{section show=$menu.object.data_map.show_in_menu.data_int}
                {section show=eq( sum( $menu.index, 1 ), $menuitems|count )}
                <li class="last {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'selected' )}"><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {section-else}
                <li {eq( $module_result.path[1].node_id, $menu.node_id )|choose( '', 'class="selected"' )}><div class="spacing"><a href={$menu.url_alias|ezurl}>{$menu.name|wash}</a></div></li>
                {/section}
{/section}

If show_in_menu flag is set to true (checked) item is show in menu.

Special thanks to participants: Negin Javadi, Gabriel Ambuehl, Lukasz Serwatka

References

Looking for a way to hide a content

Template logic to display fetched parent content object name

Mon, 17 Aug 2009 07:20:45 GMT

Problem

Is it possible to fetch the name of a parent folder?

Solution

I did this just today, does anyone have some ideas on how i could improve this soluton?

The solution I used was a second fetch to get the current item’s parrent name (in the main fetch’s loop).

Abreviated

{set parent_id=$cnews.parent_node_id}
{set parent=fetch('content','node', hash('node_id', $parent_id , limit, 1 , sort_by, array(array(published, false() )) )) }
{set news_category=$parent.name}

Complete

New Objects: <br />
<span style="font-size: 11px;">
  {set news_id=344}
  {set news_limit=4}
 
  {let recent=fetch( content, tree, hash( parent_node_id, $news_id, limit, $news_limit, 'class_filter_type', 'include', 'class_filter_array', array( 'article' ) , sort_by, array(array(published, false() )))) }
  {section show=$recent|count|gt(0)}
    {section var=cnews loop=$recent}
      {set news_title=$cnews.name}
      {set news_intro=$cnews.data_map.intro.data_text}
      {set news_date_formated=$cnews.object.current.created |datetime( 'custom', '%m/%d/%Y @ %h:%i' )}
 
      {set parent_id=$cnews.parent_node_id}
      {set parent=fetch('content','node', hash('node_id', $parent_id , limit, 1 , sort_by, array(array(published, false() ) ) )) }
      {set news_category=$parent.name}
      <div style="padding-top: 2px; padding-bottom: 8px;"><span><a href="{$cnews.url_alias}" style="color:#004A84;">{$news_title|shorten(348)}</a></span><div align="right"><span style="font-style: italic;">Added to Category: {$news_category}<br /><span style="font-size: 10px; color: grey;">Released: {$news_date_formated}</span></div></div>
    {/section}
  {/section}
 {/let}
</span>

Participants

haavard h, J-A Eberhard, and of course the inevitable kracker

References

Is it possible to fetch the name of a parent folder?

Template logic to fetch and group results by letter

Mon, 17 Aug 2009 07:17:05 GMT

Question

I am using fetch and need to use a view_parameter to filter the data ...

Sort. I need to sort the items by first letter (a , b , c , d ...)

Group. I need the items 'grouped' by letter

<awormus> and I didn't want to do a "first letter" attribute which would have been silly :)

Answer

Try using the alphabet navigator features added in 3.9

I prefer this solution these days rather than more custom code.

Another Answer

http://ez.no/doc/ez_publish/technical_manual/3_8/reference/modules/content/fetch_functions/keyword

Yet Another Answer

{def $items = fetch( 'content', 'list', 
 hash( parent_node_id, $node.node_id,'sort_by', array( 'name', true() )) ) } 
 {foreach $items as $item}
 {if $item.data_map.term_term.value|begins_with($view_parameters.view)}
 <div>
 <span class="subheaders">{$item.data_map.term_term.value}: </span>
 <span class="content"> {$foo.data_map.term_description.value} </span>
 </div>
 {/if}
 {/foreach}

Template logic to provide users with printable search layout

Mon, 17 Aug 2009 07:10:50 GMT

Background

I was recently updating an eZ publish search implementation. I noticed that the site design used a print icon in it's page layout, yet sadly it was hard coded to only work on page views which displayed node content. (statically linked to for content view full + node_id).

On page views using the search (displaying results) the printable link naturally did not function and would link to an incomplete url. Leading me to sneaking implementing alternate printable views (other than 'view') like advanced search (results).

Yet I ran into a problem of how to do this the 'eZ' way, this must have been done before (dynamic printable link for alternate module views :\)

The Question

How to detect in $module_result or other template variable when using the '/content/advancedsearch/' module as apposed to 'view'.

Using the above solution, then how would you create a print this page link (#1) which passes the search url parameters to a printer friendly template layout and navigator.

The first answer found

On ez.no and in the demo the printer version link made no sense on search, only printing without results where possible.

Change the code in page_layout_section_xxx.tpl or where else into:

{section show=$enable_print}
{section show=is_set($search_text_enc)}
{section show=is_set($search_contentclass_id)}
<a href={concat('layout/set/print/',$site.uri.tail,'?SearchText=',$search_text_enc,'&SearchContentClassAttributeID=',$search_contentclass_id,'&SearchSectionID=',$search_section_id,'&SearchDate=',$search_date)|ezurl} class="path">{'Printable version'|i18n('design/standard/layout')}</a>
{section-else}
<a href={concat('layout/set/print/',$site.uri.tail,'?SearchText=',$search_text_enc)|ezurl} class="path">{'Printable version'|i18n('design/standard/layout')}</a>
{/section}
{section-else}
<a href={concat("layout/set/print/",$site.uri.tail)|ezurl} class="path">{'Printable version'|i18n('design/standard/layout')}</a>
{/section}
{/section}

A second answer

Do the print with only a css (media=print). It works fine.

References

Forum: Printable Search in eZ

Patch: Adding view parameter support into custom user extention module view

Mon, 17 Aug 2009 07:08:59 GMT

This is compatible with eZ Publish 3.

Compatibility

This article was written for eZ Publish 3. Prolly before eZ Publish 3.9. To our knowledge this feature has been added within (at least) eZ Publish 4.1

About

From: Jamie

Date: Tuesday March 22nd 2005, 5:23 pm

Filed under: General

Jamie: If for some odd reason you’d like to be able to use view parameters (userParameters) in user module’s register.php provided by eZ publish, here’s the 5 lines of code you need to add.

After the line:

$Params['TemplateObject'] =& $tpl;

add:

include_once( "lib/ezutils/classes/ezuri.php" );
 
$uri =& eZURI::instance( eZSys::requestURI() );
$GLOBALS['eZRequestedURI'] =& $uri;
 
$viewParameters = $uri->UserParameters();
 
$tpl->setVariable( 'view_parameters', $viewParameters );

Then, in your overridden register.tpl, you can access the userParameter like this:

$view_parameters.type

If your URL looks something like:

http://www.example.com/user/register/(type)/something

That is to say, the register.tpl should then work as described here.

The above may not be the most correct/elegant/efficient way to do it, but it works for me, and that’s all I need right now.

And thanks go to Katana on the #ezpublish IRC channel for prodding me in the right direction with the above.

Check out Katana’s formsess project for some clever Smarty-powered forms processing magic type stuff.

Template logic to add edit button into your custom user siteaccess design

Mon, 17 Aug 2009 07:04:29 GMT

From: Rappy and Zurgutt

Date: 11-16-2005 07:52:30

Question (Rappy): Anyhow, can someone point me to the place where I can read about how to make an edit-button on the site (that is visible when a user with the correct roles are logged in)

Answere (zrg): you have come to the master :) hang on ill give codesnippet. It has the added possibility of limiting number of objects in each class for given usergroup. Its nice for like mini hosting-plan, “you get to make 5 forums, if you want more, $$”. Unfortunately there seems not to be function to CHECK for existence of ini value, so code below will spam error log.. im open to suggestions. Needless to say it only removes creation choice, no actual access security..

This goes to ini in my case to limit Guest users (group 12) to only one blog each (blog container id 31)

<?php /* #?ini charset="utf8"?
 
[PerGroupClassLimits]
ClassLimit_12_31=1
 
*/ ?>

eZ template source code

{let node=fetch( content, node, hash( node_id, $module_result.node_id ) )
     current_user=fetch( user, current_user )
     user_group_id=$current_user.contentobject.main_parent_node_id
}
<div id="quickedit">
  <div class="buttonblock">
    <form method="post" action={concat("/content/action/", $node.object.id)|ezurl}>
    {section show=$node.object.can_edit}
      <input type="hidden" name="ContentNodeID" value="{$node.object.main_node_id}" />
      <input type="hidden" name="ContentObjectID" value="{$node.object.id}" />
      <input class="button" type="submit" name="EditButton" value="{'Edit'|i18n('design/standard/node/view')}" />
      <input class="button" type="submit" name="ActionRemove" value="{'Remove'|i18n('design/standard/node/view')}" />
      <br>
    {/section}
 
    {def $limited_list=array()}
    {section var=class loop=$node.object.can_create_class_list}
      {def $limit=ezini( 'PerGroupClassLimits', concat('ClassLimit_', $user_group_id, '_', $class.id), 'limits.ini' )}
      {if not($limit)}
        {set $limited_list=merge($limited_list, array($class))}
      {else}
        {def $existing=fetch( 'content', 'object_count_by_user_id', hash( 'class_id', $class.id, 'user_id',  $current_user.contentobject_id ) ) }
        {if gt($limit, $existing)}
          {set $limited_list=merge($limited_list, array($class))}
        {/if}
      {/if}
    {/section}
 
    {section show=count($limited_list)}
      <br>
      <input type="hidden" name="NodeID" value="{$node.node_id}" />
      <select name="ClassID">
      {section var=class loop=$limited_list}
        <option value="{$class.id}">{$class.name|wash}</option>
      {/section}
      </select>
      <input class="button" type="submit" name="NewButton" value="{'Create here'|i18n('design/standard/node/view')}" />
    {/section}
  </form>
{**
  <form method="post" action={concat("/content/hide/", $node.node_id)|ezurl}>
    <input class="button" type="submit" name="Hide" value="Hide" />
  </form>
**}
  </div>
</div>
{/let}

eZpedia.org : Recently updated

Amazon

About

Extensions

Known Issues

References

adminalphabetical

Features

License

Demo

Requirements

Installation

Download

Installing the extension

Override templates

Technical notes

External links

Main page

Ask A Question

Ecosystem

Recent subversion activity

Recent discussions

Recently updated articles

eZ Publish Best Practices

Best Practices

Document External Dependencies

Backing up eZ publish

Using Subversion to maintain eZ publish

Install

About

Articles

References

eZ publish 3.9

Installation

Upgrading

Using old site packages

New features

Website interface extension

Additional content creation and import features

Best Selling Product Fetch

Kernel Error Codes

Setup wizard finish custom text

Contributor / third party software / extension information

External resources

PHP Snippet Creating new content objects

Compatibility

Permission checking

Code sample

The known variables

Creating new content objects with php

Compatibility

Permission checking

Code sample

The known variables

Import

CSV / DSV

Additional content creation and import features

OpenDocument

PowerPoint

RSS

OPML

XML

Import Framework

Misc

References

Simple fromString and toString interface for attributes

Simple fromString and toString interface for attributes

Latest News

OpenSearch

Introduction

Plugins

Installation

Update

Usage

Using these with eZ publish

Support

Browsers

Credits

License

Copyright