Comportements

Les comportements sont des actions appelées à des emplacements précis. Ils sont ajoutés par des plugins qui peuvent ainsi étendre la manière dont DotClear effectue certaines actions, ou l'affichage de certaines parties de l'interface d'administration.

Un plugin foo veut réaliser une action avant qu'un billet soit modifié. Il faut d'abord définir une fonction qui sera enregistrée ensuite comme comportement :

class fooBehaviors
{
  public static function beforePostUpdate(&$cur,$post_id) {
    $cur->post_title = 'titre foo';
  }
}

Cette fonction va changer le titre du billet, avant qu'il soit inséré en base de donnée, par "titre foo". On déclare maintenant le comportement :

$core->addBehavior('adminBeforePostUpdate',array('fooBehaviors','beforePostUpdate'));

Le premier argument de cette méthode est le nom du comportement, le second est la fonction de callback appelée lors de l'événement.

Appel du behavior :

$core->callBehavior('adminAfterBlogCreate',$cur,$blog_id,$settings);

Cet événement est appelé après la création d'un blog.

Exemple de signature

function adminAfterBlogCreate($cur,$blog_id,$settings)

Appel du behavior :

$core->callBehavior('adminAfterBlogUpdate',$cur,$blog_id);

Cet événement est appelé après la mise à jour d'un blog.

Exemple de signature :

function adminAfterBlogUpdate($cur, $blog_id)

Appel du behavior :

$core->callBehavior('adminAfterCategoryCreate',$cur,$cat_id);

Cet événement est appelé après la création d'une catégorie.

Exemple de signature :

function adminAfterCategoryCreate($cur, $cat_id)

Appel du behavior :

$core->callBehavior('adminAfterCategoryUpdate',$cur,$cat_id);

Cet événement est appelé après la mise à jour d'une catégorie.

Exemple de signature :

function adminAfterCategoryUpdate($cur, $cat_id)

Appel du behavior :

$core->callBehavior('adminAfterCommentDesc', $rs);

Cet événement permet d'afficher des informations supplémentaires après la description d'un commentaire.

Exemple de signature :

function adminAfterCommentDesc($rs)

Appel du behavior :

$core->callBehavior('adminAfterCommentCreate',$cur,$comment_id);

Cet événement est appelé après la création d'un nouveau commentaire sur l'interface d'administration.

Exemple de signature :

function adminAfterCommentCreate($cur,$comment_id)

Appel du behavior :

$core->callBehavior('adminAfterCommentUpdate',$cur,$comment_id);

Cet événement est appelé après la mise à jour d'un commentaire sur l'interface d'administration.

Exemple de signature :

function adminAfterCommentUpdate($cur,$comment_id)

Appel du behavior :

$core->callBehavior('adminAfterPostCreate',$cur,$return_id);

Cet événement est appelé après la création d'un post.

Exemple de signature :

function adminAfterPostCreate($cur, $return_id)

Appel du behavior :

$core->callBehavior('adminAfterPostUpdate',$cur,$post_id);

Cet événement est appelé après la mise à jour d'un post.

Exemple de signature :

function adminAfterPostUpdate($cur, $post_id)

Appel du behavior :

$core->callBehavior('adminAfterUserCreate',$cur,$new_id);

Cet événement est appelé après la création d'un utilisateur.

Exemple de signature :

function adminAfterUserCreate($cur, $new_id)

Appel du behavior :

$core->callBehavior('adminAfterUserUpdate',$cur,$new_id);

Cet événement est appelé après la mise à jour d'un utilisateur.

Exemple de signature :

function adminAfterUserUpdate($cur, $new_id)

Appel du behavior :

$core->callBehavior('adminBeforeBlogSettingsUpdate',$blog_settings);

Cet événement est appelé avant la mise à jour des settings d'un blog.

Exemple de signature :

function adminBeforeBlogSettingsUpdate($blog_settings)

Appel du behavior :

$core->callBehavior('adminBeforeBlogCreate',$cur,$blog_id);

Cet événement est appelé avant la création d'un blog.

Exemple de signature

function adminBeforeBlogCreate($cur,$blog_id)

Appel du behavior :

