eZpedia.org : Recently updated

Latest News

Thu, 05 Apr 2012 01:14:12 GMT

Checkout the latest reported news on anything eZ Publish via eZpedia (Recently, Email, Rss, Feeds, Updated, Discussion, New), eZ Share (Forums, Blogs, Articles, Download, Events, Directory, Get Involved with eZ Publish!, eZ Publish Project Roadmap), eZ Ecosystem, eZ Projects (WebSVN, ViewVC), PubSVN, GitHub, eZ Systems' Issue Tracker (eZ Publish, eZ Find, OE, Community), eZ Publish Planet, Apache Zeta Components, eZ Systems, Digg, Reddit, StackOverflow (Recent, Tags), Snipplr, Meetups, LinkedIn, FriendFeed or Twitter, eZ Publish Love * or Hate * on Amplicate!

Template Operators

Thu, 29 Mar 2012 09:55:13 GMT

About

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.

Alternatives

If you looking to save yourself a lot of development time and your not using a certified platform (re: eZ Publish Now) we suggest you use the wrap operator

Inside Template Operators

How template operator usage

Typical usage of a template operator is like this:

{'input'|mytploperator('param1','param2')}

How template operators work

Template operators provide a template language function for your existing php function.

When to create a template operator?

If you have a lot of loops, ifs and fetches to manipulate variables, that is usually a good idea to put in an template operator.

What can you do

It is typically useful for:

Manipulating variables ( arrays, strings, numbers, etc )
Extracting information from eZ publish or external system
a combination of the above

Creating a template operator

In the administration interface of eZ publish there is a wizard that helps you creating template operators. Go to "Setup" - "RAD" - "Template Operator wizard"

Put more detailed example here..

When to use template operators? Why there are so few template operators or documentation on them as a category or subject?

How to enable a template operator

How to debug a template operator not loading error

Settings - If valid settings are not properly configured your template operator will not be loaded
Code - If you have a code problem with your template operator.

Debug Tip

Ensure that the autoloads directory for your template operator is properly configured in the settings

From file, ' extension/ezgpg/settings/site.ini.append'

#?ini charset="iso-8859-1"?
# eZ publish configuration file.
 
[TemplateSettings]
AutoloadPathList[]=extension/ezgpg/autoloads

Insert an echo statement in your templatate operators autoload php file. From file, 'extension/ezgpg/autoloads/eztemplateautoload.php'

<?php
 
eZDebug::writeWarning( 'eZGPGOperators::autoload : load template operator' );
 
echo("eZGPGOperators::autoload : load template operator || is loaded ...<hr /><hr />");
// Operator autoloading
 
$eZTemplateOperatorArray = array();
$eZTemplateOperatorArray[] = array( 'script' => 'extension/ezgpg/autoloads/ezgpg_operators.php',
                                    'class' => 'eZGPGOperators',
                                    'operator_names' => array( 'ezgpg_decode' ) );
 
?>

When to use a template operator

When you need to provide a feature via function in templates.

Why to use a template operator

It is the only way to access additional user defined features without kernel or extension modification

Using PHP functions as template variables

strip html tags

To remove html tags from a string.
=============================
In template.ini(.append.php)
add under
[PHP]
....
PHPOperatorList[striptags]=strip_tags
......
Then in your template use
$yourstring_with_xml|striptags
and catch the stripped output
=============================
See: http://ez.no/community/forum/developer/operator_to_strip_off_html_tags

Creating your own template variables in a simpler way

Use the OWSimpleOperator or Wrap Operator extension to create your own template operators or use all available php functions.

Listing all available template operators using ggsysinfo extension

Use the ggsysinfo extension which provides a module view to list all available operators and which extension they might belong.

This view is amazing because you can quickly determine which template operators might be used within a giving eZ Publish installation.

Troubleshooting

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

Extension information

Tue, 20 Mar 2012 20:25:13 GMT

This feature is available since eZ publish 3.9.

The ezinfo/about module view is used to convey related legal information like copyright, license, contributors, extensions, third party software, etc, and is enabled by default.

Information about extensions can be added to this view by creating an ezinfo.php file in the extension's root directory.

ezinfo.php standard

file path: myextension/ezinfo.php
PHP class name: myextensionInfo

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

Here's an example of the info of the ezodf extension, placed in the file extension/ezodf/ezinfo.php:

<?php
class ezodfInfo
{
    function info()
    {
        return array(
            'Name' => "eZ OpenOffice.org extension",
            'Version' => "2.0.0",
            'Copyright' => "Copyright (C) 1999-2006 eZ systems AS",
            'License' => "GNU General Public License v2.0",
            'Includes the following third-party software' => array( 'Name' => 'PhpConcept Library - Zip Module',
                                                                    'Version' => '2.4',
                                                                    'License' => 'GNU/LGPL - Vincent Blavet - November 2004',
                                                                    'For more information' => '<a href=http://www.phpconcept.net>http://www.phpconcept.net</a>' )
     );
    }
}
?>

Note that the info method is static. For PHP5 compatibility, you will have to define it as follows:

static function info()

ezinfo XML Alternative - extension.xml

You can at your option use the extension.xml file within your extension instead of the php ezinfo standard.

Here is an example of an extension.xml file

<?xml version="1.0" encoding="utf-8" ?>
<software>
<metadata>
<name>BC Image Alias</name>
<version>//autogentag//</version>
<copyright>Copyright (C) 1999 - 2012 &lt;a href='http://brookinsconsulting.com'&gt;Brookins Consulting&lt;/a&gt; and eZ Systems AS</copyright>
<license>GNU General Public License</license>
<info_url>http://projects.ez.no/bcimagealias</info_url>
<source_url>http://github.com/brookinsconsulting/bcimagealias</source_url>
</metadata>
<dependencies>
</dependencies>
</software>

Disabling access to ezinfo/about

You can disable access to this module / view in the site.ini settings file - see eZ Publish Security for more information.

External resources

Issue: Spec for ezinfo/about

eZ Publish Security

Mon, 19 Mar 2012 09:23:18 GMT

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

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

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

Securing eZ publish

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

eZ Publish Security Advisories

