Blog de Thomas ZILLIOX » eZ Publish

Réparer la BDD d’eZ Publish

tzilliox — Fri, 18 Mar 2011 12:00:00 +0000

J’ai réussi à mettre eZ Publish dans un état instable.
J’avais quelques objets sans nœuds associés, ce qui provoque des comportements bizarres.

J’avais alors corrigé ma BDD à la main. Mais suite à la rédaction de cet article, Alexandre SEBBANE m’a fait remarqué la présence du script bin/php/flatten.php.
Ce script a pour but de supprimer de la BDD les informations non utilisées. Il peut s’agir des contentobject, contentclass, workflow, role ou de tout.

Pour nettoyer les objets sans nœuds associés, il faudrait essayer la ligne de commande ci-dessous.
Par contre, vous allez supprimer toutes les anciennes versions des objets publiés et les brouillons encore non-publiés :

bin/php/flatten.php -s admin contentobject

Si ça ne marche pas, vous pouvez toujours faire comme moi. Exécutez plusieurs fois la commande SQL ci-dessous pour supprimer les nœuds sans parent :

DELETE FROM ezcontentobject_tree WHERE parent_node_id NOT IN
( SELECT * FROM
(SELECT node_id FROM ezcontentobject_tree)
tmp );

Puis exécutez les commandes SQL ci-dessous pour supprimer les objets qui n’ont pas de nœuds associés :

DELETE FROM ezcontentobject_attribute WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject_version WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject_name WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcobj_state_link WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject WHERE id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM eznode_assignment WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject_link WHERE from_contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject_link WHERE to_contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);
DELETE FROM ezcontentobject_trash WHERE contentobject_id NOT IN
(SELECT contentobject_id FROM ezcontentobject_tree);

Ce n’est pas une solution propre, mais ça peut dépanner.

Pour éviter ce genre de soucis, prennez l’habitude de faire des sauvegarder régulières de vos BDD

En espérant que ça puisse vous aider,
Thomas.

Bookmarklet de mise en forme des traces de debug sous eZ Publish

tzilliox — Mon, 22 Aug 2011 20:00:00 +0000

Sous eZ Publish, on peut afficher des traces de debug directement en front-office.
Dans cet article je vous présente un petit Bookmarklet que j’ai fait pour améliorer leur rendu.

Pour installer ce Bookmarklet, faîtes glisser ce lien dans votre barre de favoris : eZ Filter Debug
Pour activer ce Bookmarklet, cliquez dessus lorsque vous êtes sur une page générée par eZ Publish avec les traces de debug activée
Vous pouvez lire cette article, si vous voulez en savoir plus sur comment faire un Bookmarklet

Le Bookmarklet « eZ Filter Debug » se résume en 3 fonctionnalités qui peuvent vous intéresser :

1. Chargement de la feuille de style debug.css

Pour mettre en forme les traces de debug, il faut charger la feuille de style debug.css.
Mais on n’a pas forcément envie de la charger tout le temps, surtout en production.
C’était l’idée de départ : ce Bookmarklet charge à la volée la feuille de style de Debug.

2. Afficher les traces de debug à la demande

La deuxième idée est de pouvoir cacher les traces de debug par défaut.
Pour cela, il suffit de rajouter dans votre feuille CSS la ligne suivante :

#debug {display: none;}

Lorsque vous activerez le Bookmarklet, les traces de Debug s’afficheront, et vous serez redirigé vers elles.

Ceci n’est pas forcément utile, car eZ Publish vous permet déjà de n’afficher les traces de Debug que pour une certaine liste d’IP.
Mais ça peut être pratique dans certains cas : IP dynamique, client interne, site mobile, etc.

3. Permettre de filtrer les traces de debug

Les traces de Debug affichent également les traces de Notice, Timing, Warning et Error.
Pas toujours facile de s’y retrouver en un coup d’oeil.
Du coup le Bookmarklet « eZ Filter Debug » vous propose également une option de filtrage :

Note 1 : ce Bookmarklet a été testé sous eZ Publish 4.3 – 4.5.
Note 2 : Le code du Bookmarklet est diponible sur GitHub.
N’hésitez pas en me faire des remarques, soit par commentaire, soit par le formulaire de contact de mon site.

