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.

Principe

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.

Behavior Admin

adminAfterBlogCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le blog
blog_id integer identifiant du blog
settings dcSettings référence à l'objet settings du blog

Exemple de signature

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

adminAfterBlogUpdate

Appel du behavior :

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

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

Attention :

En cas de mise-à-jour de l'identifiant du blog, $blog_id contient l'ancien identifiant. Le nouvel identifiant est disponible dans $cur→blog_id.
Paramètre Type Description
cur cursor curseur sur le blog
blog_id integer identifiant du blog

Exemple de signature :

function adminAfterBlogUpdate($cur, $blog_id)

adminAfterCategoryCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur la catégorie
cat_id integer identifiant de la catégorie

Exemple de signature :

function adminAfterCategoryCreate($cur, $cat_id)

adminAfterCategoryUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur la catégorie
cat_id integer identifiant de la catégorie

Exemple de signature :

function adminAfterCategoryUpdate($cur, $cat_id)

adminAfterCommentDesc

Appel du behavior :

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

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

Paramètre Type Description
rs record record sur le commentaire

Exemple de signature :

function adminAfterCommentDesc($rs)

adminAfterCommentCreate

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.

Paramètre Type Description
cur cursor curseur sur le commentaire
comment_id integer ID du commentaire

Exemple de signature :

function adminAfterCommentCreate($cur,$comment_id)

adminAfterCommentUpdate

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.

Paramètre Type Description
cur cursor curseur sur le commentaire
comment_id integer ID du commentaire

Exemple de signature :

function adminAfterCommentUpdate($cur,$comment_id)

adminAfterPostCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le post
return_id integer identifiant du post

Exemple de signature :

function adminAfterPostCreate($cur, $return_id)

adminAfterPostUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le post
post_id integer identifiant du post

Exemple de signature :

function adminAfterPostUpdate($cur, $post_id)

adminAfterUserCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur l'utilisateur
new_id integer identifiant de l'utilisateur

Exemple de signature :

function adminAfterUserCreate($cur, $new_id)

adminAfterUserUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur l'utilisateur
new_id integer identifiant de l'utilisateur

Exemple de signature :

function adminAfterUserUpdate($cur, $new_id)

adminBeforeBlogSettingsUpdate

Appel du behavior :

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

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

Paramètre Type Description
blog_settings dcSettings objet contenant les settings du blog

Exemple de signature :

function adminBeforeBlogSettingsUpdate($blog_settings)

adminBeforeBlogCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le blog
blog_id integer identifiant du blog

Exemple de signature

function adminBeforeBlogCreate($cur,$blog_id)

adminBeforeBlogUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le blog
blog_id integer identifiant du blog

Exemple de signature :

function adminBeforeBlogUpdate($cur, $blog_id)

adminBeforeCategoryCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur la catégorie

Exemple de signature :

function adminBeforeCategoryCreate($cur)

adminBeforeCategoryUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur la catégorie
cat_id integer identifiant de la catégorie

Exemple de signature :

function adminBeforeCategoryUpdate($cur, $cat_id)

adminBeforeCommentCreate

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.

Paramètre Type Description
cur cursor curseur sur le commentaire

Exemple de signature :

function adminBeforeCommentCreate($cur)

adminBeforeCommentUpdate

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.

Paramètre Type Description
cur cursor curseur sur le commentaire
comment_id integer ID du commentaire

Exemple de signature :

function adminBeforeCommentUpdate($cur,$comment_id)

adminBeforePostCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le post

Exemple de signature :

function adminBeforePostCreate($cur)

adminBeforePostUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur le post
post_id integer identifiant du post

Exemple de signature :

function adminBeforePostUpdate($cur, $post_id)

adminBeforePostDelete

Appel du behavior :

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

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

Paramètre Type Description
post_id integer identifiant du post

Exemple de signature :

function adminBeforePostDelete($post_id)

adminBeforeUserCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur l'utilisateur

Exemple de signature :

function adminBeforeUserCreate($cur)

adminBeforeUserDelete

Appel du behavior :

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

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

Paramètre Type Description
u integer identifiant de l'utilisateur