$core->callBehavior('adminBeforeBlogUpdate',$cur,$blog_id);

Cet événement est appelé avant la mise à jour d'un blog.

Exemple de signature :

function adminBeforeBlogUpdate($cur, $blog_id)

Appel du behavior :

$core->callBehavior('adminBeforeCategoryCreate',$cur);

Cet événement est appelé avant la création d'une catégorie.

Exemple de signature :

function adminBeforeCategoryCreate($cur)

Appel du behavior :

$core->callBehavior('adminBeforeCategoryUpdate',$cur,$cat_id);

Cet événement est appelé avant la mise à jour d'une catégorie.

Exemple de signature :

function adminBeforeCategoryUpdate($cur, $cat_id)

Appel du behavior :

$core->callBehavior('adminBeforeCommentCreate',$cur);

Cet événement est appelé avant la création d'un nouveau commentaire sur l'interface d'administration.

Exemple de signature :

function adminBeforeCommentCreate($cur)

Appel du behavior :

$core->callBehavior('adminBeforeCommentUpdate',$cur,$comment_id);

Cet événement est appelé avant la mise à jour d'un commentaire sur l'interface d'administration.

Exemple de signature :

function adminBeforeCommentUpdate($cur,$comment_id)

Appel du behavior :

$core->callBehavior('adminBeforePostCreate',$cur);

Cet événement est appelé avant la création d'un post.

Exemple de signature :

function adminBeforePostCreate($cur)

Appel du behavior :

$core->callBehavior('adminBeforePostUpdate',$cur,$post_id);

Cet événement est appelé avant la mise à jour d'un post.

Exemple de signature :

function adminBeforePostUpdate($cur, $post_id)

Appel du behavior :

$core->callBehavior('adminBeforePostDelete',$post_id);

Cet événement est appelé avant la suppression d'un post.

Exemple de signature :

function adminBeforePostDelete($post_id)

Appel du behavior :

$core->callBehavior('adminBeforeUserCreate',$cur);

Cet événement est appelé avant la création d'un utilisateur.

Exemple de signature :

function adminBeforeUserCreate($cur)

Appel du behavior :

$core->callBehavior('adminBeforeUserDelete',$u);

Cet événement est appelé avant la suppression d'un utilisateur.

Exemple de signature :

function adminBeforeUserDelete($user_id)

Appel du behavior :

$core->callBehavior('adminBeforeUserUpdate',$cur,$user_id);

Cet événement est appelé avant la mise à jour d'un utilisateur.

Exemple de signature :

function adminBeforeUserUpdate($cur, $user_id)

Appel du behavior :

$core->callBehavior('adminBlogPreferencesForm',$core);

Permet d'ajouter des éléments au formulaire d'édition de préférences du blog.

Exemple de signature :

function adminBlogPreferencesForm(&$core)

Appel du behavior :

$core->callBehavior('adminBlogPreferencesHeaders').

Permet d'ajouter des éléments au header de la page de préférences du blog.

Exemple de signature :

function adminBlogPreferencesHeaders()

Appel du behavior :

$core->callBehavior('adminPageHTMLHead');

Permet d'ajouter des éléments au header de toute page de l'administration.

Exemple de signature :

function adminPageHTMLHead()

Appel du behavior :

$core->callBehavior('adminPostForm',isset($post) ? $post : null);

Permet d'ajouter des éléments au formulaire dans post.php (en dessous des notes)

Exemple de signature :

function adminPostForm($post)

Appel du behavior :

$core->callBehavior('adminPostFormSidebar',isset($post) ? $post : null);

Permet d'afficher des éléments dans la sidebar (colonne de droite) de la page post.php

Exemple de signature :

function adminPostFormSidebar($post)

Exemple d'utilisation :

$core->addBehavior('adminPostFormSidebar',
	array('myBehavior','adminPostFormSidebar'));
 
class myBehavior
{
	public static function adminPostFormSidebar(&$post)
	{
		# ne rien afficher si c'est un nouveau billet
		if (!isset($post->post_title)) {return;}
 
		echo
		'<div>'.'<h3>'.__('Post title').'</h3>'.
		'<p>'.
			sprintf(__('This post title is <strong>%s</strong>'),
				$post->post_title).
		'</p>'.
		'</div>';
	}
}