En espérant que ça puisse vous être utile,
Thomas.

Traduction avec paramètres sous eZ Publish

tzilliox — Thu, 18 Aug 2011 20:00:00 +0000

Une petite astuce pour les traductions sous eZ Publish, on peut utiliser des paramètres.
Par exemple, on est pas obligé de couper la traduction de « Plus que 3 exemplaires. » si la valeur 3 est dynamique.

Vous pouvez utiliser dans votre template le code ci-dessous :

{"Only %quantity left in stock."|i18n('shop', , hash('%quantity', $product.stock))}

Et utiliser dans votre fichier de traduction, le code ci-dessous :

<!DOCTYPE TS>
<TS>
<context>
<name>shop</name>
<message>
<source>Only %quantity left in stock.</source>
<translation>Plus que %quantity exemplaires.</translation>
</message>
</context>
</TS>

En espérant que ça puisse vous aider,
Thomas.

Récupérer les view parameters dans une vue

tzilliox — Tue, 16 Aug 2011 20:00:00 +0000

Dans une template « classique », on a accès à la variable $view_parameters.
Celle-ci contient les valeurs des paramètres personnalisés passés dans l’url.
Par exemple pour l’url suivante :

http://www.example.com/my/url/alias/(couleur)/vert/(prix)/34

On pourra accéder aux paramètres « couleur » et « prix » à l’aide de la variable $view_parameters :

La couleur est : {$view_parameters.couleur}
Le prix est : {$view_parameters.prix}

Par contre, vous n’avez pas accès à $view_parameters dans une vue d’un module.
Mais on peut quand même les récupérer à l’aide du code suivant :

$uri = eZURI::instance( eZSys::requestURI() );
$viewParameters = $uri->UserParameters();

On peut ensuite facilement les passer à une template :

// Récupérer les view_parameters
$uri = eZURI::instance( eZSys::requestURI() );
$viewParameters = $uri->UserParameters();

// Instancier la template
$tpl = templateInit();
$tpl->setVariable( 'view_parameters', $viewParameters );

// Renvoyer le résultat de la vue
$Result = array();
$Result['content'] = $tpl->fetch( "design:<ma/template.tpl>" );

En espérant que ça puisse vous aider,
Thomas.

Désactiver un module ou une vue dans eZ Publish

tzilliox — Tue, 26 Apr 2011 12:00:00 +0000

Voici un court tutoriel pour désactiver un module ou une vue dans eZ Publish.

Ajouter dans le site.ini.append.php de votre siteaccess les lignes ci-dessous :

[SiteAccessRules]
Rules[]
Rules[]=access;enable
Rules[]=moduleall
Rules[]=access;disable
Rules[]=module;ezinfo
Rules[]=module;user/register

Ces lignes d’exemples permettent de désactiver le module « ezinfo » et la vue « user/register » pour un siteaccess donné.

En espérant que ça puisse vous aider,
Thomas.

Récupérer le résultat d’une vue de module eZ Publish

tzilliox — Mon, 28 Mar 2011 12:00:00 +0000

Il peut être pratique de réutiliser le code d’une vue de module eZ Publish à partir d’une autre page.
Par exemple, pour ne pas dupliquer le code entre les requêtes directe et les requêtes AJAX.

Vous pouvez utiliser le code ci-dessous pour récupérer le résultat de la vue « user/login » :

$module = eZModule::findModule( "user");
$return = $module->run("login");
$content = $return['content']

En espérant que ça puisse vous aider,
Thomas.

Le français comme langue de référence sur un site multilingue eZ Publish

tzilliox — Thu, 28 Jul 2011 19:00:00 +0000

eZ Publish dispose d’un moteur i18n ou d’internationalisation.

1. Presentation
On peut l’utiliser dans les templates à l’aide de l’opérateur i18n() :

{$string|i18n($context)}
{'The results'|i18n('search')}

Dans le ficher translations/fre-FR/translation.ts, on peut lui indiquer les valeurs en français :

<!DOCTYPE TS>
<TS>
<context>
<name>search</name>
<message>
<source>The results</source>
<translation>Les résultats</translation>
</message>
</context>
</TS>

2. Utiliser des sources en français
Dans le sens anglais > français, il n’y a pas de soucis.
Sauf qu’on est pas tous bilingue, donc ça peut être plus pertinent de prendre le français comme référence.