Published on ez.no, eZ Publish Security Advisories [update: this is now a redirect to http://share.ez.no - add your complaint here

Keeping your eZ Publish installation up-to-date with the latest release and security patches is a good way to ensure the underlying code base is stable & secure.

File Permissions

"Also in productive environments the extension directory should not be any longer writeable to apache cause of security." -- tos@ez.no

Installation directory permission

Database Permissions

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

Module view security

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

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

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

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

PolicyOmitList

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

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

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

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

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

SiteAccessRules

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

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

HTTP Headers

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

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

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

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

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

eZ publish Administration

Browser security

SSL

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

ACL

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

eZ publish Users, Groups, Roles and Permissions

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

Example #1 - Email Abuse

Security related topics

External resources

ezlupdate

Tue, 13 Mar 2012 22:19:25 GMT

About

eZ publish empty translation creation. ezlupdate is the general way to create .ts ( located in share/translations or extension/ezexample/translations ) files for the system (eZ publish)

Installation

Please read the README installation instructions.

Before building the program

The linguist is not provided with eZ publish 3, as this is distributed in the Qt library available from Trolltech.

The following assumes that you are building under unix. If you have a commercial licence of Qt for Windows and/or Mac OS X, you can build it in a similar way. If you don't have such a licence, you can get binaries from eZ systems.

First, make sure that you have the Qt library installed. If you use a package system such as RPM, make sure that you also have the qt-devel package. You need version 4.0 of the Qt library.

If you build ezlupdate against the Qt/X11 library, it will require X11 to run, even though it is a console program. If you have installed eZ publish on a server without X11 it is recommended that you build ezlupdate against Qt/embedded.

Dependencies

eZ publish 3 requires two programs to create and maintain translations, 'ezlupdate' and 'linguist'.

These programs are based on the same tools from the Qt toolkit by Trolltech (www.trolltech.com). The unix version of this toolkit is released under the GPL. eZ systems will provide binaries for Windows and Mac OS X.

The linguist is unmodified from the Qt original, so you also can get this from other sources, such as RPMs. ezlupdate is modified to make it understand eZ publish files.

Installing QT Linguist

...

Installing on Apple OSX Lion using Homebrew

Since Apple has broken compatibility with PowerPC compiled programs on Lion, you will not be able to use the binary provided for previous OS X versions : https://auth.ez.no/download/translations/ezlupdate_and_linguist

You can now very simply build (from sources) and install the ezlupdate program using Homebrew on Apple OSX computers.

Just install Homebrew and type `brew install ezlupdate` in your favorite terminal.

Notes :

The installer will download qt as a dependency
ezlupdate binary will be placed into /usr/local/bin/ by default (which should be in your PATH)
The Formula uses sources from eZ Publish Community 2011.10
This has been tested on Mac OS X Lion 10.7.2 so far (please report feedback on your OS X version)
Related blog post about this wonderful accomplishment in greater detail

Installing on Apple OSX Lion using macports

If you don't have qt4-mac, install it with macports

Then, go inside support/ezlupdate-qt4.5/ezlupdate and run

qmake ezlupdate.pro
make

The binary will be compiled and placed into bin/macosx/ so you might want to copy it in a location that is in your PATH environment variable.

Interesting and related blog post : http://share.ez.no/blogs/jerome-vieilledent/getting-ezlupdate-for-macosx

Installing using debs

...

Installing using rpms

...

Installing using source

...

External reference

BC Website Statistics

Fri, 09 Mar 2012 04:50:03 GMT

About

Google offers a feature rich proprietary web statistics service called, 'Analytics'.

Solution

There is a simple extension which offers the code needed to provide the service with the statistics information based on your account name.

Documentation

This consists of a template operator to include js dependencies and setting for page view statistics tracking and a workflow event ( after checkout ) which displays a receipt view which transmits order receipt statistics while displaying a custom module template view, order complete receipt and a file download statistics tracking feature.

Installation

Get source (above links)
Enable Extension
Configure Urchin setting
Add template operator code into your pagelayout.tpl or other template(s)

Features

Page Statistics Code Template
Order Statistics Code Workflow Event
File Download Statistics Code Template

External reference

Google: Google Analytics
Bog: Official Google Analytics Blog
Wikipedia: Google Analytics
Review: Google Analytics vs Urchin Software

memcache

Sun, 22 Jan 2012 22:32:37 GMT

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

About

Several different people have documented the use of eZ Publish with memcache / memcached with great success at improving eZ Publish performance

External reference

Forum: (Example Solution Howto) eZ session using memcached....Performance

Forum: xxx
Forum: Memcache / Suggestions / Forum
Doc: lighttpd

Versions

Fri, 20 Jan 2012 10:07:08 GMT

About

There are many versions of eZ Publish each is rarely the same as the last so pay close attention to what consists of each version, each community build and each release.

Version Chart

Here is an interesting version chart to read and learn more about the history / version(s) of eZ Publish and eZ Publish 4.x.

Releases Chart

Here is an interesting release history version chart

Features

Feature documentation is available by version from the eZ Publish GitHub repository.

Backwards Compatibility

Backwards compatibility documentation is available by version from the eZ Publish GitHub repository.

Changelogs

Changelog documentation is available by version from the eZ Publish GitHub repository.

Specifications

Specification documentation is available by version from the eZ Publish GitHub repository.

References

PubSVN: Version Chart for eZ Publish 4.x
Doc: Release version chart
Doc: Feature documentation
Doc: Backwards compatibility documentation
Doc: Changelog documentation
Doc: Specification documentation

Custom Fetch

Mon, 16 Jan 2012 11:52:29 GMT

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

Brief

The purpose of a custom fetch is to have an organized way to retrive data from a given data source. You mainly call a custom fetch function from templates.

The eZ Publish framework already provide a lot of different fetch functions out-of-the-box using the information extraction system.

You can also create your own custom fetch functions from within your own custom module extension.

Example

The following example is based on the example given by Bruce Morrison on the ez.no forums.

File: extension/ourcustom/modules/ourcustom/function_definition.php

<?php
 
$FunctionList = array();
$FunctionList['CustomFetch'] = array( 'name' => 'customfetch',
                                                  'operation_types' => array( 'read' ),
                                                  'call_method' => array( 'include_file' => 'extension/ourcustom/modules/ourcustom/ourcustomfunctioncollection.php',
                                                  'class' => 'OurCustomFunctionCollection',
                                                  'method' => 'fetchCustomFetch' ),
                                                  'parameter_type' => 'standard',
                                                  'parameters' => array(
                                                    array( 'name'     => 'the',
                                                               'type'     => 'integer',
                                                                'required' => true,
                                                                'default'  => 1
                                                      ),
                                                      array( 'name'     => 'params',
                                                                 'type'     => 'string',
                                                                 'required' => true,
                                                                 'default'  => ''
                                                              )
                                                      );
?>

Please note that the values associated with the keys 'name', 'operation_types' and 'parameter_type' are not used anywhere by eZ Publish itself.

Since eZ Publish 4, the 'include_file' key of the 'call_method' array is deprecated and won't be used anymore. Instead, the module system relies on the PHP 5 autoload feature.

File: extension/ourcustom/modules/ourcustom/ourcustomfunctioncollection.php

<?php
 
class OurCustomFunctionCollection
{
 function OurCustomFunctionCollection()
 {
 }
 function &fetchCustomFetch( $some, $params )
 {
   $result =& retrieve data here
   return array( 'result' => $result );
 }
}
 
?>

File: extension/ourcustom/settings/module.ini.append.php

<?php /* #?ini charset="utf-8"?
 
[ModuleSettings]
ExtensionRepositories[]=ourcustom
ModuleList[]=ourcustom
 
 
*/ ?>

Usage

This page of documentation clearly explains how to call and use fetch functions (custom or default) using the information extraction system.

{def $collection=fetch( ourcustom, customfetch, hash( the, params ) )}

References

Doc: Fetch
Forum: Custom fetch functions
Forum: How to do a fetch with PHP
Contribution: An example custom fetch module extension, bccontentdiffnotifications

fetch

Mon, 16 Jan 2012 11:50:09 GMT

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

About

Missing Description

Using Fetches

This page of documentation clearly explains how to call and use fetch functions (custom or default) using the information extraction system.

Custom Fetch

You can create your own custom fetch functions which you can use with a custom template operator or module.

External References

Twitter

Mon, 16 Jan 2012 11:44:20 GMT

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

You can learn much by listening and following the eZ Community sharing on Twitter!

eZ Publish Twitter Content

Search Twitter for eZ Publish related tweets!

eZ Publish Community related Twitter accounts

The feeds available breakdown to the following primary Twitter accounts :

@ezcommits	eZ Publish & extensions (eZ's, hosted on github) commits,
@ezpublishevents	eZ Community-related events, proposed on the brand new Event Planner
@ezpublish_jobs	Job offers coming-out of the soon-to-come Job Board (Review the in-progress RFC here),
@ezcommunity	Notifying the social sphere of new forum topics, new blog posts, new tutorials, and also used by yours truly for manual message.

On top of the above more social channels, you also still have the more traditional, yet very useful eZ Community RSS feeds.

References

Blog

Mon, 16 Jan 2012 11:34:18 GMT

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

Extensions related to blogging

Blogs about eZ Publish

Individuals feel free to add your blogs here to this list

Best English eZ Publish blog on the entire internet, http://serwatka.net/blog
Another fantastic English eZ Publish blog, http://www.mugo.ca/Blog
An amazing English eZ Publish blog, http://www.netgen.hr/eng/Blog/
A German eZ Publish blog portal, http://www.ez-publish-blog.de/
Another older inactive German blog portal, http://ezpublish.de/Blog
Older French blog, http://www.gandbox.fr/Blogs/(tag)/eZ%20Publish (English translation via Google Translate)
Older inactive: http://ez.ryba.eu/

Planets about eZ Publish

Planets are blog rss feed content syndication distribution focal points on specific subjects.

The following are planets containing eZ Publish related blogs and blog posts.

http://share.ez.no/blogs
http://planetezpublish.org/
http://www.planet-ezpublish.fr/ (English translation via Google Translate)
eZ Ecosystem OPML
eZ Publish related blogs indexed on technorati.com

Persistent template variables

Sun, 15 Jan 2012 20:53:43 GMT

About

You usually require a persistent_variable when you need to pass a value from a (module result) template context into the pagelayout template context (outside of module result context).

Checking to ensure your persistent variable name is not already in use

Remember that another extension may already use the variable name you wish to use, so it may be important to search your templates to ensure the variable name is not already used previously as this helps ensure you do not overwrite existing variables.

Background

It can take a user of eZ Publish quite some time of learning before finding out how to use the persistent_variable template variables.

This article should help even the average user quickly understand how to work with the persistent_variable within the contexts of templates and even within the context of PHP!

This documentation was inspired by another user who shared in the forum thread, "Persistent variable unveiled"

Use case

You need to pass a variable from a module result template context into a pagelayout template context.

Examples

Modifying a variable in a module result template context (TPL)

When the 'persistent_variable' is of variable type 'hash' it is simple to modify it's contents within a module result template context using the set template function and the merge operator.

{set scope=global $persistent_variable=$#persistent_variable|merge( hash( 'key', 'value' ) )}

The above template code merges into the hash a new key/value pair.

Remember it is very important to use the set parameter 'scope=global' and '$#' to access the existing value within the in global template variable scope.

Also note the quotes around the examples are not actually part of the examples in the last sentence containing 'scope=global' and '$#'.

Accessing a variable in a pagelayout template context (TPL)

Now that you are modifying the persistent variable and adding a new key/value pair you can try to use this information within the pagelayout context (cache issues aside *)

{$module_result.content_info.persistent_variable.key}

Accessing a variable in a template operator context (PHP)

If you are creating an eZ Publish template operator in PHP code you can also access and modify this persistent variable within a module result template context.

$persistent_variable = array();
 
if( $tpl->hasVariable( 'persistent_variable' ) )
{
    $persistent_variable = $tpl->variable( 'persistent_variable' );
    $persistent_variable[ 'key' ] = 'value';
    $tpl->setVariable( 'persistent_variable', $persistent_variable );
}

Accessing a variable in a pagelayout template context from module result template context (TPL)

Now that you are modifying the persistent variable and adding a new key/value pair you can try to use this information within the pagelayout context

$module_result = $tpl->variable( 'module_result' );
 
$persistent_variable = array();
 
if( isset( $module_result['content_info']['persistent_variable'] ) )
{
    $persistent_variable = $module_result['content_info']['persistent_variable'];
}

Closing

If you wish to learn more please read this excellent blog on the subject, "eZ-Publish CMS persistent variables"

References

Blog: eZ-Publish CMS persistent variables
Doc: Template function set
Doc: Snippet: Template Variable Scope / Passing Variables to Template
Forum: Persistent variable unveiled

Template Variable Scope / Passing Variables to Template

Sun, 15 Jan 2012 20:38:22 GMT

Question

Is there anything like $module_result.content_info.persistent_variable

I could use instead of it? Something to pass data from tpl of shop to pagelayout.tpl

Solution

Found out I can use {set-block scope=global variable=NAME}VALUE{/set-block}

References

Doc: Persistent template variables

Git

Sat, 14 Jan 2012 03:29:15 GMT

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

About

Git for eZ Publish

History of Git

Wikipedia on Git!

Sharing eZ Publish related source snippets and examples using GitHub Gists

It's a recommended best practice to stop using traditional pastebin web site services to share source code files and snippets as this delivers overall poor features long term. Instead it is strongly recommended to use GitHub Gists to share almost any text based content via a web browser in seconds, it makes sharing source code examples more simple and more useful to the other party recieving and using these shared source code examples.

https://gist.github.com/

Git usage with eZ Publish

Use of Subversion for your eZ Publish projects is now deprecated.

The business and community projects for eZ Publish are all (slowly) migrating to using Git for version control.

We strongly recommend you replacing your Subversion usage with Git today.

eZ Systems now distributes the eZ Publish source code with Git repositories hosted on GitHub.com

eZ Systems also now distributes most of the currently supported eZ Publish Extension(s) source code with Git repositories hosted on GitHub.com

The eZ Community and eZ Ecosystem world wide is progressively migrating their own use of version control in their own development projects to Git (and many also to GitHub). projects.ez.no has been modified to support projects which use GitHub to host their project extension source code.

eZ Systems Extensions for eZ Publish

The currently supported extensions from eZ Systems are almost all hosted now on GitHub directly at

http://github.com/ezsystems

eZ Community Extensions for eZ Publish (on GitHub)

Organizations

Individuals

The following are just a few pioneering eZ Publish developers which distribute their extensions with Git on GitHub

Here is a dynamic google search for eZ Publish Developers on GitHub (who mention eZ Publish via Google)

Git Documentation

Official: Git Documentation
Reference: Git Reference
Cheatsheets: Git cheat sheets
Article & Screencast: Introduction To Git
Article: An Illustrated Guide to Git on Windows

Documentation on usage of Git with eZ Publish

Article: How to use your github.com repository on the eZ Publish extension forge : projects.ez.no
Article: How to contribute to eZ Publish using Git
Article: Translating & Localizing eZ Publish using GIT

Forum: Participate on the Tracker, through GIT, how?
Forum: Git life-cycle, development to production
Forum: Git stable-4.4 branch update
Forum: Updating from 4.3.0 to 4.3.1 (from git), some glitches
Forum: Managing a project with git
Forum: Switch to GIT? (Pre migration to Git by eZ Systems)

References

Article: How to contribute to eZ Publish using Git
Article: Translating & Localizing eZ Publish using GIT

Older community efforts to support Git usage with eZ Publish

These references come from before eZ Systems officially began to use, support and migrate most of their currently supported software to git for version control and GitHub for hosting, distribution and collaboration.

Doc: gitforez.pdf
Forum: Switch to Git
Blog: Community GIT repository for eZ Publish
Alternate hosting of Git Repo by YMC : http://git.forge.ymc.ch/

The eZ Song

Sat, 14 Jan 2012 03:24:12 GMT

About

The eZ Song is a song shared and sung within the community of eZ Publish a PHP/CMS/CMF.

The original song title is "The Sharing Song" and the original song author is Jack Johnson

Alternate names the song is also known

The eZ Song
The eZ Publish Song
The eZ Sharing Song
The eZ Publish Sharing Song
Sharing Song
The Sharing Song
Jack Johnson - The Sharing Song
It's Always More Fun
It's Always More Fun to Share
It's Always More Fun to Share with Everyone

History

The song has been with us for a long time so far ...

It is shared among the ecosystem and community

The song is seemingly not advertised per-say or referenced so much on the internet itself.

When it is mentioned it is often in passing and in text form alone.

Any search engine will surely bring these references to your attention and understanding should your seek them out after learning of this wonderful song and hearing it for the first time.

Trends

The song is often sung in groups
The song has a special meaning for us all
The song is an enjoyable reminder of our lives

Experiencing the song for yourself

Some have trouble finding a copy of the song to listen to so we did a few searches and wrote this article to help improve this situation for our friends in the community looking to learn more about The eZ Song and to hear it (perhaps for the first time privately).

Listening to the song

Some people really enjoy listening to the song (and we would not be surprised to learn of many people singing the song to themselves privately at the same time).

Random Youtube Mirror (2:45): http://www.youtube.com/watch?v=0hgiVfHIPxc
Random Youtube Mirror (Longer picture slideshow; 3:58): http://www.youtube.com/watch?v=bfSpsnLyo18
Uk Previously Shared Mirror: http://www.deezer.com/listen-2247842

Lyrics of the song

Some people enjoy reading the lyrics while they listen to the song.

Random Copy of Lyrics: http://www.azlyrics.com/lyrics/jackjohnson/thesharingsong.html
Random Copy of Lyrics: http://www.sing365.com/music/lyric.nsf/The-Sharing-Song-lyrics-Jack-Johnson/9057EF11C2140E9A48257115000DC36D

References

Wikipedia: Jack Johnson
Mention: http://www.visionwt.com/News/eZ-Conference-set-for-London
Mention: http://visionwt.podhoster.com/index.php?sid=2938&m=05&y=2011
Mention(s): http://share.ez.no/forums/discussions/ez-future-15-ez-publish-4.5-matterhorn-ahoy
Mention: http://twitter.com/#!/zurgutt/status/81458057095282688
Mention: http://www.meetup.com/eZ-Publish-Users-Developers/messages/boards/thread/19408082/#64253782

Subversion

Sun, 08 Jan 2012 05:19:30 GMT

About Subversion

Also known as svn or SVN.

History of Subversion

Wikipedia on Subversion!

Tips

Use of Subversion for your eZ Publish projects is now deprecated.

The business and community projects for eZ Publish are all (slowly) migrating to using Git for version control.

We strongly recommend you replacing your Subversion usage with Git today.

Site Development

Using Subversion to manage your eZ publish site development.

Reasons to use subversion to store the site specific customization

Simple to run several sites from a single eZ publish (stock) source directory.
Simple to mirror production or development installations using the production, settings,design,extension,bin customizations
Simple to sync changes from one environment / server / installation instance to others
Management of templates,settings,extension,bin,var file changes and releases
Archival of the entire history of your eZ publish development
Collaborative resource, share source code access with your developers, reduce development costs by using management processes

Dealing with changes made to var/ directory by eZ publish

It can often be time consuming to perform a manual commit to a site repository checkout with changes made to it by eZ publish. Especially adding or removing 1000+ files from the checkout. Here are some example commands which can be used to automate this process. After using these commands you may perform a hand commit or a mass (general/all files) commit.

Example Commands

Add new files in var/storage to svn checkout

# cd /web/pro/example.com/; find /home/web/pro/example.com/var/plain/storage/original/application -print0 | xargs -0 svn status | grep '?      ' | tr '? ' '\n' | xargs svn add

Remove files from svn which have been removed from var/storage by eZ publish

# cd /web/pro/example.com/; find /web/pro/example.com/var/plain/storage/ -print0 | xargs -0 svn status | grep '!      ' | tr '! ' '\n' | xargs svn remove

Log svn status command results to log file

# cd /web/pro/example.com/; svn status | tee ../example.com.status.2006.11.17.001.log

Unpack stock eZ publish and prepare build and create links

# cat /web/ini/bin/int.stock.svn.links.sh
#!/bin/bash
 
 
wget http://ez.no/content/download/152158/995731/file/ezpublish-3.8.6-gpl.tar.gz
 
tar -zxf ezpublish-3.8.6-gpl.tar.gz
 
ln -s ezpublish-3.8.6-gpl doc
 
cd doc
 
# move stock folders to invisible
 
mv bin .bin;
mv var .var;
mv design .design;
mv extension .extension;
mv settings/override settings/.override;
mv settings/siteaccess settings/.siteaccess;
 
# create links
 
ln -s ../example.com/bin bin;
ln -s ../example.com/var var;
ln -s ../example.com/design design;
ln -s ../example.com/extension extension;
ln -s ../example.com/settings/override settings/override;
ln -s ../example.com/settings/siteaccess settings/siteaccess;

Example eZ publish stock layout with symlinks to site repository checkout.

# ls -l
 
.ezpublish.3.8.6.stock
access.php
 bin -> ../example.com/bin
.bin.stock
clr -> bin/shell/clearcache.sh
cronjobs
design -> ../example.com/design
.design.stock
doc
extension -> ../example.com/extension
.extension.stock
ezpm.php
ezpublish.cron
index_image_mysql.php
index_image_pgsql.php
index_image.php
index.php
kernel
kickstart.ini-dist
lib
LICENSE
packages
pre_check.php
README.txt
runcronjobs.php
settings
share
soap.php
support
update
var -> ../example.com/var
.var.stock
 webdav.php
 
# ls -la settings
override -> ../../example.com/settings/override
.override.stock
siteaccess -> ../../example.com/settings/siteaccess
.siteacces.stock

Example site repository layout

# ls -l
      bin
      design
      extension
      favicon.ico -> favicons/example.white.star.ico
      favicons
      robots.txt
      settings
      tmp
      var

Note: This method has a few negative side affects long term maintenance. First storing the extension directory as a whole provides for stronger extension source code management.

Yet for general purpose usage this notion of storing the extension dir should be removed and replaced instead with an abstraction. Instead of storing extensions per site repository, store your extensions in a separate repository, install ezsvn and use it to install your extensions needed via external repository.

Second, the design directory should really only contain the non-stock site design directories. These would be symlinked into your existing stock design directory.

Third, the settings directory should really only contain the non-stock override and siteaccess directories. These would be symlinked into your existing stock design directory.

External Links

ezsvn project
svnmerge.py

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

Creating file upload feedback forms using information collection system and the enhanced ezbinaryfile extension

Sun, 08 Jan 2012 04:33:45 GMT

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

About

Often users are looking for a way to create an information collection form (for feedback, resumes, etc) which allowed binary files like pdfs to be uploaded.

This features is specifically not supported by the default eZBinaryFile datatype provided with every copy of eZ Publish.

Example solution: Enhanced eZBinaryFile extension for eZ Publish

About: Enhanced eZBinaryFile extension

This datatype was developed to make it possible to send binary files collected from forms as multipart MIME emails. For example, the enhanced eZBinaryfile datatype can be used to allow people to attach documents to information collection forms / feedback forms.

Example solution: Enhanced eZBinaryFile extension for eZ Publish 4.x+

This extension is available for download on projects.ez.no/enhancedezbinaryfile

Please note that this specific project for the extension hosted on projects.ez.no is not compatible with eZ Publish 3.x instead it is only compatible with eZ Publish 4.x+ and PHP 5.x+. See the following section for the eZ Publish 3.x compatible solution available (older versions available).

Example solution: Enhanced eZBinaryFile extension for eZ Publish 3.x

This extension is available for download on pro jects.ez.no/enhanced_ezbinaryfile

Note: This specific project for the extension hosted on projects.ez.no is not compatible with eZ Publish 4.x+ instead it is only compatible with eZ Publish 3.x <= 3.10.x and PHP 4.x.

External Reference

Project: enhancedezbinaryfile (eZ Publish 4.x+ Compatible)
Project: enhanced_ezbinaryfile (eZ Publish 3.x Compatible)
Forum: How to use file uploads in a contact form?
Forum: How to use file uploads in a contact form? (Changes required to make this extension compatible with eZ Publish 4!)
Forum: Files and collected informations

Chat with other eZ Publish Developers LIVE from around the World

Sun, 08 Jan 2012 00:18:38 GMT

Get support for your eZ Publish problems in real time chat with other eZ Publish users, developers and masters from your web browser in our live chat room, the #ezpublish channel on Freenode.net IRC via your web browser, simply follow the link, sign-in to the IRC service, remember to join the #ezpublish channel specifically! http://webchat.freenode.net/

Main page

Sun, 08 Jan 2012 00:18:22 GMT

The free eZ Publish encyclopedia that anyone can edit. eZpedia has accumulated 612 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.

Chat with other eZ Publish Developers LIVE from around the World!

Ecosystem

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

Recent development activity

Track the eZ Publish development progress through the roadmap by reviewing recent git activity from the github repository.

Last updated: 2012-05-16T02:45:17-07:00

Updated setup wizard styling

2012-05-16T02:45:17-07:00

+ design/standard/images/setup/2/ez-ecosystem-virtuous-circle.png
+ design/standard/images/setup/2/ez-publish-ce-40x460-png-24.png
+ design/standard/stylesheets/setup2.css
m design/standard/templates/setup_pagelayout.tpl

Updated setup wizard styling

Merge pull request #332 from sanpii/master

2012-05-15T05:51:19-07:00

m kernel/private/classes/ezpmobiledeviceregexpfilter.php

Merge pull request #332 from sanpii/master

Undefined HTTP_USER_AGENT and HTTP_ACCEPT headers

Fixed #11577: workflow cancelled when reediting the draft of a previously rejected content

Related issue:
11577

2012-05-14T07:39:42-07:00

m kernel/classes/workflowtypes/event/ezmultiplexer/ezmultiplexertype.php

Fixed #11577: workflow cancelled when reediting the draft of a previously rejected content

Adjust CSS for admin2 header media query a bit to suite two header setup for 1100px width screen

2012-05-10T13:10:45-07:00

m design/admin2/stylesheets/theme/rounded.css

Adjust CSS for admin2 header media query a bit to suite two header setup for 1100px width screen

Fixed #018581: XSS issue for ezoption templates

Related issue:
018581

2012-05-09T05:05:03-07:00

m design/standard/templates/class/datatype/edit/ezoption.tpl
m design/standard/templates/class/datatype/view/ezoption.tpl
m design/standard/templates/content/datatype/collect/ezoption.tpl
m design/standard/templates/content/datatype/edit/ezoption.tpl
m design/standard/templates/content/datatype/result/count/ezoption.tpl
m design/standard/templates/content/datatype/result/ezoption.tpl
m design/standard/templates/content/datatype/result/info/ezoption.tpl
m design/standard/templates/content/datatype/view/ezoption.tpl
m design/standard/templates/content/datatype/view/plain/ezoption.tpl

Fixed #018581: XSS issue for ezoption templates

Recent discussions

Read what others are discussing

eZpedia upgraded to eZ Publish Community Project 4.2011

2011/04/17 @ 04:27:05 : Graham Brookins

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 07:39:25 : Nicolas Pastorino : Excellent initiative

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 06:26:21 : Carlos Revillo : Well done!

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 05:54:20 : Graham Brookins : Added recent git activity to home page

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 02:59:58 : Graham Brookins

IRC

Sat, 07 Jan 2012 14:57:16 GMT

For a general description of irc, we recommend IRC (Internet Relay Chat) on Wikipedia.

About

An unofficial eZ publish IRC channel exists on the freenode IRC Network, called ' #ezpublish'

I.R.C. stands for Internet Relay Chat.

Many of the active eZ publish community members and developers can be found in #ezpublish

IRC is a great resource for real time support, collaboration and communication.

Disclaimer

Visit #ezpublish on IRC (chat.freenode.net) ask a question and start a conversation with the active eZ publish irc community.
We urge users to be patient, detailed and persistent with their queries. Before leaving, ask the forum and in the meantime, try clearing the cache ;)

Rules

Please do not ask to ask a question
Please use the eZ publish pastebin
Please no spamming

Channels

The following alternate irc channels have been known to be in use or used

#ezpublish
#ezpublish-info
#ezcomponents
#ezpedia
#ezc
#ezpublish-fr
#ezpublish2

Chat in the #ezpublish channel on Freenode.net IRC via Web Browser

You can chat with other eZ Publish users from your web browser, simply login to the IRC service using the following link, remember to join the #ezpublish channel specifically. http://webchat.freenode.net/

IRC Topic Text

eZ publish | cms | Welcome to #ezpublish ... We urge users to be patient, detailed and persistent with their queries. Before leaving, ask the forum and in the meantime, try clearing the cache ;) || http://ez.no/community | http://ezpedia.org | http://pubsvn.ez.no | http://planetezpublish.org || News: http://ez.no/community/news/community_newsletter_17_11_2006 | Articles: http://ez.no/community/articles
eZpedia | wiki | The community documentation project for eZ Publish | http://ezpedia.org/
eZpedia | wiki | The community documentation project for eZ Publish | http://ezpedia.org/ | Search eZpedia.org through irc! http://ezpedia.org/wiki/en/ez/ez_community_irc_services#eztoc204760_2_2_1

References

Forum: LiveChat for developers and for debuging
Doc: Pastebin
Doc: eZ Community IRC Resources
Doc: IRC Bot

Books

Sat, 07 Jan 2012 14:21:31 GMT

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

Several books on the subject of eZ publish have been released over the years from several different publishing companies.

Distributors

You can obtain eZ Publish books from the following publishers / distributors (among others).

Packt Publishing
eZ Systems
Amazon (UK)
Other/Individual

Titles

The following are the most popular English books on the topic of eZ Publish.

eZ Publish 4: Enterprise Web Sites Step-by-Step

The sixth book, 'eZ Publish 4: Enterprise Web Sites Step-by-Step', released on [release-date], is an interesting handbook for web developers.

A pdf version of the book is available.

Managing eZ Publish Web Content Management Projects

The fifth book, 'Managing eZ Publish Web Content Management Projects', released on [release-date], is an interesting handbook for team lead / project manager / consultants.

A pdf version of the book is also available.

eZ Publish Advanced Content Management Book

The fourth book, 'eZ Publish Advanced Content Management', released on [release-date], is a very useful handbook for new administrators.

This book is a useful read for both new users, customers, administrators and experienced eZ developers.

A pdf version of the 'eZ Publish Advanced Content Management Book' book was also released.

Free Download of the PDF of this Book from ez.no

You can download this book from ez.no by filling out this form or direct download

Warning: A friends tell us that there's a bug in the above ez.no pdf book download form. The download is free of charge but requires you fill out the form with psudo information.

The downloads work perfectly except there is one bug. If you open eZ Publish Content Management Basics Book download form link, then go to the eZ publish Basics Book download form link (again), fill out the form with psudo information and submit the form you actually will download the eZ Publish Content Management Basics Book". So be careful to avoid this bug when downloading the free pdf books or alternatively use the direct download links.

eZ Publish Content Management Basics Book

The third book, 'eZ Publish Content Management Basics', released on [release-date], is a very useful handbook for new administrators.

This book is a useful read for both new users, customers, administrators and experienced eZ developers.

A pdf version of the 'eZ Publish Content Management Basics' book was also released.

Free Download of the PDF of this Book from ez.no

You can download this book from ez.no by filling out this form or direct download.

Warning: A friends tell us that there's a bug in the above ez.no pdf book download form. The download is free of charge but requires you fill out the form with psudo information.

The downloads work perfectly except there is one bug. If you open eZ Publish Content Management Basics Book download form link, then go to the eZ Publish Advanced Content Management Book download form link (again), fill out the form with psudo information and submit the form you actually will download the eZ Publish Content Management Basics Book". So be careful to avoid this bug when downloading the free pdf books or alternatively use the direct download links.

The eZ publish Basics Book

The second book, 'eZ publish Basics', released on [release-date], is a very useful handbook for new developers.

A pdf version of the 'eZ publish Basics' book was promised to and was released in December/2006.

This book is a useful read for strong eZ developers and new users.

Free Download of the PDF of this Book from ez.no

You can download this book from ez.no by filling out this form or direct download.

Warning: A friends tell us that there's a bug in the above ez.no pdf book download form. The download is free of charge but requires you fill out the form with psudo information.

The Learning eZ publish 3 Book

The first book, 'Learning eZ publish 3', released in 'May 2004'.

While containing useful information for advanced topics useful for strong users of eZ publish, it was not as useful to all new developers.

A pdf version of the 'Learning eZ publish 3' book is also available.

It has not yet been updated with a second edition.

Free Preview of the PDF of this Book from Google Books

There is a preview of (almost) the whole book available through Google Books.

View parameters

Wed, 04 Jan 2012 01:28:35 GMT

About

You can use view parameters to pass variables to a template.

View paramters are not normally cached.

View parameters availability

Remember view parameters are by default available only within the context of the content module and it's views.

All other modules (by default) do not support this feature.

The recommended alternative to view parameters in these situations would be using get / post parameters instead.

Cache block requirements when using GET/POST parameters instead of view parameters

Remember view parameters are not normally cached. This is very helpful to most developers.

If you do use get/post parameters instead of view parameters ... please, remember that the developer using get/post parameters -must- also add cache-blocks to the templates in question where the get/post parameters are used.

Cache blocks are required as the get/post parameters would be cached without the cache blocks and the values of the get/post parameters would not change (the values would be served from cache instead).

Parameters available within the layout/set module view

Since view parameters are available via the content module by default you should not try to use them within the context of the layout module or it's views like the popular layout/set view.

More specifically view parameters may not be available (or contain content) within the layout/set module view if view caching is enabled. One developer reported them existing without view cache but that they were not usable.

The recommended alternative to view parameters in these situations would be using get / post parameters instead.

Examples

/news/(sort)/name/(filter)/true/(search)/textString/

References

Solution: Converting HTML Form Post Variables into URL View Parameters
Solution: Adding userParameters to the user module in ezPublish
Doc: Module

External References

Forum: Passing parameters to the feedback form
Search: Forum Topic Search

eZ Publish 5.0

Mon, 02 Jan 2012 09:47:52 GMT

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

Preview

A preview release of eZ Publish 5.0 has been hinted to be in the works for March 2012

References

Forum: First public mention on share.ez.no, "2012 - It's going to be a great year!"

Package

Thu, 15 Dec 2011 04:41:02 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: Package distribution, selection, downloading and installation

Remember that prior to the eZ Publish 3.8 release, packages were distributed within the ezpublish download source packages (tar.gz, zip) themselves.

After eZ Publish 3.8 release, these packages were further distributed to the installations on demand during the setup wizard package selection, download and import.

Tip: Avoiding package download and import errors within setup wizard using eZ Publish 3.8.0+ (or greater version)

The following advise applies to eZ Publish 3.8.0 through 4.6 (Community Build 2011.11)

Have you ever have trouble during the setup wizard package selection, downloading and importing of the default eZ Publish packages like eZ Flow, eZ Webin or others?

This issue in question seems to be reported most frequently by users who's internet server (web server for example) which is behind a restrictive firewall or proxy server. In short when eZ Publish because of PHP configuration, curl availability, or restricted internet access for the server to use making outgoing requests ... can not connect to the remote package server.

If you do provide the web server with network access, php-curl or certain built-in PHP functions disabled, you must either solve the aforementioned problems or ... you must install packages using a local repository directory.

Did you know you can download these packages yourself from the Official eZ Systems' eZ Publish ezpkg package server, http://packages.ez.no/ezpublish/

Before using the setup wizard at all ... please perform the following steps with special attention to the specific details as they are key to solving this problem.

Simply navigate to /path/to/ezpublish root directory.
Download -all- the files (specifically index.xml and *.ezpkg file extension file name) in the package server's release directory (release version number) (IE: '/4.6/4.6.0/') which corresponds to the version number of the copy of eZ Publish you are trying to setup using your own preferred method, yourself, from the Official eZ Systems' eZ Publish ezpkg package server, http://packages.ez.no/ezpublish/
1. For example with eZ Community Build 2011.11 you will want to download all files (including the index.xml file) in found within the package server's release directory (release version number) (IE: '/4.6/4.6.0/') into 'var/storage/packages/eZ-systems/' from this remote url, http://packages.ez.no/ezpublish/4.6/4.6.0
2. Most users do not understand or realize the package names they require to complete setup normally which is why I recommend getting them all as you can repeat the process again more gracefully with all the packages and choose different setups as needed or desired.
3. If your an eZ Publish expert, know the package management systems related, and know the package names your require then you can choose to download only the packages you know you need.
4. No additional subdirectories are supported or allowed. If you use additional subdirectories (beyond the directory named the same as the package minus the extension '.ezpkg' with the contents of the package itself) your uncompressed packages will not be detected or imported from local sources.
5. Do not simply mirror the the package server or more than one of it's directories as this directory structure is not supported at all with local package installation. The local package import directory should contain almost the same files as the remote version specific directory.
6. Again, make certain the web server (user and group) can read and write to all the files in the package directory.
Extract all downloaded package files (*.ezpkg) -into- a new directory for each package (you must create this) with the same name as the package (without the '.ezpkg' file extension)
1. IE: the ezwebin_site.ezpkg file extraction directory I would need to create would be called ezwebin_site
2. Remember .ezpkg files are really just renamed tar.gz files in a very specific directory structure which must be maintained. You can use the gnu tar to extract the contents of the packages into directories with the same base name.
3. You can use this simple bash script to extract the packages correctly within the above directory as current directory on Unix-like systems with the Bash shell it's called bcuncompressezpackages.sh
  1. You can get a copy of this script from GitHub, https://github.com/brookinsconsulting/bcuncompressezpackages
  2. If you don't want to check out the script using Git. Here is a direct link to the raw script, simply copy and paste into a file in the root ezpublish directory with the filename of 'bcuncompressezpackages.sh', https://raw.github.com/brookinsconsulting/bcuncompressezpackages/master/bin/shell/bcuncompressezpackages.sh
  3. To run the script simply first set it's file permissions, chmod 777 ./bcuncompressezpackages.sh;
  4. Then feel free to run the script. You must run the script for the eZ Publish root directory or it will fail. cd /path/to/ezpublish; ./bcuncompressezpackages.sh;
  5. Then feel free to continue with the following setup setup steps.
4. If your concerned about file owner/group permissions you can optionally free yourself from any concerns in this regard by changing the package directories recursively file and group permissions to 777
5. You'll thank yourself later when you have no setup problems that you assigned these permissions to these packages' directories.
Re-start the setup wizard and complete the setup wizard normally. Local packages will be used to complete setup. It's painless and accurate.
1. Packages should be installed from local sources using the local package directory after each request for the remote package file from the setup wizard to the remote package server fails (unavoidable, not visible or apparent behavior).
Your done! Enjoy the time you saved, take a break, enjoy nature and a tall glass of orange juice!
1. You can optionally remove the downloaded / original package (.ezpkg) files out of the 'var/storage/packages/eZ-systems/' directory as they are no longer required or you can leave them as they cause no harm and only consume disk space.
Warning: While you can remove the actual compressed package files above as described we must be clear ... we -do not- recommend removing the uncompressed package directories or their contents as these files are expected to live here indefinitely as they represent part of the now installed packages in eZ Publish.

Did you know? Local package import/installation and setup wizard completion time is much faster than remote package import and installation during setup wizard!

Here is a related companion forum reference regarding this problem and this recently updated solution

Details about the setup wizard's behavior during package import and installation

It may also be worth mentioning here is the fact that even after failing to fetch the initial index.xml file from the remote package server, the setup wizard will continue to try to use the internet / remote package server regardless of the first (or continued) failure -or- the existence of local xml / remote packages in the correct directory at the correct time, etc. It always tries to use the package server first, then falls back to checking after each failure for a local copy (uncompressed) in the package dir mentioned above.

The setup wizard first it tries to use curl (if available/installed/detected/etc) to fetch the files from the remote package server and then falls back to try using to use built-in / core php functions and perform another attempt to connect using the different method. Now if either of those features also are not available (depending on your php configuration) you can get the same remote packages server connection errors as well.

The files which are fetched from the remote package server are first temporarily stored in 'var/cache/packages/' (using the same file name as found on the remote host) before being copied to 'var/storage/packages/eZ-systems/' directly. You may also wish to check the permissions of the 'var/cache/packages/' directory as if it is incorrect the remote package selection may fail.

These changes were introduced and released in eZ Publish 3.8. They were clearly documented in the provided feature documentation.

Tip: Avoiding package download and import errors within setup wizard using eZ Publish 3.x through 3.6.12

Have you ever have trouble during the setup wizard package selection and importing of the default eZ Publish packages?

You can replace the packages which are normally distributed with eZ Publish (3.x -> 3.6.12) release packages. This might help if you do not have these packages at this time and need to reinstall eZ Publish or simply re-run the setup wizard more specifically.

If you create the 'packages' directory in the root ezpublish directory and download the required packages into this directory before running the setup wizard you will install your packages via local sources.

In this way you may also be able to install custom packages here as well?

Simply navigate to /path/to/ezpublish root directory.
Create directory 'packages' in the root ezpublish directory.
Change directory file and group permissions to 777
You'll thank yourself later when you have no setup problems that you assigned these permissions to the 'packages' directory .
Download the packages you require / design into the 'packages' directory directly using your own preferred method yourself
Remember to only store *.ezpkg files in the 'packages' directory. No subdirectories are supported or allowed. If you use subdirectories your packages will not be detected or imported from local sources.
You should not need to unpack the packages (up to eZ Publish 3.6.12)
Again, make certain the web server (user and group) can read and write to all the files in the package directory.
Start or re-start setup wizard and complete setup normally. Packages should be installed from local sources over remote sources.

Local packages installation is the standard for eZ Publish 3.x through 3.6.12 and setup wizard completion time was acceptable. The setup wizard performance improved over the years / releases and today is very fast indeed (even without using local package installation).

Solutions

External resources

Package: Retrieving 3.8 Packages

Mon, 12 Dec 2011 00:33:08 GMT

Hint

Remember that prior to eZ Publish 3.8 packages were distributed within the download source packages themselves. After eZ Publish 3.8 the packages were distributed to the installation during the setup wizard package import.

Did you know If you create the 'packages' directory in the root ezpublish directory and download the required packages into this directory before running the setup wizard you will install your packages via local sources overriding the remote sources.

Local packages installation and setup wizard completion time is much faster than remote package import and installation during setup wizard.

External references

Forum: How to retrieve all packages for eZ Publish 3.8 Installation

References

Package

Extended sort

Fri, 09 Dec 2011 12:37:40 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( ' RAND() ', true() ),
                                'extended_attribute_filter', hash()
    ) )

This example will give a randomized list of nodes. This is not possible to do without the extended sort feature.

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.

OpenSearch

Tue, 29 Nov 2011 02:49:12 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 share.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('https://raw.github.com/brookinsconsulting/opensearch/master/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

Testing eZ Publish - Test System

Thu, 24 Nov 2011 13:25:38 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.5.x or newer: http://www.phpunit.de/
eZ Components

Installation

Start with a clone of the github repo (updated to at least 30/9/2008 - svn trunk rev 22408or github commit 530f3ad97ba5abecc19474baad92e8effd12d6d3)
To run the tests in another eZ installation, copy into it the "tests" folder from the github installation
Generate autoloads for the test system:

php bin/php/ezpgenerateautoloads.php -s

Running tests

To run all tests do:

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

The --dsn 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

Note: do not use an existing eZ Publish database for running tests, as it will be wiped out and recreated on need by the tests!

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

php tests/runtests.php --dsn mysql://root@localhost/testdb tests/tests/lib/ezdb

Filter which tests to run

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

php tests/runtests.php --dsn 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 --dsn mysql://root@localhost/testdb --filter="testGlobBrace$"

This works too:

php tests/runtests.php --dsn 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 --dsn 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 --dsn 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 --dsn 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 --dsn 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

Clear Cache in eZ Publish

Mon, 14 Nov 2011 22:22:02 GMT

Introduction

How to clear cache using eZ Publish 4

Administration

Use the website administration interphase to clear all cache via a gui.

Simply navigate to Setup tab
Click the clear cache icon
Refresh browser window of website

Command line

If you know how to use the command line you can use it to clear cache.

Unix

If you are using a complete unix like operating system you can use the following command to clear and purge all cache within eZ Publish.

cd /path/to/ezpublish;
./bin/php/ezcache.php --clear-all --purge;

Windows

If you are using Windows you can use the following command to clear and purge all cache within eZ Publish.

# cd c:/web/pro/ezpublish/doc;
c:\php\php ./bin/php/ezcache.php --clear-all --purge;

Siteaccess Specific

If you are working on a multi-siteaccess website, the specific siteaccess must be appended to the clear cache code.

cd /path/to/ezpublish;
 
./bin/php/ezcache.php --clear-all --purge -s siteaccess_name;

Manual

If you are unable to use the administration gui or command line to clear cache, you can still remove the cache files manually.

cd /path/to/ezpublish;
rm -vrf var/cache;
rm -vrf var/ezwebin_site/cache

Specific: Clearing image alias cache

If you are unable to use the administration gui you can use this command line to clear this specific combination / type of cache.

cd /path/to/ezpublish;
 ./bin/php/ezcache.php --clear-id=imagealias --clear-all;
 ./bin/php/ezcache.php --clear-id=imagealias --clear-all --purge;
  ./bin/php/ezcache.php --clear-all --purge;

The above example commands suggested in the forum.

References

Creating image alias image variations in PHP

Mon, 31 Oct 2011 03:28:19 GMT

This is compatible with eZ Publish 4.

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

About

This is an example solution to generate or remove content object image datatype image alias image variations which do not yet exist within the system.

Example solution: bcimagealias extension

The solution bcimagealias extension is available for download on projects.ez.no/bcimagealias

Calling example script

This script generates or removes all image alias image variation image files in the system per siteaccess. Here is an example of how to call the script.

cd /path/to/ezpublish/;
./extension/ezimagealias/bin/php/bcimagealiases.php --siteacess ezwebin_site_user --generate

cd /path/to/ezpublish/;
./extension/ezimagealias/bin/php/bcimagealiases.php --siteacess ezwebin_site_user --remove

This extension also provides a workflow event and cronjob part to generate all image alias variation images in the system each time called. See INSTALL documentation within the extension.

External Reference

Project: bcimagealias
Doc: eZPersistentObject::fetchObjectList
Doc: eZImageAliasHandler
Forum: Creating image alias image variations in PHP
Forum: How to fetch class objects in PHP

Reference

ezimagealiashandler

Change the language of existing content objects

Thu, 20 Oct 2011 06:19:03 GMT

About

This is an example solution.

eng-GB -> eng-US

Very basic example to convert from eng-GB to eng-US

UPDATE ezcontentobject_name SET content_translation='eng-US', real_translation='eng-US' WHERE content_translation='eng-GB' AND real_translation='eng-GB';

eng-GB -> ger-DE

Very basic example to convert from eng-GB to ger-DE

UPDATE ezcontentobject_name SET content_translation='ger-DE', real_translation='ger-DE' WHERE content_translation='eng-GB' AND real_translation='eng-GB';
 
UPDATE ezcontentobject_attribute SET language_code='ger-DE' WHERE language_code='eng-GB';
 
UPDATE ezcontent_translation SET locale='ger-DE', name='Deutsch (Deutschland)' WHERE locale='eng-GB';

eng-GB -> ita-IT

Here is another example which converts all content from eng-GB to ita-IT (this example does not remove any languages from the system)

UPDATE ezcontentclass_attribute SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_attribute SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_attribute SET serialized_data_text = REPLACE( serialized_data_text, 'eng-GB', 'ita-IT' );
 
UPDATE ezcontentclass_name SET language_locale = REPLACE( language_locale, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass_name SET language_id = 3; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
 
UPDATE ezcontentclass SET initial_language_id = 2; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
UPDATE ezcontentclass SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'ita-IT' );
UPDATE ezcontentclass SET language_mask = 3;

eng-GB -> esl-ES

Here is another more specific example which converts content from eng-GB to esl-ES and removes eng-GB language

UPDATE ezcontentclass_attribute SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_attribute SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_attribute SET serialized_data_text = REPLACE( serialized_data_text, 'eng-GB', 'esl-ES' );
 
UPDATE ezcontentclass_name SET language_locale = REPLACE( language_locale, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass_name SET language_id = 3 WHERE language_id = 5; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
 
UPDATE ezcontentclass SET initial_language_id = 2, language_mask = 3 WHERE initial_language_id = 4 OR language_mask = 5; -- <id_of your intial LANGUAGE FROM TABLE ezcontent_language>
UPDATE ezcontentclass SET serialized_name_list = REPLACE( serialized_name_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass SET serialized_description_list = REPLACE( serialized_description_list, 'eng-GB', 'esl-ES' );
UPDATE ezcontentclass SET language_mask = 3; -- <id_of your esl-ES LANGUAGE FROM TABLE ezcontent_language>
 
DELETE FROM ezcontent_language WHERE locale = 'eng-GB';

External Reference

Module

Sun, 09 Oct 2011 06:33:46 GMT

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

What is a Module?

A Module offers an HTTP interface to a declared grouping or collection of Views. The default modules are declared in the default module.ini file. For example /kernel/content is a folder in the file system holding the View scripts of the 'content' Module. The module name 'content', declared in the module.ini, is used in URLs to route requests to the appropriate PHP View script file held on the file system for execution.

Modules are normally named as nouns while views are often named as a verb or a verb-object. e.g. http://www.example.com/index.php/user/login - where 'user' is the module and 'login' is the view.

Module development

eZ publish provides for custom applications and components through support of many kinds of extensions which a developer or administrator can instal. One of which is a module or custom module. Custom modules often use custom settings, designs, classes, cronjobs, workflows, triggers, etc.

Module extensions

When adding an extension which provides modules, 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 declaring your module's name in the ModuleList setting array, you also 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		A 2-level array defining the POST variables that will be accessible in the module, depending on the current action. The array keys are the action names, the values are an array with the key being the post var. name and the value being the php var. name. 'post_action_parameters' => array( 'EditLanguage' => array( 'SelectedLanguage' => 'EditSelectedLanguage' ) )
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

Simple example that shows 2 views and 2 policy functions. A user need to have the permission to use the function 'editors' in order to access the 'set_priority' view.

 
$Module = array( 'name' => 'services' );
 
$ViewList = array();
$ViewList[ 'set_priority'] = array( 'script' => 'set_priority.php',
                                    'functions' => array( 'editors' ) );
 
$ViewList[ 'right_column'] = array( 'script' => 'right_column.php',
                                    'functions' => array( 'public' ) );
 
$FunctionList = array();
$FunctionList[ 'public' ] = array();
$FunctionList[ 'editors' ] = array();

More Info: http://share.ez.no/forums/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)

Testing eZ Publish

Fri, 30 Sep 2011 00:24:51 GMT

Description

There exists two primary ways to create and perform automated testing on eZ Publish

Code testing with unit test suite

eZ publish includes a php test suite for unit tests available only from the eZ Publish subversion repository, /trunk/tests. With this test suite we test if functionality in eZ publish still works when we add a new feature, fix a bug, or before we make a new release. For more about this test suite read, eZ publish Test Suite.

Application testing with Selenium

You can create amazing browser based tests with Selenium.

There used to be a great article on Testing eZ Publish with Selenium on ez.no before the split of share.ez.no. Now all that remains is the demo code on projects.ez.no: http://projects.ez.no/article_testing_ez_publish_with_selenium.

A cool extension to automate functional testing with eZ Publish: http://projects.ez.no/eztestbrowser (and accompanying article in italian: http://www.cphp.it/2009/07/18/test-funzionali-su-ez-publish-con-phpunit-e-sfwebbrowser/)

References

Doc: eZ Publish Test System

Template logic to perform search and replace on strings

Sun, 18 Sep 2011 05:37:17 GMT

Hello, in this post I will show how to perform a simple string search and replace within an eZ Publish template variable.

Many new users to eZ Publish incorrectly think there is no search and replace operator within the eZ Publish template language...

Consider the following examples. I find them to be simpler and faster to use together than to mess with yet another custom operator or wrap_operator function call.

First you can do this in any template. Here is an example. Put this code into a template file:

{def $strDataInput='09/17/2011'
       $strData=$strDataInput|explode('/')|implode('.')}
 
{$strData}{* $strData will output '09.17.2011' *}
 
{undef}&nbsp;

This also works the same way in php. Here is an example:

<?php
$input = 'abcd efg hijk lmnop qrs tuv wxyz';
$output = implode( '-', explode( ' ', $input ) );
print_r( $input . "\n\n");
print_r( $output . "\n\n");
?>

I hope this helps others looking to avoid extra dependencies and complexities without giving up much needed functionality :)

References

[0] http://doc.ez.no/eZ-Publish/Technical-manual/3.9/Reference/Template-operators/Strings/str_replace/(language)/eng-GB

[1] http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/Template-operators/Arrays/implode/Convert-spaces-in-text-to-dashes/(language)/eng-GB

[2] http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/Template-operators/replacement-operator/Re-replacement-operator/(language)/eng-GB

[3] http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/Template-operators/Strings/explode/Explode-Implode-as-string-replacement/(language)/eng-GB

[4] http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/Template-operators/Arrays/implode/(language)/eng-GB

[5] http://doc.ez.no/eZ-Publish/Technical-manual/4.x/Reference/Template-operators/Strings/explode

[6] http://share.ez.no/blogs/brookins-consulting/tip-ez-publish-template-variable-search-and-replace

eZ Webin ezpagedata template operator

Fri, 05 Aug 2011 13:45:04 GMT

Background

In the early releases of the eZ Website Interface extension (eZ Webin), the pagelayout.tpl file was packed with calculations on which blocks to include where etc. This made quite a messy and suboptimal pagelayout.tpl.

To rectify this, eZ Systems moved a lot of this logic into a new general purpose template operator. This operator combines parameters from the view template, the ini system and the Template Look object, and returns an array of information the pagelayout.tpl template can use.

Unfortunately, they forgot to document it...

eZ Webin template operators

List of template operators included in eZ Webin:

ezpagedata( array $params ) - returns general page parameters to be used in pagelayout.tpl
ezpagedata_set( string $key, mixed $value ) - set persistent value for pagelayout, to be used in view templates
ezpagedata_append( string $key, mixed $value ) - append persistent value to array for pagelayout, to be used in view templates

The persistent_variable is originally only supported in the content view full module/view (the rationale is that the view cache takes effect only here). These template operators extends the support to other modules/views as well.

ezpagedata() template operator

Note: The parameter $params of this operator is an array that is merged with persistent_variable to produce the resulting hash. So if needed you can influence the results directly from pagelayout.tpl.

The return value is a hash that may currently contain the following elements:

persistent_variable - standard persistent variable from $module_result.content_info.persistent_variable
show_path - indicates if path should be shown
website_toolbar - indicates if website toolbar should be shown
node_id - specifies current node id
is_edit - indicates if we are in edit mode
page_root_depth - specifies the depth of the root node
page_depth - specifies the depth of the current node
root_node - specifies the node id of the root node
template_look - the template look content object
class_identifier - specifies the class identifier of the current node, same as $module_result.content_info.class_identifer
top_menu - template name for the top menu
left_menu - template name for the left menu
current_menu - identifier of the current menu
extra_menu - indicates whether extra column (right column) should be shown
extra_menu_node_id - indicates node id of node to use in extra column, default is current node
extra_menu_subitems - indicates number of sub items in extra column
extra_menu_class_list - list of classes to be used in extra column
path_array - list of nodes to be used in path
path_id_array - list of node ids to be used in path
path_normalized - normalized string of path identifiers
css_classes - string of CSS classes to be set in the <div id="page"> tag

Disclaimer: Note that there may be differences between different versions of eZ Webin. This list is based on an eZ Webin v.1.7 codebase.

Values of hash elements

The criterias for the values of the different pagedata() hash elements can be quite complex. The following is a partial list of the elements and the order in which the different values are set for each element. In this illustration line 1 is default value, line 2 takes precedence over line 1 if specified, etc.

Template look

pagedata.template_look

$persistent_variable['template_look']
Fetch first object of class identifier specified in $persistent_variable['template_look_class'] (by default it is the string 'template_look')

Current menu

pagedata.current_menu

menu.ini [SelectedMenu] CurrentMenu=<menu_name>

Top menu

pagedata.top_menu

menu.ini [SelectedMenu] TopMenu=<template_name>
$persistent_variable['top_menu']

Left column/menu

pagedata.left_menu

menu.ini [SelectedMenu] LeftMenu=<template_name>
$persistent_variable['left_menu']
$hideMenuClasses != false
menu.ini [MenuSettings] AlwaysAvailable == false && (.is_edit || 'content/versionview' || current_node_id == false || uicontext 'browse')

Note: .left_menu specify if .css_classes contains 'sidemenu' or 'nosidemenu'

Extra column/menu

pagedata.extra_menu

'extra_info'
$persistent_variable['extra_menu']
$hideMenuClasses != false

pagedata.extra_menu_node_id

current_node_id
$persistent_variable['extra_menu_node_id']

pagedata.extra_menu_class_list

array( 'infobox' )
$persistent_variable['extra_menu_class_list']
menu.ini [MenuContentSettings] ExtraIdentifierList=<class_identifier_list>

pagedata.extra_menu_subitems

0
$persistent_variable['extra_menu_subitems']
Count of number of sub items in top level of content tree, based on .extra_menu_node_id and .extra_menu_class_list?

Note: If .extra_menu_subitems is false, .extra_menu will also be set to false.
Note: .extra_menu specify if .css_classes contains 'extrainfo' or 'noextrainfo'

Simple fromString and toString interface for attributes

Thu, 23 Jun 2011 14:57:27 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 or a url|text

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.

powercontent

Sat, 18 Jun 2011 23:03:31 GMT

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

Power Content

Normally whenever new content is created, the system automatically creates and stores a new draft version of the object, before presenting it to the user for initial editing and publishing. If the content is being created from the Admin siteaccess or for example the user/register view, this is fine as the user would have explicitly decided to click on a 'Create Here' or 'Register' button before being presented with a content-edit view for adding their content. However, where we know what content type will be used but not when, it is often desireable for a front-end view of a site to have an empty content-entry from ready and waiting for the visitor/user to just enter some content and click 'Submit'. For example to have an Article and below it, a comment entry form ready for completion. If we try to do that with the default behaviour of eZ Publish we would be creating a blank draft comment every time the page was viewed. Although, there are cronjobs which routinely dispose of unused drafts, it is still not a good idea to use this behaviour in these cases, especially on a busy site, creating dozens or hundreds of abandoned drafts per day.

The 'Power Content' extension solves this issue in a way that complements the normal behaviour of eZ Publish. This is a very popular and useful extension. It provides a way to have a standard HTML form on the webpage that submits its data to a custom-module, which in turn uses that content to create and submit the object for publishing. So, even though there is a form ready for input every time the page is viewed, no draft or published object is created until after its data has been input by the user and the Submit button pressed. Core eZ Publish continues to behave as normal but this extension acts as a messenger to that normal behaviour. And the extension works with all content-classes and all content-class-attribute types, including any custom types. Use this extension whenever you know the content type to be created, want an input form present and ready to accept content, but don't want a draft to have been automatically created.

The Power content module allows one-click publishing or pre-filling of attributes, similar to the Object Creator extension.

However, it uses content/edit for the final processing. This module has one big advantage: it can deal with any type of attribute, even new custom ones.

Documentation

Compatibilty

3.10, 4.0

Usage

Installation instructions

1. Enable the extension (in site.ini.append or by using the admin interface)
2. Add a policy for this module to the desired roles.

How to use in your template

The main idea is to add new attributes that are going to contain the values you want instead of the default ones on ez publish. This module associate these new fields with standard fields that exist when editing with the default edit template. Therefore, you have to understand how ez names these fields so you can add the values you want.

A typical naming scheme for the input fields of an attribute is:

ContentObjectAttribute_[some attribute specific name]_[contentobjectattribute id]

For instance the name for the fields of an articles are (do a view source of the page when you're editing an article):

- title: ContentObjectAttribute_ezstring_data_text_1105
- into: ContentObjectAttribute_data_text_1108

(1105 and 1108 are contentobjectattribute identifier numbers that are going to be different on your installation.)

You will have to to change these names to:

powercontent_[contentclassattribute identifier]_ContentObjectAttribute_[some attribute specific name]_pcattributeid

For the article, it would be:

-title: powercontent_title_ContentObjectAttribute_ezstring_data_text_pcattributeid
-intro: powercontent_intro_ContentObjectAttribute_data_text_pcattributeid
When the Power Content module processes this kind of post variables, it will take their content and put them into the proper fields as if the user would have inputed it (it will inject fake post variables where the string "pcattributeid" will be replaced by the expected contentobjectattribute id).
On the top of the parameters you want to "prefill", you have to provide a few additional ones:

NodeID: The nodeid of the parent object you want to create (as an option, you can put "UserNode", that will put create it under the usernode of the currently logged in user)
ClassIdentifier: The class identifier of the object you want to create (you can provide either the class identifier or the class id, no need for both)
CreateButton: a submit button

You have more optional parameters:

RedirectToMainNodeAfterPublish: if you have installed and enabled the redirect extension, then you can use this post variable to redirect to the main node of the newly created object after publishing it.

powercontent_attribute_create_gui function

The powercontent_attribute_create_gui eases the process of creating the attribute input fields with the correct names for the powercontent extension.

Example of its usage:

{powercontent_attribute_create_gui class_attribute=$folderClass.data_map.name}

Currently there are templates included for the following datatypes:

Checkbox
Country
Date
E-mail
Enhanced selection
File
Float
Integer
URL
Selection
Text block
Text line

Feel free to commit yours to svn.

Examples code

1) Example code for the "article" content class. This will prefill the title and intro of the article:

<form method="post" action={"powercontent/action/"|ezurl}>
  <div class="buttonright">
  <input type="hidden" name="NodeID" value="{$owner.contentobject.main_node_id}" />
  <input type="hidden" name="ClassIdentifier" value="article" />
  <input type="hidden" name="powercontent_title_ContentObjectAttribute_ezstring_data_text_pcattributeid" value="A new article on my blog" />
  <input type="hidden" name="powercontent_intro_ContentObjectAttribute_data_text_pcattributeid" value="A new intro on my blog" />
   <input class="classbutton" type="submit" name="CreateButton" value="New article" />
</div>
</form>

2) Example code for the "File" content class:

<form method="post" action={"powercontent/action"|ezurl} enctype="multipart/form-data">
    <div>
    <input type="hidden" name="NodeID" value="{$node.main_node_id}" />
    <label>Publish immediately:</label> <input type="checkbox" name="DoPublish" checked="checked" />
    <input type="hidden" name="UseNodeAssigments" value="0" />
    <input type="hidden" name="ClassID" value="12" />
    <input type="hidden" name="RedirectURIAfterPublish" value="/{$node.url_alias}" />
    </div>
 
    <div>
    <label>File:</label>
    <input class="box" name="powercontent_file_ContentObjectAttribute_data_binaryfilename_pcattributeid" type="file" />
    </div>
    <div>
    <label>Title:</label>
    <input type="text" name="powercontent_name_ContentObjectAttribute_ezstring_data_text_pcattributeid" value="" />
    </div>
    <div>
    <input class="button" type="submit" name="CreateButton" value="Create" />
    </div>
</form>
</pre>

License

External reference

Article: eZ Publish Blog Enhancements: Making Commenting More Accessible
Mailing List: [Sdk-public] ez systems and ajax
Forum: Create a object without form
Forum: New node without a draft
Forum: Problem with powercontent: datetime, url, ezdhtml
White paper: eZ publish on steroids ( html )
Forum: Conditional form validation
Contribution: Object creator

Adding related object programmatic

Thu, 28 Apr 2011 13:13:40 GMT

Question

How to add related object programmatically ...

Answer

To add a list of object as an object relation through CLI, this code is not perfect and may remove any existing object relations you have.

Example

Here is an example eZ Publish PHP CLI Script which shows how to use this feature.

<?php
/**
 * tmp
 *
 * @package tmp
 * @author Olav Frengstad <olav.frengstad@07.no>
 */
require_once 'autoload.php';
 
$cli = eZCLI::instance();
 
$script = eZScript::instance( array(
        'description' => 'test script',
        'use-modules' => true,
        'use-extensions' => true,
) );
 
$script->startup();
 
$config = $argumentConfig = '';
 
$optionHelp = $arguments = false;
$useStandardOptions = array(
        'user'          => true,
        'siteaccess'    => true,
);
$options = $script->getOptions(
        $config,
        $argumentConfig,
        $optionHelp,
        $arguments,
        $useStandardOptions
);
 
$script->initialize();
 
$user = eZUser::fetchByName('admin');
if ( !$user )
{
        $user = eZUser::currentUser();
}
 
$rel = array(153);
$object = eZContentObject::fetch( 154 );
 
$object->appendInputRelationList( $rel,eZContentObject::RELATION_LINK );
$object->commitInputRelations($object->CurrentVersion);
$object->store();
 
$script->shutdown();

To run it save the file in your ez directory (preferably put it in an extension) and call it:

$ php relation.php --siteaccess <your-siteaccess-name>

News

Sun, 17 Apr 2011 03:35:04 GMT

Changelog

All about eZpedia's changes, improvements and additions.

2011-04-16 - Upgrade - eZpedia upgrades to eZ publish 4.5.0 (Community Project 4.2011)

2010-10-20 - Update - eZpedia adds list of latest github git repository activity to home page layout. Added display of issues related to the git commits displayed. This replaces previous svn activity list.

2010-10-19 - Upgrade - eZpedia upgrades to eZ publish 4.4.0 (and ezoe 5.x)

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

eZpedia upgraded to eZ Publish Community Project 4.2011

2011/04/17 @ 04:27:05 : Graham Brookins

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 07:39:25 : Nicolas Pastorino : Excellent initiative

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 06:26:21 : Carlos Revillo : Well done!

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 05:54:20 : Graham Brookins : Added recent git activity to home page

eZpedia upgraded to eZ Publish 4.4.0

2010/10/20 @ 02:59:58 : Graham Brookins

Cronjob

Fri, 25 Mar 2011 15:34:39 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

List of recommended cronjobs to run

every 10min:
------------------
ezflowupdate (only if you run specific ezflow blocks that need it)

hourly:
----------
notification.php (optional - enable it if you use email notifications)
workflow.php (optional - enable it if you use delayed workflow events)

daily:
---------
ldapusermanage.php (optional - syncs ldap user accounts)
ezfoptimizeindex.php (by night - in extension ezfind)
ezflowcleanup.php

weekly:
--------------
cluster_maintenance.php (by night)
internal_draft_cleanup.php (by night)
old_draft_cleanup.php (by night)
linkcheck.php (optional - removes invalid links)
unlocked.php (by night)

Optional:
-------------
- the script ezasynchromouspublish

- cronjobs in extension ezcomments (if you use it)

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:

Venkataraman Jeyakumar

Sat, 19 Feb 2011 13:09:00 GMT

Venkataraman Jeyakumar , popularly known as Dr.Venkataraman Jeyakumar who is aged 16 a young Distinguished Scientist from INDIA serving as RESEARCH AREA SCIENTIST at Microsoft Research with groups focusing on principles and applications of machine learning and reasoning, human-computer interaction, search and retrieval, probability theory. One among Junior Scientists in Microsoft Corporation, Venkataraman is an Extraordinary Creative Performer, who has a passion on Software development from the age of 12. Started his career by 10 in programming tools and soon, completed his degree at the age of 14, when his batch mates were in high school. Made a Record Breaking History of Inventing Answering Tools from CRM - CSO Based Applications, which not every Kid and even adult can do. Recipient WWW.Society Recognized Person, Business, 2008 by AAAI .His research interests and activities span theoretical and practical challenges with developing computational systems that perceive, learn and reason. Venkat's contributions include advances in principles of machine artificial intelligence and human-computer interaction. His efforts have led to the fielding of applications in multiple realms including healthcare, information retrieval, human-computer interaction, operating systems, aerospace.
Venkataraman has been elected Fellow of the Association for the Advancement of Artificial Intelligence (AAAI) and of the American Association for the Advancement of Science.
He has served as Council Administrator of the AAAI and is now the immediate past Advisor of the organization. He is a member of the NSF Computer and Information Science and Engineering Advisory Board and the Computing Community Consortium council. He has also served on the DARPA Information Science and Technology Study Group and on the Naval Research Advisory Committee.
Venkat is associate editor of the Decisions, Uncertainty, and Computation Area of the Journal of the ACM and is active on several other editorial boards.

Dr.Venkataraman Jeyakumar's Experience in ( VENKATARAMAN'S SOFTWARE SYSTEM RESEARCH CENTRE )

Vice-President
V's Software System Research Centre and Academy
Computer Software industry
February 2010 – Present (2 year 1 month)

Mission

The mission of the V's Software System Research Centre is to:

Advance software and information technology through research partnerships.

V's SSRCA is dedicated to:

* fostering innovative basic and applied research in software and information technologies;
* working with established companies, start-ups, government agencies, and standards bodies to develop and transition the technologies to widespread and practical application;
* educating the next generation of software researchers and practitioners in advanced software technologies; and
* supporting the public service mission of the University of California in developing the economic basis of the State of California.

Research Emphases

V's SSRC&A research emphases include:

Software, Software Architecture, Interactive and Collaborative Technologies, Design, Ubiquitous Computing, Web Technologies, Game Culture and Technologies

Guide to becoming fluent in eZ

Fri, 31 Dec 2010 10:20:07 GMT

Introduction

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

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

Roles

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

Paths

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

Goals

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

Avoid

Complaining too quickly
Being unclear
Being unorganized
Ignoring the details

Looking Back

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

References

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

Cache

Fri, 31 Dec 2010 10:06:33 GMT

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

For a general description of cache, we recommend cache on Wikipedia.

Types of cache in eZ Publish

eZ publish uses several caches to improve performance:

Cache Name	Short Description	Update
Content view cache	Cached node result.	On publish
Global INI	Recursively removes settings cache. Removes all files under var/cache/ini	On change (auto)
INI cache	Recursively removes settings cache. Removes all files under var/<sitefolder>/cache/ini	(auto)
Codepage cache	Removes the char translation tables. Recursively removes all files under var/<sitefolder>/cache/codepage	??
Expiry cache		On expire (auto)
Class identifier	Recursively removes all files under var/<sitefolder>/cache based on a regular expression.	Auto
Sort key cache	Recursively removes all files under var/<sitefolder>/cache based on a regular expression	Auto
URL alias cache	Cache contains a mapping of node urls to node ids. Recursively removes all files under var/<sitefolder>/cache/wildcard	Auto
Character transformation cache	Cache contains character mapping for url generation, search keywords translation and other. Recursively removes all files under var/<sitefolder>/cache/trans	?
Image alias	Cache contains all system generated image aliases ( resized images based on uploaded image ). Clearing that cache causes all images to get re-created.	Auto unused alias are never remove
Template cache	Included templates get cached. When using a lot of template includes that cache directory can contain a lot of files ( {include uri...}in template laguage ). Recursively removes all files under var/<sitefolder>/cache/template	Auto/manual
Template block cache	Cache contains all cache blocks ( {cache-block...}in template laguage ). Recursively removes all files under var/<sitefolder>/cache/template-block	Every 2 hours or when content expire
Template override cache	Cached version of the override.ini configuration file. Recursively removes all files under var/<sitefolder>/cache/override
RSS cache	Recursively removes all files under var/<sitefolder>/cache/rss (often xml files)	Check setting file
User info cache	Cache contains user permission. Recursively removes all files under var/<sitefolder>/cache/user-info

Additional cache types in eZ Publish

Clearing cache in eZ Publish

You can clear several caches with the setup/cache view or with the command line script bin/php/ezcache.php.

Solution: Clear Cache on eZ Publish

Additionally, you can configure eZ publish to accommodate further web caching.

References

Solution: Template Development Without Clearing Cache

Humor

Tue, 26 Oct 2010 23:27:42 GMT

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

About

Humorous mentions

Example

Reading individuals venting about eZ Publish on any medium (twitter, irc, forum, im, skype, face to face)

External References

Forum: eZ LolCats
Forum: Woefully complex upgrade process
Forum: Cease and desist
Forum: A non-loss in the family ...
Forum: Advice...Should I use eZ Publish?
Forum: ezwebin design orignal photoshop/gimp files

Albin Spreizer

Fri, 22 Oct 2010 14:07:32 GMT

Hallo Welt

Creating custom rss feeds using the layout/set module view

Thu, 21 Oct 2010 23:41:07 GMT

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

This article which describes in detail using the layout/set module view in various ways.

Example Settings

These are the example settings of an average layout.ini.append.php

span style="background-color: yellow;"> [podcast]
PageLayout=podcast_rss_pagelayout.tpl
ContentType=application/rss+xml
# Related issue, http://issues.ez.no/12677
# If you remove this line, URLs that are built using url_alias_list will have the following prepended, '/layout/set/json/'.
UseAccessPass=false
UseFullUrl=true
 
[podcast_episode]
PageLayout=podcast_episode_pagelayout.tpl
ContentType=text/html
# Related issue, http://issues.ez.no/12677
UseAccessPass=false
UseFullUrl=true
 
[discussions]
PageLayout=discussions_pagelayout.tpl
ContentType=application/rss+xml
 
[author]
PageLayout=author_rss_pagelayout.tpl
ContentType=application/rss+xml
# ContentType=text/xml
 
[comments]
PageLayout=comment_rss_pagelayout.tpl
ContentType=application/rss+xml
# ContentType=text/xml
 
[article_statistics.csv]
PageLayout=article_statistics_pagelayout.tpl
ContentType=text/csv
# ContentType=text/txt

Templates

Example template overrides for layout/set view.

Author Article RSS Feed

Example uri, '/layout/set/author?user=938'

 
 
{set-block scope=root variable=cache_ttl}0{/set-block}
{def $user_id=ezhttp( 'user', 'get' )}
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="http://example.com/rss/feed/user/{$user_id}" rel="self" type="application/rss+xml"/>
    <title>Example User Feed</title>
    <link>http://example.com</link>
    <description>A feed of the articles being started at example.com!</description>
    <language>en-US</language>
    <image>
      <url>http://example.com/var/ezwebin_site/storage/images/media/images/example_logo_rss.png</url>
      <title>example BETA User Feed</title>
      <link>http://example.com</link>
    </image>
{* ezhttp( 'user', 'get' )}  |-- <b>{$view_parameters.user}</b> {$view_parameters|attribute(show,1) *}
 
{if ezhttp_hasvariable( 'user', 'get' )}
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 42,
           'limit',           30,
           'depth',            3,
           'class_filter_type',  'include',
           'class_filter_array', array( 'article','comment' ),
           'attribute_filter', array( array( 'owner',
                                        '=',
                                        $user_id ) ),
           'sort_by', array( 'published', false() )
     ) )}
{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}{if $t.object.class_identifier|eq('article')} : {$t.name|trim|htmlentities}{else} on {$t.parent.name|trim|htmlentities}{/if}</title>
      <author>{$t.object.owner.data_map.user_account.content.email} ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if})</author>
      <link>http://example.com/{$t.url_alias}</link>
      <guid>http://example.com/{$t.url_alias}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}{/if}
 
  </channel>