Appel du behavior :

$core->callBehavior('adminPostNavLinks',isset($post) ? $post : null);

Permet d'afficher des éléments dans la zone de navigation (suivant/précédent) de la page post.php

Exemple de signature :

function adminPostNavLinks($post)

Appel du behavior :

$core->callBehavior('adminPostHeaders').

Permet d'ajouter des headers à la page d'admin post.php.

Exemple de signature :

function adminPostHeaders()

Appel du behavior :

$core->callBehavior('adminCommentsHeaders').

Permet d'ajouter des headers à la page d'admin comments.php.

Exemple de signature :

function adminCommentsHeaders()

Appel du behavior :

$core->callBehavior('adminPostsActions',$core,$posts,$action,$redir);

Permet d'ajouter le traitement d'une action définie par 'adminPostsActionsCombo' sur un post.

Exemple de signature :

function adminPostsActions(&$core,$posts,$action,$redir)

Appel du behavior :

$core->callBehavior('adminPostsActionsCombo',array(&$combo_action));

Permet d'ajouter des éléments dans la combo box d'action sur les posts.

Exemple de code :

public static function adminPostsActionsCombo(&$args)
{
	$args[0][__('add tags')] = 'tags';
}

Appel du behavior :

$core->callBehavior('adminPostsActionsContent',$core,$action,$hidden_fields);

Permet d'afficher un formulaire pour l'action sur le post.

Exemple de code :

public static function adminPostsActionsContent($core,$action,$hidden_fields)
{
	if ($action == 'tags')
	{
		echo
		'<h2>'.__('Add tags to entries').'</h2>'.
		'<form action="posts_actions.php" method="post">'.
		'<p><label class="area">'.__('Tags to add:').' '.
		form::textarea('new_tags',60,3).
		'</label> '.
 
		$hidden_fields.
		form::hidden(array('action'),'tags').
		'<input type="submit" value="'.__('save').'" /></p>'.
		'</form>';
	}
}

|

Appel du behavior :

$core->callBehavior('adminPreferencesForm',$core);

Cet événement permet d'ajouter des éléments au formulaire de la page preferences.php de l'admin.

Exemple de signature :

function adminPreferencesForm(&$core);

Appel du behavior :

$core->callBehavior('adminPreferencesHeaders')

Cet événement est appelé lors de la génération des headers de la page preferences.php de l'admin. Ceci permet d'ajouter des headers à cette page.

Exemple de signature :

function adminPreferencesHeaders();

Appel du behavior :

$core->callBehavior('adminUserForm',isset($rs) ? $rs : null);

Cet événement permet d'ajouter des éléments au formulaire de la page user.php de l'admin.

Exemple de signature :

function adminUserForm(&$rs);

Appel du behavior :

$core->callBehavior('adminDashboardCommentDesc', $core,array(&$str_comments_opt));

Cet événement permet d'ajouter des informations dans la description des commentaires sur le tableau de bord. Le dernier paramètre est un tableau contenant une référence vers une chaîne. Il faut concaténer à la fin de cette chaîne.

Exemple de signature :

function dashboard($core, $param)

Appel du behavior :

$core->callBehavior('adminUserHeaders')

Cet événement est appelé lors de la génération des headers de la page user.php de l'admin. Ceci permet d'ajouter des headers à cette page.

Exemple de signature :

function adminUserHeaders();

Appel du behavior :

$core->callBehavior('adminBeforeLangInput', $id, $default, array(&$return),  $tabindex)

Ce behavior est appelé avant l'affichage d'un élément de saisie de langue. Il permet de surcharger la saisie de langue par défaut.

Exemple de signature :

function adminBeforeLangInput($nid, $default, $input, $tabindex = '');

Appel du behavior :

$this->core->callBehavior('coreBeforeCommentCreate',$blog,$cur);

Cet événement est appelé avant la création d'un commentaire.

Exemple de signature :

function coreBeforeCommentCreate(&$blog, &$cur);

Appel du behavior :

$this->core->callBehavior('coreAfterCommentCreate',$blog,$cur);

