Documentation Dotclear 2.0:resources:plugins

2.0:resources:plugins:actions

Mon, 28 Oct 2013 10:51:20 +0200

	Version actuelle
Ligne 1:	Ligne 1:
	+	===== Rappel Gestion des actions dans l'administration sous dotclear 2.6 ======

	+	Cette page décrit la migration du système d'ajout d'actions sur les listes de billets et/ou de commentaires via des plugins, depuis dotclear 2.5.X vers dotclear 2.6.
	+
	+	A noter : dotclear 2.6 supporte toujours l'ancienne méthode, il est toutefois recommandé de passer à la nouvelle approche.
	+	<note>
	+	La présente page décrit la méthode pour la gestion des actions sur les billets, mais elle est aussi applicable pour les commentaires. Nous nous appuierons sur un plugin d'example, dont l'objectif est de permettre d'autoriser ou pas les commentaires et les rétroliens sur une liste de billets.
	+	</note>
	+	==== Rappel : fonctionnement sous dotclear < 2.6 ====
	+
	+	Sous dotclear 2.5.x, il faut passer par 3 behaviors distincts :
	+	* adminPostsActionsCombo permet d'ajouter une entrée à la liste des actions
	+	* adminPostsActions permet de gérer le traitement des actions une fois soumises
	+	* adminPostsActionsContent permet d'afficher une page intermédiaire, en cas de besoin (dans notre plugin d'exemple, le formulaire de choix sur l'activation ou non des commentaires)
	+	* optionnellenemt, adminPostsActionsHeader permet d'enrichir le <header> de la page http, s'il faut inclure des styles ou des scripts particuliers dans la page intermédiaire
	+
	+	=== Structure globale du plugin ===
	+
	+	Le plugin, que nous appellerons OpenCloseComTB, se compose :
	+	* d'un fichier _define.php décrivant le plugin
	+	* d'un fichier _admin.php.
	+
	+	La structure du fichier _admin.php est la suivante :
	+	<code php>
	+	<?php
	+	$core->addBehavior('adminPostsActionsCombo',array('AdminOpenCloseComTB','adminPostsActionsCombo'));
	+	$core->addBehavior('adminPostsActionsContent',array('AdminOpenCloseComTB','adminPostsActionsContent'));
	+	$core->addBehavior('adminPostsActions',array('AdminOpenCloseComTB','adminPostsActions'));
	+
	+
	+	class AdminOpenCloseComTB
	+	{
	+	public static function adminPostsActionsCombo($args) {
	+	[...]
	+	}
	+
	+	public static function adminPostsActions($core,$posts,$action,$redir) {
	+	[...]
	+	}
	+
	+	public static function adminPostsActionsContent($core,$action,$hidden_fields) {
	+	[...]
	+	}
	+	}
	+	?>
	+	</code>
	+
	+	== adminPostsActionsCombo en détails ==
	+	adminPostsActionsCombo prend en paramètre la liste des combos, que nous allons enrichir, dans la section "modifier" :
	+	<code php>
	+	public static function adminPostsActionsCombo($args) {
	+	$args[0][__('Change')] = array(__('Open/Close Comments or trackbacks') => 'openclosecomtb');
	+	}
	+	</code>
	+	La soumission de l'action "Open/Close Comments or trackback" enverra donc l'action 'openclosecomtb'.
	+
	+	== adminPostsActionsContent en détails ==
	+	adminPostsActionsContent prend 3 arguments :
	+	* $core : l'instance dcCode
	+	* $action : l'action actuellement soumise
	+	* $hidden_fields : les champs cachés à insérer dans le formulaire
	+
	+	Ce qui donne :
	+
	+
	+	<code php>
	+	public static function adminPostsActionsContent($core,$action,$hidden_fields)
	+	{
	+	// On s'assure que l'action en cours nous concerne bien
	+	if ($action == 'openclosecomtb')
	+	{
	+	echo
	+	'<h2>'.__('Open/close comments or trackbacos').'</h2>'.
	+
	+	'<form action="posts_actions.php" method="post">'.
	+
	+	'<p>'.
	+	form::checkbox('open_comm','1','').
	+	' <label class="classic" for="open_comm">'.__('Allow Comments').'</label></p>'.
	+	'<p>'.
	+	form::checkbox('open_tb','1','').
	+	' <label class="classic" for="open_comm">'.__('Allow Trackbacks').'</label></p>'.
	+
	+	// On n'oublie pas les champs cachés, le nonce et l'action
	+	$hidden_fields.
	+	$core->formNonce().
	+	form::hidden(array('action'),'openclosecomtb').
	+	// le champ changestatus nous permet de tester si le formulaire a bien été soumis
	+	form::hidden(array('changestatus'),'true').
	+	'<p><input type="submit" value="'.__('Ok').'" /></p>'.
	+	'</form>';
	+	}
	+	}
	+	</code>
	+
	+	== adminPostsActions en détails ==
	+	adminPostsActions prend 4 arguments :
	+	* $core : l'instance dcCode
	+	* $posts : le record contenant les billets sélectionnés
	+	* $action : l'action actuellement soumise
	+	* $redir : l'url de redirection une fois l'action exécutée
	+
	+	On s'assure ici que le formulaire a bien été soumis en testant la présence du champ "changestatus" défini plus haut. Pour d'autre cas, il est possible de tester d'autre champs, mais ici nous n'avons que des checkbox, et une checkbox non cochée n'est pas définie dans $_POST.
	+
	+	Ce qui donne :
	+
	+	<code php>
	+	public static function adminPostsActions($core,$posts,$action,$redir)
	+	{
	+	if ($action == 'openclosecomtb' && !empty($_POST['changestatus'])
	+	&& $core->auth->check('contentadmin',$core->blog->id))
	+	{
	+	try
	+	{
	+	$set_co = isset($_POST['open_comm']);
	+	$set_tb = isset($_POST['open_tb']);
	+	while ($posts->fetch())
	+	{
	+	$cur = $core->con->openCursor($core->prefix.'post');
	+	$cur->post_open_tb = $set_tb?1:0;
	+	$cur->post_open_comment = $set_co?1:0;
	+	$cur->update('WHERE post_id = '.(integer) $posts->post_id);
	+	}
	+	http::redirect($redir);
	+	}
	+	catch (Exception $e)
	+	{
	+	$core->error->add($e->getMessage());
	+	}
	+	}
	+	}
	+	</code>
	+
	+	==== Fonctionnement sous dotclear 2.6 ====
	+
	+	Sous dotclear 2.6, un seul et unique behavior est nécessaire pour tout gérer : adminPostsActionsPage. Ce dernier véhicule un objet de contexte qui sera manipulé par les actions définies, une instance de dcPostsActionsPage.
	+
	+	== dcPostsActionsPage ==
	+	Cet objet définit le contexte de la page en cours. il expose les méthodes suivantes (seules les méthodes utiles aux plugins qui ajoutent des actions sont décrites ici):
	+
	+	<code php>
	+	public function addAction ($actions,$callback) {}
	+	</code>
	+	Ajoute une ou plusieurs actions, associées à un callback (voir plus loin). Le callback sera appelé si et seulement si une des actions définies en entrée a été sélectionnée. Pour la syntaxe de l'action, c'est la même que pour l'action de adminPostsActionsCombo.
	+
	+	Paramètres :
	+	* $action : action(s) à ajouter.
	+	* $callback : callback à appeler.
	+
	+	Exemples :
	+	<code php>
	+	# action simple sans catégorie:
	+	$ap->addAction(
	+	array(__('Myaction') => 'myaction'),
	+	array('myclass','mycallback')
	+	);
	+	# plusieurs actions, dans le groupe "Toggle"
	+	$ap->addAction(
	+	array(__('Toggle') => array(
	+	__('enable') => 'myactionenable',
	+	__('disable') => 'myactiondisable')),
	+	array('myclass','mycallback')
	+	);
	+	</code>
	+
	+	<code php>
	+	public function getIDs() {}
	+	</code>
	+	Retourne la liste des identifiants des entrées sélectionnées (déjà filtrés au niveau sécurité)
	+
	+	<code php>
	+	public function getHiddenFields($with_ids = false) {}
	+	</code>
	+	Retourne les champs cachés à ajouter au formulaire, s'il faut en afficher un dans le plugin. Equivalent à $hidden_fields de l'ancien behavior adminPostsActionsContent. Si $with_ids est à true, les ids des billets cochés sont aussi inclus comme champs cachés.
	+
	+	<code php>
	+	public function getRS() {}
	+	</code>
	+	Retourne le record correspondant à la requête SQL de sélection des billets cochés. Equivalent à $posts de l'ancien behavior adminPostsActionsContent.
	+
	+
	+	<code php>
	+	public function redirect($with_selected_entries=false,$params=array()) {}
	+	</code>
	+	Redirige vers la page appelante. Il est possible :
	+	* D'ajouter de nouveaux paramètres GET (ex : array('upd'=>1) pour avoir la notification de mise à jour)
	+	* d'ajouter les billets sélectionnés au GET, cela permet de garder les billets cochés sur la page de retour. Attention, en cas de suppression de billets, ils ne pourront plus être cochés par la suite :)
	+
	+	<code php>
	+	public function getURI() {}
	+	</code>
	+	Retourne l'uri du formulaire à utiliser, s'il faut afficher un formulaire intermédiaire.
	+
	+	<code php>
	+	public function getAction() {}
	+	</code>
	+	Retourne l'action qui a été sélectionnée (utile si plusieurs actions mènent au callback)
	+
	+	<code php>
	+	public function getCheckboxes() {}
	+	</code>
	+	Retourne un tableau contenant les billets de la sélection, qui sont à nouveau sélectionnables pour une seconde vérification
	+	<note tip>
	+	Si vous créez un formulaire intermédiaire, vous serez amené à utiliser getHiddenFields aussi. 2 possiblités :
	+	* Vous voulez laisser la possibilité de désélectionner des billets, insérez getChecckboxes() et getHiddelFields() dans votre formulaire,
	+	* Vous ne voulez pas afficher la liste des billets, insérez alors getHiddenFields(true) dans votre formulaire.
	+	</note>
	+	<code php>
	+	public function beginPage($breadcrumb='',$head='');
	+	</code>
	+	Affiche le début d'une page. A appeler en tout premier si vous voulez afficher un formulaire intermédiaire. $breadcrumb indique le titre de la page, $head permet d'ajouter des js ou des css à la page affichée
	+	<code php>
	+	public function endPage();
	+	</code>
	+	Le pendant de beginPage, à appeler en tout dernier si vous voulez afficher un formulaire intermédiaire
	+
	+	== Les callbacks ==
	+	Un callback doit avoir la forme suivante :
	+	<code php>
	+	public static function doCallback($core, dcPostsActionsPage $ap, $post) {}
	+	</code>
	+	* $core est l'instance de dcCore actuelle
	+	* $ap est l'instance actionspage à exploiter
	+	* $post est une copie de $_POST, à préférer à ce dernier car il peut avoir évolué
	+	<note warning>
	+	Attention ! $post n'a rien à voir avec le paramètre $posts de l'ancien behavior adminPostsActions
	+	</note>
	+
	+	== Guide du nouvel arrivant ==
	+	Le traitement a une philosophie différente de l'ancien traitement :
	+	* on ne reçoit pas le record comme argument, il faut appeler $ap->getIDs ou $ap->getRS()
	+	* pas besoin de récupérer les exceptions, elles sont interceptées au dessus pour afficher une page d'erreur. Il est aussi recommandé de lever des exceptions (par exemple si aucun billet n'a été sélectionné)
	+	* Le callback est appelé uniquement si l'action a été sélectionnée, cela fait des tests inutiles de moins. Si plusieurs actions sont associées au callback, $ap->getAction() retourne celle qui a été sélectionnée
	+	* Tout l'affichage du formulaire intermédiaire (s'il en faut un) est à la charge du callback. Ne pas oublier d'appeler $ap->beginPage() et $ap->endPage()
	+
	+
	+
	+	== Retour à l'exemple ==
	+
	+	Revenons à nos moutons. Notre _admin.php va ressembler à cela :
	+	<code php>
	+
	+	<?php
	+	$core->addBehavior('adminPostsActionsPage',array('AdminOpenCloseComTB','adminPostsActionsPage'));
	+
	+	class AdminOpenCloseComTB
	+	{
	+	public static function adminPostsActionsPage($core,$ap)
	+	{
	+	// Ajout de l'action à $ap
	+	[...]
	+	}
	+
	+	public static function doOpenCloseComTB($core, dcPostsActionsPage $ap, $post) {
	+	// traitement de l'action
	+	[...]
	+	}
	+	}
	+	</code>
	+
	+	Ajoutons maintenant notre action :
	+	<code php>
	+	public static function adminPostsActionsPage($core,$ap)
	+	{
	+	$ap->addAction(
	+	array(__('Change') => array(__('Open/Close Comments or trackbacks') => 'openclosecomtb')),
	+	array('AdminOpenCloseComTB','doOpenCloseComTB')
	+	);
	+	}
	+
	+	</code>
	+
	+	... et le callback qui va bien
	+	<code php>
	+	public static function doOpenCloseComTB($core, dcPostsActionsPage $ap, $post) {
	+	if (!empty($post['changestatus'])) {
	+	# changestatus non vide, le formulaire intermédiaire a été soumis
	+
	+	# Les IDs des billets sont servis sur un plat
	+	$ids = $ap->getIDs();
	+	# Pas de billets, pas bien!
	+	if (empty($ids)) {
	+	throw new Exception(__('No entry selected'));
	+	}
	+
	+	# attention à utiliser $post et non $_POST
	+	$set_co = isset($post['open_comm']);
	+	$set_tb = isset($post['open_tb']);
	+	foreach ($ids as $id)
	+	{
	+	$cur = $core->con->openCursor($core->prefix.'post');
	+	$cur->post_open_tb = $set_tb?1:0;
	+	$cur->post_open_comment = $set_co?1:0;
	+	$cur->update('WHERE post_id = '.(integer) $id);
	+	echo $id;
	+	}
	+	# Traitement fini, on redirige vers l'appelant avec une belle notification
	+	$ap->redirect(true,array('upd' => 1));
	+	# Au diable les exceptions, c'est géré en amont :)
	+
	+	} else {
	+	# Pas de 'changestatus', on affiche le formulaire intermédiaire
	+
	+	# Ne pas oublier de commencer la page
	+	$ap->beginPage();
	+	echo
	+	'<h2>'.__('Open/close comments or trackbacks').'</h2>'.
	+
	+	'<form action="'.$ap->getURI().'" method="post">'.
	+	# Une jolie sélection des billets pour être sûr
	+	$ap->getCheckboxes().
	+
	+	'<p>'.
	+	form::checkbox('open_comm','1','').
	+	' <label class="classic" for="open_comm">'.__('Allow Comments').'</label></p>'.
	+	'<p>'.
	+	form::checkbox('open_tb','1','').
	+	' <label class="classic" for="open_comm">'.__('Allow Trackbacks').'</label></p>'.
	+
	+	// On n'oublie pas les champs cachés, le nonce et l'action
	+	$ap->getHiddenFields().
	+	$core->formNonce().
	+	form::hidden(array('action'),'openclosecomtb').
	+	// le champ changestatus nous permet de tester si le formulaire a bien été soumis
	+	form::hidden(array('changestatus'),'true').
	+	'<p><input type="submit" value="'.__('Ok').'" /></p>'.
	+	'</form>';
	+	# Et on ferme...
	+	$ap->endPage();
	+	}
	+	}
	+	# Et c'est tout :)
	+	</code>