</rss>

Article RSS Feed

Example uri, '/layout/set/articles'

 
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="http://example.com/rss/feed/articles" rel="self" type="application/rss+xml"/>    <title>example BETA article Feed</title>
    <link>http://example.com</link>
    <description>A feed of the articles from example.com</description>
    <language>en-US</language>
    <image>
      <url>http://example.com/var/ezwebin_site/storage/images/media/images/example-block-logo_rss.png</u
rl>
      <title>Example article Feed</title>
      <link>http://example.com</link>
    </image>
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 77,
           'limit',           30,           'sort_by', array( 'published', false() )
     ) )}{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}: {$t.name|trim|was
h}</title>
      <author>info@example.com ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if
})</author>
      <link>http://example.com/{$t.url_alias}</link>
      <guid>http://example.com/{$t.url_alias}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}
 
  </channel>
</rss>

Podcast RSS Feed

Example uri, '/layout/set/podcast'

 
{def $podcast_node_id=4200
     $max_episodes=50
     $podcast=fetch( 'content', 'node', hash( 'node_id', $podcast_node_id ) )
     $episodes=fetch( 'content', 'list', hash( 'parent_node_id', $podcast_node_id,
                                               'limit', $max_episodes,
                                               'class_filter_type', 'include',
                                               'class_filter_array', array( 'podcast_episode' ),
                                               'sort_by', array( 'published', false() ) ) )
     $podcastDescription='Example.com: The home of ...'
     $podcastItunesSubtitle='Example subtitle'
     $podcastItunesSummary='Example summary'
     $podcastItunesKeywords='Example, keywords'
     $podcastItunesCategory='News &amp; Opinion'
     $podcastImageUrl=concat('http://',ezsys('hostname'),'/extension/example/design/ezwebin/images/podcast/blocklogo144.jpg')
     $podcastItunesImageUrl=concat('http://',ezsys('hostname'),'/extension/example/design/ezwebin/images/podcast/ituneslogo.jpg')
     $podcastTitle=$podcast.data_map.title.content|trim|wash
     $siteUrl='http://example.com'
     $podcastUrl=concat($siteUrl,'/rss/feed/podcast')
     $podcastPageUrl=concat($siteUrl,'/podcast')
     $podcastItunesEmail='admin@example.com'
     $audioFileUrl=''
     $audioFileLength=''
     $episodeDatamap=''
}<?xml version="1.0" encoding="utf-8"?>
<rss xmlns:atom="http://www.w3.org/2005/Atom" xmlns:itunes="http://www.itunes.com/dtds/podcast-1.0.dtd" version="2.0">
  <channel>
    <title>{$podcastTitle}</title>
    <link>{$siteUrl}</link>
    <description>{$podcastDescription}</description>
    <language>en-US</language>
 
    <copyright>(C) example.com {currentdate()|datetime( 'custom', '%Y' )}</copyright>
    <image>
      <url>{$podcastImageUrl}</url>
      <title>{$podcastTitle}</title>
      <link>{$siteUrl}</link>
      <width>144</width>
      <height>144</height>
    </image>
    <atom:link href="{$podcastUrl}" rel="self" type="application/rss+xml"/>
    <category>{$podcastItunesCategory}</category>
    <itunes:image href="{$podcastItunesImageUrl}" />    <itunes:author>example.com</itunes:author>
    <itunes:subtitle>{$podcastItunesSubtitle}</itunes:subtitle>
    <itunes:summary>{$podcastItunesSummary}</itunes:summary>
    <itunes:keywords>{$podcastItunesKeywords}</itunes:keywords>
    <itunes:explicit>no</itunes:explicit>
    <itunes:owner>
      <itunes:name>example.com</itunes:name>
      <itunes:email>{$podcastItunesEmail}</itunes:email>
    </itunes:owner>
    <itunes:block>no</itunes:block>
    <itunes:category text="{$podcastItunesCategory}"/>
    <pubDate>{if $episodes[0]}{if $episodes[0].data_map.published.has_content}{$episodes[0].data_map.published.content.timestamp|datetime('custom', '%D, %d %M %Y %H:%
i:%s -0700')}{else}{$episodes[0].object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{/if}{/if}</pubDate>
    <lastBuildDate>{currentdate()|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}</lastBuildDate>
{foreach $episodes as $episode}
{set $episodeDatamap=$episode.data_map
     $audioFileUrl=$episodeDatamap.audio.content
     $audioFileLength=$episodeDatamap.audio_length.content
}
    <item>
      <title>{$episode.name|trim|wash}</title>
{if $episodeDatamap.audio.has_content}
 
      <link>{$audioFileUrl}</link>
{else}
 
      <link>{$podcastPageUrl}</link>
{/if}
 
      <description>{$episodeDatamap.description.content|trim|wash}</description>
      <pubDate>{if $episodeDatamap.published.has_content}{$episodeDatamap.published.content.timestamp|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{else}{$episode.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s -0700')}{/if}</pubDate>
{if $episodeDatamap.audio.has_content}
 
      <enclosure url="{$audioFileUrl}" length="{$audioFileLength}" type="audio/mpeg"/>
      <guid isPermaLink="false">{$audioFileUrl}</guid>
{/if}
      <category>{$episodeDatamap.category.content|trim|wash}</category>
      <itunes:author>example.com</itunes:author>
      <itunes:subtitle>{$episodeDatamap.subtitle.content|trim|wash}</itunes:subtitle>
      <itunes:summary>{$episodeDatamap.description.content|trim|wash}</itunes:summary>
      <itunes:keywords>{$episodeDatamap.keywords.content.keyword_string|trim|wash}</itunes:keywords>
      <itunes:explicit>{if $episodeDatamap.explicit.content}yes{else}no{/if}</itunes:explicit>
      <itunes:duration>{$episodeDatamap.duration.content|trim}</itunes:duration>
    </item>
{/foreach}
  </channel>
</rss>

Comment RSS Feed

Example uri, '/layout/set/comment'

 
{set-block scope=root variable=cache_ttl}0{/set-block}
<?xml version="1.0" encoding="utf-8"?>
<rss version="2.0" xmlns:atom="http://www.w3.org/2005/Atom">
  <channel>
    <atom:link href="http://example.com/rss/feed/comments" rel="self" type="application/rss+xml"/>
    <title>Example Comment Feed</title>
    <link>http://example.com</link>
    <description>A feed of the comments from example.com.</description>
    <language>en-US</language>
    <image>
      <url>http://example.com/var/ezwebin_site/storage/images/media/images/example-block-logo-rss.png</url>
      <title>example BETA Comment Feed</title>
      <link>http://example.com</link>
    </image>
{def $topics=fetch( 'content', 'list',
     hash( 'parent_node_id', 77,
           'limit',           30,           'depth',            3,
           'class_filter_type',  'include',           'class_filter_array', array( 'comment' ),
           'sort_by', array( 'published', false() )
     ) )}
{if $topics|count|gt(0)}
{foreach $topics as $t}
    <item>
      <title>{if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if}{if $t.object.class
_identifier|eq('article')} : {$t.name|trim|htmlentities}{else} on {$t.parent.name|trim|htmlentities}{/if}</title>
      <author>{$t.object.owner.data_map.user_account.content.email} ({if $t.object.owner.data_map.pen_name.has_content}{$t.object.owner.data_map.pen_name.content}{else}{$t.data_map.author.data_text}{/if})</author>
      <link>http://example.com/{$t.parent.url_alias}/(comment)/{$t.node_id}#comment-{$t.node_id}</link>
      <guid>http://example.com/{$t.parent.url_alias}/(comment)/{$t.node_id}#comment-{$t.node_id}</guid>
      <description><![CDATA[{$t.data_map.body.content.output.output_text}]]></description>
      <pubDate>{$t.object.published|datetime('custom', '%D, %d %M %Y %H:%i:%s PDT')}</pubDate>{*
      <pubDate>Sat, 04 Jul 2010 13:54:12 GMT</pubDate> *}
    </item>
{/foreach}{/if}
 
  </channel>
</rss>

Article Statistics CSV Export

Example uri, '/layout/set/article_statistics.csv?startDate=2010-07-14&endDate=2010-07-19'

 
{* Example: http://example.com/layout/set/article_statistics.csv?startDate=2010-07-14&endDate=2010-07-19 *}
{def $articles=false()
$commentCount=false()
$articleTitle=false()
$articleOwner=false()
$articleDate=false()
$articleTime=false()
$articleWordCount=false()
$articleFollowCount=false()
$articleShareCount=false()}
 
{if and( ezhttp_hasvariable( 'startDate', 'get' ), ezhttp_hasvariable( 'endDate', 'get' ) )}
 
{def $startDate=ezhttp( 'startDate', 'get' )|explode("-")
     $endDate=ezhttp( 'endDate', 'get' )|explode("-")}
{def $startDateTimestamp=maketime(0,0,0,$startDate.1,$startDate.2,$startDate.0)
     $endDateTimestamp=maketime(23,59,59,$endDate.1,$endDate.2,$endDate.0)}
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'attribute_filter', array( array( 'published', '>=', $startDateTimestamp ),
                                array( 'published', '<', $endDateTimestamp ) )
 ) )}
{else}
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'limit', 10000
 ) )}
{/if}"Date","Time","Title","Who","Words","Comments","Followers","Shared","Post or Comment","Url"
 