Cet événement est appelé après la création d'un commentaire.

Exemple de signature :

function coreAfterCommentCreate(&$blog, &$cur);

Appel du behavior :

$this->core->callBehavior('coreAfterCommentUpdate',$this,$cur,$rs);

Cet événement est appelé après la mise à jour d'un commentaire.

Exemple de signature :

function coreAfterCommentUpdate(&$blog, &$cur, $rs);

Appel du behavior :

$this->core->callBehavior('coreBeforeCommentUpdate',$this,$cur,$rs);

Cet événement est appelé avant la mise à jour d'un commentaire.

Exemple de signature :

function coreBeforeCommentUpdate(&$blog, &$cur, $rs);

Appel du behavior :

$this->core->callBehavior('coreBlogConstruct',$this);

Cet événement est appelé à la création de l'objet dcBlog.

Exemple de signature :

function coreBlogConstruct(&$blog);

Appel du behavior :

$this->core->callBehavior('coreBlogGetComments',$rs);

Cet événement est appelé à chaque fois que l'on appelle $blog→getComments. L'événement est lancé à la fin de la méthode et permet d'étendre les informations renvoyées par getComments.

Exemple de signature :

function coreBlogGetComments(&$rs);

Appel du behavior :

$this->core->callBehavior('coreBlogGetPosts',$rs);

Cet événement est appelé à chaque fois que l'on appelle $blog→getPosts. L'événement est lancé à la fin de la méthode et permet d'étendre les informations renvoyées par getPosts.

Exemple de signature :

function coreBlogGetPosts(&$rs);

Appel du behavior :

$this->core->callBehavior('coreFirstPublicationEntries',$this,$to_change));

Cet événement est appelé lorsqu'un billet passe en status publié pour la première fois, et uniquement la première fois. Il permet de lancer des actions lors de la première publication d'un billet ou groupe de billets.

Exemple de signature :

function coreFirstPublicationEntries($blog,$posts_ids);

Appel du behavior :

$this->callBehavior('coreInitWikiComment',$this->wiki2xhtml);

Cet événement est appelé lors de l'initialisation de wiki2xhtml pour un commentaire.

Exemple de signature :

function coreInitWikiComment(&$wiki2xhtml);

Appel du behavior :

$this->callBehavior('coreInitWikiSimpleComment',$this->wiki2xhtml);

Cet événement est appelé lors de l'initialisation de wiki2xhtml pour un commentaire simple (syntaxe basique).

Exemple de signature :

function coreInitWikiSimpleComment(&$wiki2xhtml);

Appel du behavior:

$this->core->callBehavior('corePostSearch',$this->core,array(&$words,&$strReq,&$params))

Cet événement est appelé lorsque des paramètres de recherche de billet sont passés à dcBlog::getPosts().

Exemple de signature :

function corePostSearch(&$core,$p)

Appel du behavior :

$this->callBehavior('coreInitWikiPost',$this->wiki2xhtml);

Cet événement est appelé lors de l'initialisation de wiki2xhtml pour un post.

Exemple de signature :

function coreInitWikiPost(&$wiki2xhtml);

Appel du behavior :

		$content = array('excerpt' => &$excerpt, 'content' => &$content, 'excerpt_xhtml' => &$excerpt_xhtml, 'content_xhtml' => &$content_xhtml);
		$core->callBehavior('coreAfterPostContentFormat', $content);

Cet événement est appelé sur le contenu d'un post, après le passage du formateur et du filtre xhtml. Le tableau associatif en paramètre possède des références vers les différents éléments constitutifs du post.

Exemple de signature :

function reformat($content);

Appel du behavior :

$core->callBehavior('exportFull',$core,$exp);

Cet événement est appelé lors de l'un export complet.

Exemple de signature :

function exportSingle(&$core,$exp);

Appel du behavior :

$core->callBehavior('exportSingle',$core,$exp,$blog_id);

Cet événement est appelé lors de l'un export simple (par opposition à un export complet).

Exemple de signature :

function exportSingle(&$core,$exp, $blog_id);

Appel du behavior :

$this->core->callBehavior('importFull',$line,$this,$this->core);