2.0:resources:plugins:admin

Wed, 16 Oct 2013 09:56:41 +0200

1306267311		Version actuelle
Ligne 8:		Ligne 8:
	<code php>		<code php>
	if (!defined('DC_CONTEXT_ADMIN')) {return;}		if (!defined('DC_CONTEXT_ADMIN')) {return;}
		+
		+	global $core;

	# ajouter le plugin dans la liste des plugins du menu de l'administration		# ajouter le plugin dans la liste des plugins du menu de l'administration

2.0:resources:plugins:antispam

Wed, 12 Aug 2015 09:25:48 +0200

1381910201		Version actuelle
Ligne 54:		Ligne 54:
	public $name = 'Foo Filter';		public $name = 'Foo Filter';
	public $has_gui = false;		public $has_gui = false;
		+	public $active = false;

	protected function setInfo()		protected function setInfo()
Ligne 67:		Ligne 68:
	</note>		</note>

-	Nous venons de réaliser un filtre dont le nom est "Foo Filter", avec une description qui sera affichée dans la liste des filtres. Le paramètre $has_gui = false indique que notre filtre n'a pas d'écran de configuration.	+	Nous venons de réaliser un filtre dont le nom est "Foo Filter", avec une description qui sera affichée dans la liste des filtres. Le paramètre $has_gui = false indique que notre filtre n'a pas d'écran de configuration. Le paramètre $active = false indique que le filtre est inactif par defaut.

	<note tip>		<note tip>