{foreach $articles as $con}{* article variables count etc. Counts the words in the body xml string *}{set
     $commentCount=fetch( 'content', 'tree_count', hash(
     'parent_node_id', $con.object.main_node_id,
     'class_filter_type', 'include',
     'class_filter_array', array( 'comment' ) ) )
     $articleTitle=$con.object.name|explode('"')|implode("")
     $articleOwner=$con.object.owner.name|explode('"')|implode("")
     $articleWordCount=$con.data_map.body.content.output.output_text|explode( '>' )|implode( '> ' )|strip_tags|simplify|explode( ' ' )|count
     $articleFollowCount=fetch( 'example', 'getfollowerscount', hash( 'id', $con.node_id ) )
     $articleShareCount=fetch( 'example', 'getsharecounts', hash( 'id', $con.node_id ) )
     $articleDate=$con.object.published|datetime( 'custom', '%d-%M' )
     $articleTime=$con.object.published|datetime( 'custom', '%h:%i:%s %A' )
}
"{$articleDate}",{$articleTime},"{$articleTitle}","{$articleOwner}",{$articleWordCount},{$commentCount},{$articleFollowCount},{$articleShareCount},"P","http://example.com/{$con.url_alias}"
 
{/foreach}

References

Doc: Offical layout module documentation
Doc: A word about using layout.ini for printer friendly pagelayout.
Doc: A comment about layout.ini settings
Forum: custom icalendar pagelayout example
Forum: disable debug for custom layout/set layouts
Forum: view cache with layout/set
Search: layout/set