Le problème est que le moteur i18n ne va pas utiliser le fichier de traduction translations/eng-GB/translation.ts.
Il doit sûrement supposer que la langue de référence est forcément l’anglais.
La petite astuce est d’utiliser la langue eng-GB@euro.
Donc de mettre ses traducitons dans le fichier translations/eng-GB@euro/translation.ts.

3. Encodage
Un dernier problème, le moteur ne gère pas naturellement les caractères accentués en tant que source.
Alors que bizarrement, il n’y avait pas de problème d’encodage pour les traductions dans le sens anglais > français.

Pour que ce code-là fonctionne dans votre template :

{'Les résultats'|i18n('search')}

Il vous faudra encoder les accents dans votre fichier de traduction translations/eng-GB@euro/translation.ts :

<!DOCTYPE TS>
<TS>
<context>
<name>search</name>
<message>
<source>Les résultats</source>
<translation>The results</translation>
</message>
</context>
</TS>

Dans ce fichier, é représente le caractère é.
E9 est la valeur numériques hexadécimal du caractère.
Pour connaître les valeurs hexadécimale, il faut utiliser un convertisseur de caractères.

Conclusion
Si tous les membres de votre équipe sont à l’aise avec l’anglais, il vaut mieux garder l’anglais en tant que langue de référence.
Vous garderez des fichiers de traductions plus lisible et maintenable.

En espérant que ça puisse vous aider,
Thomas.

Problèmes après avoir supprimé un user eZ Publish

tzilliox — Fri, 29 Jul 2011 19:00:00 +0000

Pour les versions d’eZ Publish inférieur à 4.4.1, il fallait éviter de supprimer un utilisateur eZ Publish.
Même supprimé, tous les contenus qu’il a publié lui font encore référence.
Ceci pose quelques problèmes dans le Back Office d’eZ Publish. Par exemple, l’interface n’arrive plus à lister les sous-éléments.
C’est pour cela qu’il valait mieux désactiver un utilisateur que le supprimer.

Si c’est trop tard et qu’il est supprimé, comme ça m’est arrivé, on peut réparer sa BDD.
On peut le faire à la main, il suffit de réassocier tous les contenus crées par des utilisateurs supprimés.

Voici les requêtes SQL à exécuter :

UPDATE ezcontentobject SET owner_id=14 WHERE owner_id NOT IN
(SELECT contentobject_id FROM ezuser);
UPDATE ezcontentobject_version SET creator_id=14 WHERE creator_id NOT IN
(SELECT contentobject_id FROM ezuser);

Ici, 14 représente l’id de votre utilisateur admin.

En espérant que ça puisse vous aider,
Thomas.

Edit: Merci à Damien POBEL pour m’avoir montré que le bug était désormais corrigé.

Impossible de publier des objets eZ Publish en PHP ?

tzilliox — Mon, 14 Mar 2011 18:00:00 +0000

Vous écrivez un script PHP pour eZ Publish et vous rencontrez l’erreur : « Missing operation definition file for module: content »
C’est surement que vous avez oublié d’activer les modules dans la déclaration de votre script :

// Initialisation
$script = eZScript::instance( array(
'description' => 'Description of my script',
'use-session' => false,
'use-modules' => true,
'use-extensions' => true,
'debug-output' => true,
'debug-message' => true
) );
$script->startup();
$script->initialize();

// Complete the script here

// End
$script->shutdown();

En espérant que ça puisse vous aider,
Thomas.

Récupérer l’id d’une classe de contenu eZ Publish à partir de son identifier

tzilliox — Fri, 15 Jul 2011 12:00:00 +0000

Quand on liste les nœuds dans eZ Publish, un peut limiter la recherche à certaines classes de contenus.
Le seul problème c’est qu’il faut indiquer l’ « id » (numéro) des classes et on connaît plus souvent leur « identifier » (nom).

En PHP on peut facilement passer de l’un à l’autre à l’aide du code suivant :

$content_class_id = eZContentClass::classIDByIdentifier($content_class_name);

Par contre, je ne connais pas d’opérateur de template qui permette de faire cette conversion.

En espérant que ça puisse vous aider,
Thomas.