Cet événement est appelé lors de l'un import complet sur chaque ligne de l'import.

Exemple de signature :

function importFull($line,$import,$core);

Appel du behavior :

$this->core->callBehavior('importInit',$this,$this->core);

Cet événement est appelé lors de l'initialisation d'un import.

Exemple de signature :

function importInit($import,$core);

Appel du behavior :

$this->core->callBehavior('importPrepareDC12',$line,$this,$this->core);

Cet événement est appelé lors de l'import d'une archive de blog DC12 sur chaque ligne de l'import.

Exemple de signature :

function importPrepareDC12($line,$import,$core);

Appel du behavior :

$this->core->callBehavior('importSingle',$line,$this,$this->core);

Cet événement est appelé lors de l'import d'une archive de blog simple (par opposition à une archive complète) sur chaque ligne de l'import.

Exemple de signature :

function importSingle($line,$import,$core);

Appel du behavior :

$core->callBehavior('initDefaultWidgets',$__widgets,$__default_widgets);

Cet événement est appelé lors de l'initialisation des widgets par défaut

Exemple de signature :

function initWidgets(&$widgets, &$default_widgets);

Appel du behavior :

$core->callBehavior('initWidgets',$__widgets);

Cet événement est appelé lors de l'initialisation des widgets

Exemple de signature :

function initWidgets(&$__widgets);

Appel du behavior :

$core->callBehavior('loginPageHTMLHead');

Cet événement est appelé lors de la génération du html de la page de login

Exemple de signature :

function loginPageHTMLHead();

Appel du behavior :

$core->callBehavior('pluginsAfterDelete', $plugin);

Cet événement est appelé après la suppression d'un plugin.

Exemple de signature :

function pluginsAfterDelete($plugin);

Appel du behavior :

$core->callBehavior('pluginsBeforeDelete', $plugin);

Cet événement est appelé avant la suppression d'un plugin.

Exemple de signature :

function pluginsBeforeDelete($plugin);

Appel du behavior :

$core->callBehavior('pluginsToolsTabs',$core);

Cet événement est appelé lors de l'affichage de

Exemple de signature :

function pluginsToolsTabs(&$core);

Appel du behavior :

$core->callBehavior('publicHeadContent',$core,$_ctx);

Cet événement est appelé à la fin de l'en-tête HTML des pages publiques.

Cet événement se trouve dans un template, la signature sera par exemple :

{{tpl:SysBehavior behavior="publicHeadContent"}}

Appel du behavior :

$core->callBehavior('publicAfterCommentCreate',$cur,$comment_id);

Cet événement est appelé après la création d'un commentaire.

Exemple de signature :

function publicAfterCommentCreate(&$cur, $comment_id);

Appel du behavior :

$core->callBehavior('publicAfterDocument',$core);

Cet événement est appelé après la génération de la page.

Exemple de signature :

function publicAfterDocument(&$core);

Appel du behavior :

$this->core->callBehavior('publicAfterTrackbackCreate',$cur,$comment_id);

Cet événement est appelé après la création d'un trackback.

Exemple de signature :

function publicAfterTrackbackCreate(&$cur, $comment_id);

Appel du behavior :

$core->callBehavior('publicBeforeCommentCreate',$cur);

Cet événement est appelé avant la création d'un commentaire.

Exemple de signature :

function publicBeforeCommentCreate(&$cur);

Appel du behavior :

$core->callBehavior('publicBeforeDocument',$core);

Cet événement est appelé avant la génération de la page.

Exemple de signature :

function publicBeforeDocument(&$core);

Appel du behavior :

$this->core->callBehavior('publicBeforeTrackbackCreate',$cur);

Cet événement est appelé avant la création d'un trackback.

Exemple de signature :

function publicBeforeTrackbackCreate(&$cur);

Appel du behavior :

$core->callBehavior('publicPrepend',$core);

Cet événement est appelé lors de l'exécution du prepend public. expliquer le principe du prepend

Exemple de signature :

function publicPrepend(&$core);

Appel du behavior :

$core->callBehavior('publicBeforeLangDisplay',$code,array(&$disp_lang));