eZ ODF - Converting MS Word or PDF on MacOSX 10.4 -10.6

Thu, 21 Oct 2010 16:11:40 GMT

About

For some of the nice feature of the ODF extension, like MS Word import and export and PDF generation via OpenOffice.org you need OpenOffice.org installed on your server and running as daemon.

You can follow the installation guide from the official ezodf documentation.

Solution: Converting MS Word or PDF on Mac

These instructions were written from the perspective of attempting to manipulating ms word or pdf documents on MacOSX 10.4 -10.6

First install open office, you may prefer to install this MacOS port of open office called, neooffice / neojava.
Alternative OpenOffice.org: http://download.openoffice.org/other.html

Step 1, Install NeoJava

Step 2, Follow eZ ODF Installation documentation steps almost to completion (wait till next step before starting daemon).

Install extension, macro, daemon, etc

Optional, Step 3, Before starting the daemon via command shell ...

Edit the file, extension/ezodf/daemon.php with a PHP editor and change line 40:

$ooexecutable = "openoffice.org-2.0";
 
to
 
$ooexecutable = "/Applications/NeoOffice.app/Contents/MacOS/soffice";

Alternative OpenOffice.org:

$ooexecutable = "openoffice.org-2.0";
 
to
 
$ooexecutable = "/Applications/OpenOffice.org.app/Contents/MacOS/soffice";