Exemple de signature :

function adminBeforeUserDelete($user_id)

adminBeforeUserUpdate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor curseur sur l'utilisateur
user_id integer identifiant de l'utilisateur

Exemple de signature :

function adminBeforeUserUpdate($cur, $user_id)

adminBlogPreferencesForm

Appel du behavior :

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

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

Paramètre Type Description
core dcCore référence vers l'objet core

Exemple de signature :

function adminBlogPreferencesForm(&$core)

adminBlogPreferencesHeaders

Appel du behavior :

$core->callBehavior('adminBlogPreferencesHeaders').

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

Paramètre Type Description

Exemple de signature :

function adminBlogPreferencesHeaders()

adminPageHTMLHead

Appel du behavior :

$core->callBehavior('adminPageHTMLHead');

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

Paramètre Type Description

Exemple de signature :

function adminPageHTMLHead()

adminPostForm

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)

Paramètre Type Description
post record record représentant le post

Exemple de signature :

function adminPostForm($post)

adminPostFormSidebar

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

Paramètre Type Description
post record record représentant le post

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

Paramètre Type Description
post record record représentant le post

Exemple de signature :

function adminPostNavLinks($post)

adminPostHeaders

Appel du behavior :

$core->callBehavior('adminPostHeaders').

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

Paramètre Type Description

Exemple de signature :

function adminPostHeaders()

adminCommentsHeaders

Appel du behavior :

$core->callBehavior('adminCommentsHeaders').

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

Paramètre Type Description

Exemple de signature :

function adminCommentsHeaders()

adminPostsActions

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.

Paramètre Type Description
core dcCore référence vers l'objet core
posts record record décrivant le post
action string identifiant de l'action
redir string adresse de redirection après le traitement

Exemple de signature :

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

adminPostsActionsCombo

Appel du behavior :

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

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

Paramètre Type Description
combo_action array le premier élément de ce tableau contient un tableau associatif des items (label ⇒ id)

Exemple de code :

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

adminPostsActionsContent

Appel du behavior :

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

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

Paramètre Type Description
core dcCore référence vers l'objet core
action string identifiant de l'action
hidden_fields string

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>';
	}
}

|

adminPreferencesForm

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.

Paramètre Type Description
core dcCore référence vers l'objet core

Exemple de signature :

function adminPreferencesForm(&$core);

adminPreferencesHeaders

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.

Paramètre Type Description

Exemple de signature :

function adminPreferencesHeaders();

adminUserForm

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.

Paramètre Type Description
rs record référence vers l'utilisateur courant

Exemple de signature :

function adminUserForm(&$rs);

adminDashboardCommentDesc

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.

Paramètre Type Description
core core référence à l'objet core
param array tableau contenant une référence vers une chaîne à compléter

Exemple de signature :

function dashboard($core, $param)

adminUserHeaders

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.

Paramètre Type Description

Exemple de signature :

function adminUserHeaders();

adminBeforeLangInput

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.

Paramètre Type Description
id string id de l'input à générer
default string élément par défaut
return string référence vers la valeur de retour
tabindex integer tabindex

Exemple de signature :

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

Behavior Core

coreBeforeCommentCreate

Appel du behavior :

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

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

Paramètre Type Description
blog dcBlog référence à l'objet blog
cur cursor curseur sur le commentaire

Exemple de signature :

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

coreAfterCommentCreate

Appel du behavior :

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

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

Paramètre Type Description
blog dcBlog référence à l'objet blog
cur cursor curseur sur le commentaire

Exemple de signature :

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

coreAfterCommentUpdate

Appel du behavior :

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

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

Paramètre Type Description
blog dcBlog référence à l'objet blog
cur cursor curseur sur le commentaire
rs record record sur le commentaire

Exemple de signature :

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

coreBeforeCommentUpdate

Appel du behavior :

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

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

Paramètre Type Description
blog dcBlog référence à l'objet blog
cur cursor curseur sur le commentaire
rs record record sur le commentaire

Exemple de signature :

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

coreBlogConstruct

Appel du behavior :

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

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

Paramètre Type Description
blog dcBlog référence à l'objet blog

Exemple de signature :