Cet événement est appelé avant l'affichage d'une langue côté public. Il permet de surcharger l'affichage des langues.

Exemple de signature :

function publicBeforeLangDisplay($code, $disp_lang)

Appel du behavior :

$res = $this->core->callBehavior('templateBeforeBlock',$this->core,$b,$attr);

Cet événement est lancé avant tout block dans le système de template.

Exemple de signature :

function templateBeforeBlock(&$core,$b,$attr);

Appel du behavior :

$res = $this->core->callBehavior('templateBeforeValue',$this->core,$v,$attr);

Cet événement est lancé avant toute valeur dans le système de template. ??

Exemple de signature :

function templateBeforeValue(&$core,$v,$attr);

Appel du behavior :

$res = $this->core->callBehavior('tplBeforeData',$this->core);

Cet événement est lancé avant toute donnée dans le système de template. ?? Il peut être utilisé conjointement à tplAfterData pour réaliser facilement un système de cache.

Exemple de signature :

function tplBeforeData(&$core);

Appel du behavior :

$res = $this->core->callBehavior('tplAfterData',$this->core,$r);

Cet événement est lancé après toute donnée dans le système de template. ??

Exemple de signature :

function tplAfterData(&$core, $r);

Appel du behavior :

$core->callBehavior('themeAfterDelete',$theme);

Cet événement est appelé après la suppression d'un thème.

Exemple de signature

function themeAfterDelete($theme);

Appel du behavior :

$core->callBehavior('themeBeforeDelete',$theme);

Cet événement est appelé avant la suppression d'un thème.

Exemple de signature

function themeBeforeDelete($theme);

Appel du behavior :

$this->core->callBehavior('xmlrpcAfterEditPost',$this,$post_id,$cur,$content,$struct,$publish);

Cet événement est lancé après toute édition de post par xmlrpc.

Exemple de signature :

function xmlrpcAfterEditPost($x,$post_id,&$cur,$content,$struct,$publish);

Appel du behavior :

$this->core->callBehavior('xmlrpcAfterNewPost',$this,$post_id,$cur,$content,$struct,$publish);

Cet événement est lancé après toute création de post par xmlrpc.

Exemple de signature :

function xmlrpcAfterNewPost($x,$post_id,&$cur,$content,$struct,$publish);

Appel du behavior :

$this->core->callBehavior('xmlrpcAfterPublishPost',$this,$post_id);

Cet événement est lancé après toute publication de post par xmlrpc.

Exemple de signature :

function xmlrpcAfterPublishPost(&$x,$post_id);

Appel du behavior :

$this->core->callBehavior('xmlrpcBeforeEditPost',$this,$post_id,$cur,$content,$struct,$publish);

Cet événement est lancé avant toute édition de post par xmlrpc.

Exemple de signature :

function xmlrpcBeforeEditPost($x,$post_id,&$cur,$content,$struct,$publish);

Appel du behavior :

$this->core->callBehavior('xmlrpcBeforeNewPost',$this,$cur,$content,$struct,$publish);

Cet événement est lancé avant toute création de post par xmlrpc.

Exemple de signature :

function xmlrpcBeforeNewPost($x,&$cur,$content,$struct,$publish);

Appel du behavior :

$this->core->callBehavior('xmlrpcBeforePublishPost',$this,$post_id);

Cet événement est lancé avant toute publication de post par xmlrpc.

Exemple de signature :

function xmlrpcBeforePublishPost(&$x,$post_id);

Appel du behavior :

$this->core->callBehavior('xmlrpcGetPostInfo',$this,$type,array(&$res));

Ajout de métadonnées dans la structure décrivant un post. Ces métadonnées sont ajoutées dans le paramètre res. Cet événement est appelé à chaque fois qu'un client demande des informations sur un post.

Exemple de signature :

function xmlrpcGetPostInfo(&$x,$type,&$res);

Liste obtenue par recherche automatique dans les sources. Les comportements listés ici sont documenté ci-dessus mais ne sont plus/pas présent dans les sources de dotclear 2.6.

Liste obtenue par recherche automatique dans les sources. Les comportements listés ici sont présents dans les sources de dotclear 2.6 mais pas dans la documentation ci-dessus.