Summary

Start now your daemon.

 
$ php extension/ezodf/daemon.php

That's all and now you can work with it.

Tested

This article was tested with the following

October 2010

eZ Publish Open Source Version: 4.4
eZ Publish Open Source Version: 3.2

October 2007: XAMPP for MacOS X 0.7.0, 7

eZ Publish Version: 4.0.0rc1
PHP Version: 5.2.4

October 2007: XAMPP for MacOS X 0.7.0, 7

Functionality tested, Import / Export .doc and Export PDF
Webserver software, ApacheFriends' Xampp
eZ Publish Version: 3.10.0
PHP Version: 4.4.7

Issues

Perhaps of bug in Online Editor < 5.0

Cluster

Wed, 01 Sep 2010 09:12:24 GMT

For a general description of cluster, we recommend cluster on Wikipedia.

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

About

Their are several publicly available cluster solutions available for hosting eZ Publish.

References

Documentation
- Clustering feature
Articles
- Clustering in eZ publish 3.8
Blog: Experiences using clustering with eZ publish 3.8
Bertrand Dunogier's presentation : eZ Cluster unleashed

How to fetch content based on view parameter date range

Wed, 21 Jul 2010 17:48:13 GMT

Summary

This solution is template based and very simple.

It optionally relies on view parameters to provide a date range with which to limit the fetch results.