function coreBlogConstruct(&$blog);

coreBlogGetComments

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.

Paramètre Type Description
rs recordSet Référence à un objet recordSet

Exemple de signature :

function coreBlogGetComments(&$rs);

coreBlogGetPosts

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.

Paramètre Type Description
rs recordSet Référence à un objet recordSet

Exemple de signature :

function coreBlogGetPosts(&$rs);

coreInitWikiComment

Appel du behavior :

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

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

Paramètre Type Description
wiki2xhtml wiki2xhtml Référence à l'objet wiki2xhtml

Exemple de signature :

function coreInitWikiComment(&$wiki2xhtml);

coreInitWikiSimpleComment

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).

Paramètre Type Description
wiki2xhtml wiki2xhtml Référence à l'objet wiki2xhtml

Exemple de signature :

function coreInitWikiSimpleComment(&$wiki2xhtml);

corePostSearch

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().

Paramètre Type Description
core dcCore Référence à l'instance $core
p array Tableau contenant des références aux variables $words, $strReq et $params de la méthode dcBlog::getPosts(). $words doit être vidé à la fin de cette fonction.

Exemple de signature :

function corePostSearch(&$core,$p)

coreWikiPostInit

Appel du behavior :

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

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

Paramètre Type Description
wiki2xhtml wiki2xhtml Référence à l'objet wiki2xhtml

Exemple de signature :

function coreInitWikiPost(&$wiki2xhtml);

coreAfterPostContentFormat

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.

Paramètre Type Description
$content array Tableau associatif

Exemple de signature :

function reformat($content);

Behavior Plugin Import/Export

exportFull

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Référence à l'objet core
exp dbExport Référence à l'objet dbExport

Exemple de signature :

function exportSingle(&$core,$exp);

exportSingle

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).

Paramètre Type Description
core dcCore Référence à l'objet core
exp dbExport Référence à l'objet dbExport
blog_id string identifiant du blog

Exemple de signature :

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

importFull

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.

Paramètre Type Description
line backupFileItem objet représentant une ligne de fichier de backup
import dcImport Référence à l'objet dcImport
core dcCore Référence à l'objet core

Exemple de signature :

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

importInit

Appel du behavior :

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

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

Paramètre Type Description
import dcImport Référence à l'objet dcImport
core dcCore Référence à l'objet core

Exemple de signature :

function importInit($import,$core);

importPrepareDC12

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.

Paramètre Type Description
line backupFileItem objet représentant une ligne de fichier de backup
import dcImport Référence à l'objet dcImport
core dcCore Référence à l'objet core

Exemple de signature :

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

importSingle

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.

Paramètre Type Description
line backupFileItem objet représentant une ligne de fichier de backup
import dcImport Référence à l'objet dcImport
core dcCore Référence à l'objet core

Exemple de signature :

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

Behavior Plugin Widgets

initDefaultWidgets

Appel du behavior :

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

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

Paramètre Type Description
widgets dcWidgets objet gérant les widgets du blog
default_widgets array tableau contenant les informations relatives aux widgets par défaut

Exemple de signature :

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

initWidgets

Appel du behavior :

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

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

Paramètre Type Description
widgets dcWidgets objet gérant les widgets du blog

Exemple de signature :

function initWidgets(&$__widgets);

Behavior Page Login

loginPageHTMLHead

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();

Behavior Plugins

pluginAfterDelete

Appel du behavior :

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

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

Paramètre Type Description
plugin array Tableau associatif représentant le plugin

Exemple de signature :

function pluginsAfterDelete($plugin);

pluginBeforeDelete

Appel du behavior :

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

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

Paramètre Type Description
plugin array Tableau associatif représentant le plugin

Exemple de signature :

function pluginsBeforeDelete($plugin);

pluginsToolsTabs

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Référence à l'objet core

Exemple de signature :

function pluginsToolsTabs(&$core);

Behavior Public

publicHeadContent

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Object core
_ctx context Pile de contexte

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

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

publicAfterCommentCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor Curseur sur le commentaire
comment_id integer Identifiant du commentaire

Exemple de signature :

function publicAfterCommentCreate(&$cur, $comment_id);