2.0:resources:plugins:auto-install

Mon, 13 May 2019 04:47:13 +0200

1381910201		Version actuelle
Ligne 102:		Ligne 102:
	\| float \| Nombre flottant de 8 octets \|		\| float \| Nombre flottant de 8 octets \|
	\| numeric \| Valeur numérique exacte \|		\| numeric \| Valeur numérique exacte \|
-	\| date \| Date calendaire (jour, moins, année) \|	+	\| date \| Date calendaire (jour, mois, année) \|
	\| time \| Heure de la journée \|		\| time \| Heure de la journée \|
	\| timestamp \| Date et heure \|		\| timestamp \| Date et heure \|

2.0:resources:plugins:behaviors

Wed, 28 Dec 2016 13:39:38 +0200

1394457895		Version actuelle
Ligne 738:		Ligne 738:
	<code php>		<code php>
	function coreBlogGetPosts(&$rs);		function coreBlogGetPosts(&$rs);
		+	</code>
		+
		+	==== coreFirstPublicationEntries ====
		+	Appel du behavior :
		+	<code php>$this->core->callBehavior('coreFirstPublicationEntries',$this,$to_change));</code>
		+	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.
		+
		+	^ Paramètre ^ Type ^ Description ^
		+	\| this \| dcBlog \| Référence à un objet dcBlog \|
		+	\| to_change \| array \| Tableau contenant l'ID des billet publiés \|
		+
		+	Exemple de signature :
		+	<code php>
		+	function coreFirstPublicationEntries($blog,$posts_ids);
	</code>		</code>