{* Example: http://example/layout/set/content_statistics.csv/(startDate)/2010-07-14/(endDate)/2010-07-19/ *}
{def $articles=false()}
 
{if and( is_set( $view_parameters.startDate ), is_set( $view_parameters.endDate ) )}
 
{def $startDate=$view_parameters.startDate|explode("-")
$endDate=$view_parameters.endDate|explode("-")}
 
{def $startDateTimestamp=maketime(0,0,0,$startDate.1,$startDate.2,$startDate.0)
$endDateTimestamp=maketime(23,59,59,$endDate.1,$endDate.2,$endDate.0)}
 
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'attribute_filter', array( array( 'published', '>=', $startDateTimestamp ),
                                array( 'published', '<', $endDateTimestamp ) )
 ) )}
{else}
 
{set $articles=fetch( 'content', 'list', hash(
     'parent_node_id', 77,
     'class_filter_type', 'include',
     'class_filter_array', array( 'article' ),
     'sort_by', array( 'published', false() ),
     'limit', 10000
 ) )}
{/if}

References

These forum threads were the basis for this solution. Thanks to the contributors for the hints and tips.

Google Webmaster Tools

Thu, 08 Jul 2010 18:04:20 GMT

In order to register your eZ Publish website in Google Webmaster Tools, you need to verify you are the owner of the site. One possibility, and in case of eZ Publish the easiest, is adding an additional HTML meta header to your web pages.