publicAfterDocument

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Référence à l'objet core

Exemple de signature :

function publicAfterDocument(&$core);

publicAfterTrackbackCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor Curseur sur le commentaire
comment_id integer Identifiant du commentaire

Exemple de signature :

function publicAfterTrackbackCreate(&$cur, $comment_id);

publicBeforeCommentCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor Curseur sur le commentaire

Exemple de signature :

function publicBeforeCommentCreate(&$cur);

publicBeforeDocument

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Référence à l'objet core

Exemple de signature :

function publicBeforeDocument(&$core);

publicBeforeTrackbackCreate

Appel du behavior :

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

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

Paramètre Type Description
cur cursor Curseur sur le commentaire

Exemple de signature :

function publicBeforeTrackbackCreate(&$cur);

publicPrepend

Appel du behavior :

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

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

Paramètre Type Description
core dcCore Référence à l'objet core

Exemple de signature :

function publicPrepend(&$core);

publicBeforeLangDisplay

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.

Paramètre Type Description
code string code de langue ISO 639-1
disp_lang string référence vers la chaîne à afficher

Exemple de signature :

function publicBeforeLangDisplay($code, $disp_lang)

Behavior Templates

templateBeforeBlock

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.

Paramètre Type Description
core dcCore Référence à l'objet core
b string Identifiant du bloc
attr array Tableau associatif des attributs

Exemple de signature :

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

templateBeforeValue

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. FIXME ??

Paramètre Type Description
core dcCore Référence à l'objet core
v string Valeur
attr array Tableau associatif des attributs

Exemple de signature :

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

tplBeforeData

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. FIXME ?? Il peut être utilisé conjointement à tplAfterData pour réaliser facilement un système de cache.

Paramètre Type Description
core dcCore Référence à l'objet core

Exemple de signature :

function tplBeforeData(&$core);

tplAfterData

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. FIXME ??

Paramètre Type Description
core dcCore Référence à l'objet core
r string Donnée de retour du système de template

Exemple de signature :

function tplAfterData(&$core, $r);

Behavior Theme

themeAfterDelete

Appel du behavior :

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

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

Paramètre Type Description
theme array Tableau associatif contenant les informations du thème

Exemple de signature

function themeAfterDelete($theme);

themeBeforeDelete

Appel du behavior :

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

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

Paramètre Type Description
theme array Tableau associatif contenant les informations du thème

Exemple de signature

function themeBeforeDelete($theme);

Behavior XML-RPC

xmlrpcAfterEditPost

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.

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
post_id integer Identifiant du post
cur cursor Curseur sur le post
content string Contenu du post
struct array Tableau associatif contenant les métadonnées du post
publish boolean Post publié?

Exemple de signature :

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

xmlrpcAfterNewPost

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.

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
post_id integer Identifiant du post
cur cursor Curseur sur le post
content string Contenu du post
struct array Tableau associatif contenant les métadonnées du post
publish boolean Post publié?

Exemple de signature :

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

xmlrpcAfterPublishPost

Appel du behavior :

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

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

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
post_id integer Identifiant du post

Exemple de signature :

function xmlrpcAfterPublishPost(&$x,$post_id);

xmlrpcBeforeEditPost

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.

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
post_id integer Identifiant du post
cur cursor Curseur sur le post
content string Contenu du post
struct array Tableau associatif contenant les métadonnées du post
publish boolean Post publié?

Exemple de signature :

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

xmlrpcBeforeNewPost

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.

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
cur cursor Curseur sur le post
content string Contenu du post
struct array Tableau associatif contenant les métadonnées du post
publish boolean Post publié?

Exemple de signature :

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

xmlrpcBeforePublishPost

Appel du behavior :

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

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

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
post_id integer Identifiant du post

Exemple de signature :

function xmlrpcBeforePublishPost(&$x,$post_id);

xmlrpcGetPostInfo

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.

Paramètre Type Description
x dcXmlRpc Référence vers la classe xmlrpc
type string Type d'api ('blogger', 'mt' ou 'mw')
res array Contient la référence à un tableau associatif contenant les infos d'un post

Exemple de signature :

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

Wiki powered by Dokuwiki.