2.0:resources:plugins:changelogs

Thu, 20 Aug 2015 17:58:09 +0200

1382954874		Version actuelle
Ligne 20:		Ligne 20:
	// Traitement public et admin		// Traitement public et admin

-	if (!defined('DC_CONTEXT_ADMIN')) { return; }	+	if (!defined('DC_CONTEXT_ADMIN')) { return false; }

	// Traitement admin seulement		// Traitement admin seulement

2.0:resources:plugins:columns

Wed, 16 Oct 2013 09:56:41 +0200

1242136679		Version actuelle
Ligne 1:		Ligne 1:
		+	FIXME
		+
	À effacer.		À effacer.
		+
		+	Voir [[.:admin:columns\|columns]].

2.0:resources:plugins:dashboard

Wed, 16 Oct 2013 09:56:41 +0200

1306530007		Version actuelle
Ligne 42:		Ligne 42:
	* class (optionnel) ajouté sur l'item du menu favori (à gauche)		* class (optionnel) ajouté sur l'item du menu favori (à gauche)

-		+	Un plugin peut inscrire autant de favoris qu'il le souhaite. Les icônes utilisées par Dotclear sont issues d'un lot d'icônes dessiné spécialement pour Dotclear, voir [[http://fr.dotclear.org/blog/post/2011/11/13/Dotclear-2.4\|le billet d'annonce de Dotclear 2.4]] pour davantage d'informations.
-	Un plugin peut inscrire autant de favoris qu'il le souhaite. Les icônes utilisées par Dotclear sont issues de ce lot d'icônes : [[http://dryicons.com/free-icons/preview/coquette-icons-set/\|Coquette]].	+

	De plus le plugin peut personnaliser le titre, la petite ou la grande icône d'un favori inscrit et affiché sur le tableau de bord. Voici comment :		De plus le plugin peut personnaliser le titre, la petite ou la grande icône d'un favori inscrit et affiché sur le tableau de bord. Voici comment :

2.0:resources:plugins:files

Fri, 25 Oct 2013 01:50:11 +0200

1382656267		Version actuelle
Ligne 6:		Ligne 6:
	* [[auto-install#le-fichier-_install.php\|_install.php]] : appelé dès qu'un utilisateur se rend sur le tableau de bord via l'interface d'administration		* [[auto-install#le-fichier-_install.php\|_install.php]] : appelé dès qu'un utilisateur se rend sur le tableau de bord via l'interface d'administration
	* [[public-page#le-fichier-_prepend.php\|_prepend.php]] : sera lu après la création des objets, mais avant l'affichage. Il sera lu en façade ainsi que dans l'administration du blog		* [[public-page#le-fichier-_prepend.php\|_prepend.php]] : sera lu après la création des objets, mais avant l'affichage. Il sera lu en façade ainsi que dans l'administration du blog
-	* [[admin#structure-minimale\|_admin.php]] : ne sera lu que dans l'administration du blog.	+	* [[admin\|_admin.php]] : ne sera lu que dans l'administration du blog.
	* [[public-page#le-fichier-_public.php\|_public.php]] : ne sera lu qu'en façade du blog.		* [[public-page#le-fichier-_public.php\|_public.php]] : ne sera lu qu'en façade du blog.
	* [[widgets#creation-du-widget-et-administration\|_widgets.php]] : utilisé par _admin.php et _public.php dans le cadre de la mise à disposition de widget(s) par le plugin pour une utilisation en dehors de la sidebar avec le marqueur de template [[/2.0/resources/themes/tags/widget\|<tpl:Widget>]].		* [[widgets#creation-du-widget-et-administration\|_widgets.php]] : utilisé par _admin.php et _public.php dans le cadre de la mise à disposition de widget(s) par le plugin pour une utilisation en dehors de la sidebar avec le marqueur de template [[/2.0/resources/themes/tags/widget\|<tpl:Widget>]].

2.0:resources:plugins:help

Wed, 16 Oct 2013 09:56:41 +0200

1290549932		Version actuelle
Ligne 68:		Ligne 68:
	<body>		<body>

-	<h3>Paramètres</h3>	+	<h4>Paramètres</h4>
	<dl>		<dl>
	<dt>Nom d'une option du plugin</dt>		<dt>Nom d'une option du plugin</dt>
Ligne 77:		Ligne 77:
	</dl>		</dl>

-	<h3>Une autre section</h3>	+	<h4>Une autre section</h4>
	<dl>		<dl>
	<dt>Lorem ipsum</dt>		<dt>Lorem ipsum</dt>

2.0:resources:plugins:jstoolbar

Wed, 16 Oct 2013 09:56:41 +0200

1378672501		Version actuelle
Ligne 36:		Ligne 36:
	icon: 'index.php?pf=monSuperPlugin/img/truc.png',		icon: 'index.php?pf=monSuperPlugin/img/truc.png',
	fn: {		fn: {
-	wiki = function() {	+	wiki: function() {
	this.encloseSelection('','',function(str) {		this.encloseSelection('','',function(str) {
	if (str == '') {		if (str == '') {

2.0:resources:plugins:listfilter

Sun, 17 Oct 2021 15:42:52 +0200

1634478115		Version actuelle
Ligne 308:		Ligne 308:

	==== Affichage de la liste ====		==== Affichage de la liste ====
-	On ne détail pas ici l'affichage de la liste de résultats, mais seulement des actuces inhérentes aux filtres.	+	On ne détaille pas ici l'affichage de la liste de résultats, mais seulement des astuces inhérentes aux filtres.

	Si on prend l'exemple de la listes des billets Dotclear (admin/posts.php) :		Si on prend l'exemple de la listes des billets Dotclear (admin/posts.php) :
Ligne 338:		Ligne 338:
	On peut voir que la page courante est issue des filtres avec ''$post_filter->page'', idem pour le nombre de résultats par page avec ''$post_filter->nb''.		On peut voir que la page courante est issue des filtres avec ''$post_filter->page'', idem pour le nombre de résultats par page avec ''$post_filter->nb''.

-	On a remplacé la quinzaine de //form::hidden('xxx', 'yyy');// par une seul ligne :	+	On a remplacé la quinzaine de //form::hidden('xxx', 'yyy');// par une seule ligne :
	<code php>		<code php>
	$core->adminurl->getHiddenFormFields('admin.posts', $post_filter->values())		$core->adminurl->getHiddenFormFields('admin.posts', $post_filter->values())
Ligne 344:		Ligne 344:
	Avec ''$post_filter->values()'' qui contient déjà toutes informations sous forme de tableau.		Avec ''$post_filter->values()'' qui contient déjà toutes informations sous forme de tableau.

-	Enfin, ''$post_filter->show()'' permet de préciser si les filtres par défaut ont été modifié.	+	Enfin, ''$post_filter->show()'' permet de préciser si les filtres par défaut ont été modifiés.
	...		...

2.0:resources:plugins:prefs

Wed, 16 Oct 2013 09:56:41 +0200

	Version actuelle
Ligne 1:	Ligne 1:
	+	====== Les préférences utilisateurs ======

	+	===== Enregistrer une préférence =====
	+
	+	Il faut d'abord sélectionner le //workspace// (espace de travail) des préférences grâce à la fonction ''addWorkSpace()'' :
	+
	+	<code php>
	+	$core->auth->user_prefs->addWorkSpace('example');
	+	</code>
	+
	+	<note>Le paramètre de addWorkspace() ne doit contenir que des chiffres ou des lettres sans accent.
	+
	+	Permis : [a-zA-Z][a-zA-Z0-9]
	+
	+	Il est conseillé d'utiliser le nom du plugin comme //workspace// pour éviter que 2 plugins n'aient le même //workspace//.</note>
	+
	+	Pour sauvegarder une préférence on utilise la fonction ''put()'', dont les paramètres sont :
	+	- le nom de la préférence (une chaîne de caractères contenant uniquement des chiffres ou des lettres sans accent et ''_'')
	+	- sa valeur
	+	- son type (une chaîne de caractères) (facultatif mais recommandé pour éviter les ambiguïtés)
	+	- son label (une chaîne de caractères) (facultatif)
	+	- un booléen : écraser l'ancienne valeur (valeur par défaut : oui) (facultatif)
	+	- un booléen : le paramètre est global (valeur par défaut : non) (facultatif)
	+
	+	==== Example avec une chaîne de caractères avec un label ====
	+
	+	<code php>
	+	# création du workspace
	+	$core->auth->user_prefs->addWorkSpace('example');
	+	# l'objet $core->auth->user_prefs->example a été créé
	+
	+	# enregistrement de la préférence dans le workspace example
	+	$core->auth->user_prefs->example->put('pref_name', __('Hello World!'), 'string', 'My label');
	+	</code>
	+
	+	Il est possible d'utiliser [[http://php.net/manual/fr/language.references.php\|l'assignation par référence]] pour faciliter l'accès aux préférences :
	+
	+	<code php>
	+	# création du workspace
	+	$core->auth->user_prefs->addWorkSpace('example');
	+
	+	# assignation par référence, $example_prefs pointe vers le workspace nouvellement créé
	+	$example_prefs =& $core->auth->user_prefs->example;
	+
	+	# enregistrement de la préférence
	+	$example_prefs->put('pref_name', __('Hello World!'), 'string', 'My label');
	+	</code>
	+
	+	==== Les différents types de préférence ====
	+
	+	Enregistrer un nombre flottant :
	+
	+	<code php>
	+	$core->auth->user_prefs->example->put('pi', 3.14159265, 'float');
	+	</code>
	+
	+	Enregistrer un nombre entier :
	+
	+	<code php>
	+	$core->auth->user_prefs->example->put('nb_entries', 217, 'integer');
	+	</code>
	+
	+	Enregistrer un booléen :
	+
	+	<code php>
	+	$core->auth->user_prefs->example->put('is_valid', true, 'boolean');
	+	</code>
	+
	+	Enregistrer une chaîne de caractères :
	+
	+	<code php>
	+	$core->auth->user_prefs->example->put('title', __('Hello World!'), 'string');
	+	</code>
	+
	+	<note warning>
	+	Pour stocker une chaîne de caractères avec plusieurs lignes, utilisez la fonction ''[[http://fr.php.net/manual/fr/function.base64-encode.php\|base64_encode()]]'' lors de l'enregistrement et ''[[http://fr.php.net/manual/fr/function.base64-decode.php\|base64_decode()]]'' lors de la lecture du paramètre. Ceci préservera les retours à la ligne lors de l'édition de [[:2.0:admin:aboutconfig\|about:config]].
	+	</note>
	+
	+	===== Lire une préférence =====
	+
	+	Une préférence est assignée à la variable $core->auth->user_prefs->nom du workspace->nom de la préférence, par exemple :
	+
	+	<code php>
	+	$string = $core->auth->user_prefs->example->title;
	+	</code>
	+
	+	===== Effacer une préférence =====
	+
	+	Il faut utiliser la fonction ''drop()'' avec l'identifiant de la préférence comme argument :
	+
	+	<code php>
	+	$core->auth->user_prefs->addWorkspace('example');
	+
	+	# création de la préférence
	+	$core->auth->user_prefs->example->put('title', __('Hello World!'), 'string');
	+
	+	# suppression de la préférence
	+	$core->auth->user_prefs->example->drop('title');
	+	</code>

2.0:resources:plugins:public-page

Fri, 09 Mar 2018 16:38:50 +0200

1520609879		Version actuelle
Ligne 177:		Ligne 177:

	<code html>		<code html>
-	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"	+	<!DOCTYPE html>
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">	+	<html lang="{{tpl:BlogLanguage}}">
-	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{{tpl:BlogLanguage}}" lang="{{tpl:BlogLanguage}}">	+
	<head>		<head>
	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />		<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />
-	<meta name="MSSmartTagsPreventParsing" content="TRUE" />

	<title>{{tpl:lang Public example}} - {{tpl:BlogName encode_html="1"}}</title>		<title>{{tpl:lang Public example}} - {{tpl:BlogName encode_html="1"}}</title>

2.0:resources:plugins:public

Wed, 16 Oct 2013 09:56:41 +0200

1245258486		Version actuelle
Ligne 1:		Ligne 1:
-	====== Création d'une page sur le blog ======	+	FIXME

-	Après avoir découvert comment [[.:tutorial#premier-plugin\|créer un plugin]], voyons comment créer une page //interactive// sur un blog. Nous allons créer un plugin ''Public'' en plaçant les fichiers suivants dans un répertoire appelé ''/public/''.	+	À effacer.

-	===== Le fichier _define.php =====	+	Voir [[.:public-page\|public-page]].
-		+
-	<code php>	+
-	<?php	+
-	if (!defined('DC_RC_PATH')) {return;}	+
-		+
-	$this->registerModule(	+
-	*/ Name / 'Public',*	+
-	*/ Description / 'Public',*	+
-	*/ Author / 'Dotclear Documentation',*	+
-	*/ Version / '0.1',*	+
-	*/ Permissions / 'usage,contentadmin'*	+
-	);	+
-	?>	+
-	</code>	+
-		+
-	===== Le fichier _prepend.php =====	+
-		+
-	On enregistre l'URL dans le fichier ''_prepend.php'' :	+
-	<code php>	+
-	# enregistrer l'URL "public"	+
-	$core->url->register('public','public',	+
-	'^public(?:/(.+))?$',array('publicDocument','page'));	+
-	</code>	+
-		+
-	Paramètres de la fonction register :	+
-	- le type d'URL, utilisé par Dotclear pour l'identifier	+
-	- l'URL de base de la page	+
-	- l'expression régulière de l'URL de la page	+
-	- un //callback//, un nom de fonction ou un tableau avec le nom d'une classe et d'une fonction à appeler lorsque cette URL est demandée	+
-		+
-	Pour accéder à cette URL, quel que soit le contexte, on utilise ce code :	+
-		+
-	<code php>$core->blog->url.$core->url->getBase('public')</code>	+
-		+
-	''public'' est l'identifiant de l'URL.	+
-		+
-	===== Le fichier _public.php =====	+
-		+
-	==== Création de la page ====	+
-		+
-	L'URL "public" que l'on a enregistrée dans le fichier ''_prepend.php'' appelle la fonction ''page()'' de la classe ''publicDocument''. Cette fonction reçoit un paramètre, il correspond à l'expression régulière de l'URL de la page, ici ''^public(?:/(.+))?'' sélectionne le texte après ''public/'' s'il existe. Le plugin affichera un message différent si on demande l'URL "public/hello".	+
-		+
-	<code php>	+
-	class publicDocument extends dcUrlHandlers	+
-	{	+
-	public static function page($args)	+
-	{	+
-	global $core;	+
-		+
-	# $_ctx est le contexte, on y insère ce que l'on veut	+
-	$_ctx =& $GLOBALS['_ctx'];	+
-		+
-	# si l'URL est "public/lorem"	+
-	if ($args == 'lorem')	+
-	{	+
-	$_ctx->public = __('Lorem ipstum');	+
-	}	+
-	# sinon, si l'URL est "public"	+
-	else	+
-	{	+
-	$_ctx->public = __('Public');	+
-	}	+
-		+
-	# enregistrer le répertoire qui contient le fichier template par défaut,	+
-	# le fichier public.html	+
-	$core->tpl->setPath($core->tpl->getPath(),	+
-	dirname(__FILE__).'/default-templates/');	+
-		+
-	self::serveDocument('public.html','text/html');	+
-	}	+
-	}	+
-	</code>	+
-		+
-	La variable ''$_ctx->public'' est définie en fonction de la valeur de ''$args'', elle sera utilisée plus tard.	+
-		+
-	==== Déclaration de la balise ====	+
-		+
-	Voir la [[..:tpl\|page spécifique]] pour plus d'informations.	+
-		+
-	<code php>	+
-	# enregistrer la balise {{tpl:Public}}	+
-	$core->tpl->addValue('PublicValue',array('publicTpl','PublicValue'));	+
-		+
-	class publicTpl	+
-	{	+
-	public static function PublicValue()	+
-	{	+
-	return('<?php echo($_ctx->public); ?>');	+
-	}	+
-	}	+
-	</code>	+
-		+
-	===== Le fichier de template =====	+
-		+
-	Situé dans le répertoire ''default-templates'', le fichier de template est appelé public.html et il contient ceci :	+
-		+
-	<code html>	+
-	<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"	+
-	"http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">	+
-	<html xmlns="http://www.w3.org/1999/xhtml" xml:lang="{{tpl:BlogLanguage}}" lang="{{tpl:BlogLanguage}}">	+
-	<head>	+
-	<meta http-equiv="Content-Type" content="text/html; charset=UTF-8" />	+
-	<meta name="MSSmartTagsPreventParsing" content="TRUE" />	+
-		+
-	<title>{{tpl:lang Public}} - {{tpl:BlogName encode_html="1"}}</title>	+
-		+
-	{{tpl:include src="_head.html"}}	+
-	</head>	+
-		+
-	<body class="dc-Public">	+
-	<div id="page">	+
-	{{tpl:include src="_top.html"}}	+
-		+
-	<div id="wrapper">	+
-		+
-	<div id="main">	+
-	<div id="content">	+
-		+
-	<div id="content-info">	+
-	<h2>{{tpl:lang Public}}</h2>	+
-	</div>	+
-		+
-	<div class="content-inner">	+
-	<p>{{tpl:PublicValue}}</p>	+
-	</div>	+
-		+
-	</div>	+
-	</div> <!-- End #main -->	+
-		+
-	<div id="sidebar">	+
-	<div id="blognav">	+
-	{{tpl:Widgets type="nav"}}	+
-	</div> <!-- End #blognav -->	+
-		+
-	<div id="blogextra">	+
-	{{tpl:Widgets type="extra"}}	+
-	</div> <!-- End #blogextra -->	+
-	</div>	+
-		+
-	</div> <!-- End #wrapper -->	+
-		+
-	{{tpl:include src="_footer.html"}}	+
-	</div> <!-- End #page -->	+
-	</body>	+
-	</html>	+
-	</code>	+
-		+
-	Il utilise la balise <code tpl>{{tpl:Public}}</code> déclarée dans le fichier _public.php.	+

2.0:resources:plugins:services

Wed, 16 Oct 2013 09:56:41 +0200

1277726836		Version actuelle
Ligne 3:		Ligne 3:
	===== Qu'est ce qu'un service Ajax? =====		===== Qu'est ce qu'un service Ajax? =====

-	Un service Ajax permet de collecter et retourner des données sous forme d'un fichier XML. Ce service sera appelé via une requête Ajax de façon dynamique et sera ensuite traité par du Javascript pour mettre à jour une partie d'une page de l'administration de Dotclear. C'est par exemple, ce qui est utilisé pour afficher la liste des tags lors de la rédaction d'un billet. Lors du clic sur le lien __//Voir les tags//__, le service Ajax associé est appelé, retourne la liste des tags qui est ensuite affichée à l'utilisateur.	+	Un service Ajax permet de collecter et retourner des données sous forme d'un fichier XML. Ce service sera appelé via une requête Ajax de façon dynamique et sera ensuite traité par du Javascript pour mettre à jour une partie d'une page de l'administration de Dotclear. C'est par exemple ce qui est utilisé pour afficher la liste des tags lors de la rédaction d'un billet. Lors du clic sur le lien __//Voir les tags//__, le service Ajax associé est appelé, retourne la liste des tags qui est ensuite affichée à l'utilisateur.

	===== Pré-requis =====		===== Pré-requis =====

2.0:resources:plugins:settings

Wed, 16 Oct 2013 09:56:41 +0200

1305382696		Version actuelle
Ligne 40:		Ligne 40:
	$core->blog->settings->addNameSpace('example');		$core->blog->settings->addNameSpace('example');

-	# assignation par référence, $settings pointe vers le namespace nouvellement créé	+	# assignation par référence, $example_settings pointe vers le namespace nouvellement créé
-	$settings =& $core->blog->settings->example;	+	$example_settings =& $core->blog->settings->example;

	# enregistrement du paramètre		# enregistrement du paramètre
-	$settings->put('setting_name', __('Hello World!'), 'string', 'My label');	+	$example_settings->put('setting_name', __('Hello World!'), 'string', 'My label');
	</code>		</code>

2.0:resources:plugins:tpl

Wed, 16 Oct 2013 09:56:41 +0200

1231688370		Version actuelle
Ligne 1:		Ligne 1:
		+	FIXME
		+
		+	À effacer.
		+
	Voir [[2.0:resources:tpl\|tpl]].		Voir [[2.0:resources:tpl\|tpl]].

2.0:resources:plugins:translate

Wed, 16 Oct 2013 09:56:41 +0200

1309297720		Version actuelle
Ligne 138:		Ligne 138:
	Peut être dans le but d'une adaptation rapide vers Dotclear2 tel que le plugin newsletter,		Peut être dans le but d'une adaptation rapide vers Dotclear2 tel que le plugin newsletter,

-	=== Le fichiers main.lang.php ===	+	=== Le fichier main.lang.php ===

	Même principe que pour Dotclear 2 sauf que tout est réuni en une ligne et qu'on ne sait pas quels sont les fichiers qui l'appellent.		Même principe que pour Dotclear 2 sauf que tout est réuni en une ligne et qu'on ne sait pas quels sont les fichiers qui l'appellent.

2.0:resources:plugins:tutorial

Tue, 11 Aug 2015 16:00:21 +0200

1439301496		Version actuelle
Ligne 67:		Ligne 67:
	\| tplset \| T \| Nom du set de templates à utiliser \|		\| tplset \| T \| Nom du set de templates à utiliser \|
	\| permissions \| P \| Permissions du plugin\|		\| permissions \| P \| Permissions du plugin\|
-	\| priority \| P+T \| priorité du module \|	+	\| priority \| P+T \| priorité du module (1000 par défaut, les plus petites priorités sont chargés en premier) \|
	\| widgettitleformat \| T \| Format des titres des widgets (ex : <h3 class="widget-title">%s</h3>) \|		\| widgettitleformat \| T \| Format des titres des widgets (ex : <h3 class="widget-title">%s</h3>) \|
	\| widgetsubtitleformat \| T \| Format des sous-titres des widgets (ex : <h4 class="widget-subtitle">%s</h4>) \|		\| widgetsubtitleformat \| T \| Format des sous-titres des widgets (ex : <h4 class="widget-subtitle">%s</h4>) \|

2.0:resources:plugins:widgets

Wed, 16 Oct 2013 09:56:41 +0200

1375637214		Version actuelle
Ligne 112:		Ligne 112:
	<?php		<?php
	if (!defined('DC_RC_PATH')) { return; }		if (!defined('DC_RC_PATH')) { return; }
		+
		+	global $core;

	$core->addBehavior('initWidgets',		$core->addBehavior('initWidgets',

1381910201		Version actuelle
Ligne 102:		Ligne 102:
	\| float \| Nombre flottant de 8 octets \|		\| float \| Nombre flottant de 8 octets \|
	\| numeric \| Valeur numérique exacte \|		\| numeric \| Valeur numérique exacte \|
-	\| date \| Date calendaire (jour, moins, année) \|	+	\| date \| Date calendaire (jour, mois, année) \|
	\| time \| Heure de la journée \|		\| time \| Heure de la journée \|
	\| timestamp \| Date et heure \|		\| timestamp \| Date et heure \|

1382656267		Version actuelle
Ligne 6:		Ligne 6:
	* [[auto-install#le-fichier-_install.php\|_install.php]] : appelé dès qu'un utilisateur se rend sur le tableau de bord via l'interface d'administration		* [[auto-install#le-fichier-_install.php\|_install.php]] : appelé dès qu'un utilisateur se rend sur le tableau de bord via l'interface d'administration
	* [[public-page#le-fichier-_prepend.php\|_prepend.php]] : sera lu après la création des objets, mais avant l'affichage. Il sera lu en façade ainsi que dans l'administration du blog		* [[public-page#le-fichier-_prepend.php\|_prepend.php]] : sera lu après la création des objets, mais avant l'affichage. Il sera lu en façade ainsi que dans l'administration du blog
-	* [[admin#structure-minimale\|_admin.php]] : ne sera lu que dans l'administration du blog.	+	* [[admin\|_admin.php]] : ne sera lu que dans l'administration du blog.
	* [[public-page#le-fichier-_public.php\|_public.php]] : ne sera lu qu'en façade du blog.		* [[public-page#le-fichier-_public.php\|_public.php]] : ne sera lu qu'en façade du blog.
	* [[widgets#creation-du-widget-et-administration\|_widgets.php]] : utilisé par _admin.php et _public.php dans le cadre de la mise à disposition de widget(s) par le plugin pour une utilisation en dehors de la sidebar avec le marqueur de template [[/2.0/resources/themes/tags/widget\|<tpl:Widget>]].		* [[widgets#creation-du-widget-et-administration\|_widgets.php]] : utilisé par _admin.php et _public.php dans le cadre de la mise à disposition de widget(s) par le plugin pour une utilisation en dehors de la sidebar avec le marqueur de template [[/2.0/resources/themes/tags/widget\|<tpl:Widget>]].

1439301496		Version actuelle
Ligne 67:		Ligne 67:
	\| tplset \| T \| Nom du set de templates à utiliser \|		\| tplset \| T \| Nom du set de templates à utiliser \|
	\| permissions \| P \| Permissions du plugin\|		\| permissions \| P \| Permissions du plugin\|
-	\| priority \| P+T \| priorité du module \|	+	\| priority \| P+T \| priorité du module (1000 par défaut, les plus petites priorités sont chargés en premier) \|
	\| widgettitleformat \| T \| Format des titres des widgets (ex : <h3 class="widget-title">%s</h3>) \|		\| widgettitleformat \| T \| Format des titres des widgets (ex : <h3 class="widget-title">%s</h3>) \|
	\| widgetsubtitleformat \| T \| Format des sous-titres des widgets (ex : <h4 class="widget-subtitle">%s</h4>) \|		\| widgetsubtitleformat \| T \| Format des sous-titres des widgets (ex : <h4 class="widget-subtitle">%s</h4>) \|