You can add the verification code you get from Google Webmaster tools, In the site.ini.append.php file

either as a global override (settings/override/site.ini.append.php)
or just for specific site accesses (settings/siteaccess/[yoursiteaccessname]/site.ini.append.php)

[SiteSettings]
MetaDataArray[verify-v1]=yourgooglewebmastertoolscode

eZ Flow - Installing Red5 with XAMPP 0.7.0 on MacOS X Intel 10.4.11

Fri, 11 Jun 2010 21:21:06 GMT

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

About

A simple howto for red5, macos, xampp, ezflow, ezpublish.

Directions

If you want to install red5 on MacOS X

Download the .dmg ( now available at: http://code.google.com/p/red5/ )
click and install
then go into Applications, Red5 and click the Red5.app or Red5 (with the Red5 icon) to start it.
If you use XAMPP on MAC go into /Applications/xampp/etc/httpd.conf, add

Alias /red5 /Applications/Red5/webapps/test/streams
<Directory "/Applications/Red5/webapps/test/streams">
AllowOverride None
Options None 
Order allow,deny
Allow from all
</Directory>

Restart Apache.

In eZ Admin put in Stream Server: rtmp://localhost:1935/test/

FileServer: http://localhost/red5/

References

Article: red5
Red5 Downloads: http://www.osflash.org/red5/red5downloads
XAMPP Downloads: http://www.apachefriends.org/de/xampp-macosx.html (XAMPP for MacOS X 0.7.0, 7. October 2007)

AMF

Sun, 25 Apr 2010 17:01:58 GMT

About

Flash Remoting support for the Action Message Format (AMF is a based binary format in SOAP).
AMF protocol support can be provided by jvAMF extension (based on Zend_AMF component).

Please refer to the documentation of the extension for extended details.

References

Flash remoting for PHP: Zend_AMF, amfphp.org
Forum: Macromedia Flash + Ezpublish :: expanding possibilities
jvAMF Extension

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

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

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~~

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.

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