Browse Source

Correction des erreurs PHPdoc et petite amélioration du guide.

pull/11/head
Eric Lupinacci 2 years ago
parent
commit
9ed0c85ec6
  1. BIN
      Guide N - Le plugin N-Core.pdf
  2. 54
      formulaires/editer_noisette.php
  3. 2
      inc/ncore_type_noisette.php
  4. 4
      ncore/ncore.php
  5. 22
      ncore_autorisations.php
  6. 10
      ncore_fonctions.php

BIN
Guide N - Le plugin N-Core.pdf

Binary file not shown.

54
formulaires/editer_noisette.php

@ -1,13 +1,34 @@
<?php
/**
* Gestion du formulaire générique d'édition d'une noisette.
*
* @package SPIP\NCORE\NOISETTE\UI
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
if (!function_exists('autoriser')) {
// si on utilise le formulaire dans le public
include_spip('inc/autoriser');
} // si on utilise le formulaire dans le public
}
/**
* Construction des saisies : les saisies du formulaire sont totalement définies en PHP (le fichier HTML est vide).
* Par défaut, N-Core range les saisies dans trois groupes (fieldsets), à savoir, Contenu, Affichage et Avancé qui
* ne sont affichés que si il contienne au moins une saisie incluse.
*
* @uses noisette_lire()
* @uses type_noisette_lire()
* @uses ncore_noisette_initialiser_encapsulation()
*
* @param string $plugin Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent
* est d'utiliser le préfixe.
* @param string|int $id_noisette Identifiant unique de la noisette.
* @param string $redirect URL de redirection en sortie du formulaire.
*
* @return array
*/
function formulaires_editer_noisette_saisies_dist($plugin, $id_noisette, $redirect = '') {
// On sauvegarde les saisies de la noisette en statique
@ -153,6 +174,20 @@ function formulaires_editer_noisette_saisies_dist($plugin, $id_noisette, $redire
return $saisies;
}
/**
* Chargement des données : la fonction charge les données d'initialisation des saisies définies dans la fonction
* `formulaires_editer_noisette_saisies_dist()`.
*
* @uses noisette_lire()
* @uses type_noisette_lire()
*
* @param string $plugin Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent
* est d'utiliser le préfixe.
* @param string|int $id_noisette Identifiant unique de la noisette.
* @param string $redirect URL de redirection en sortie du formulaire.
*
* @return array
*/
function formulaires_editer_noisette_charger_dist($plugin, $id_noisette, $redirect = '') {
$valeurs = array('editable' => false);
@ -200,6 +235,21 @@ function formulaires_editer_noisette_charger_dist($plugin, $id_noisette, $redire
}
/**
* Exécution du formulaire : les modifications effectuées sur les paramètres de la noisette sont enregistrés
* dans l'espace de stockage du plugin utilisateur.
*
* @uses type_noisette_lire()
* @uses ncore_noisette_initialiser_encapsulation()
* @uses noisette_parametrer()
*
* @param string $plugin Identifiant qui permet de distinguer le module appelant. Pour un plugin, le plus pertinent
* est d'utiliser le préfixe.
* @param string|int $id_noisette Identifiant unique de la noisette.
* @param string $redirect URL de redirection en sortie du formulaire.
*
* @return array
*/
function formulaires_editer_noisette_traiter_dist($plugin, $id_noisette, $redirect = '') {
$retour = array();

2
inc/ncore_type_noisette.php

@ -380,8 +380,6 @@ function type_noisette_repertorier($plugin, $filtres = array(), $stockage = '')
*
* @api
*
* @uses cache_supprimer()
*
* @param string $plugin Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier
* ou un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
* @param array|string $fonctions Identifiants des fonctions permettant de nommer le cache : les valeurs possibles sont `ajax`, `inclusions`

4
ncore/ncore.php

@ -28,8 +28,6 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* @package SPIP\NCORE\TYPE_NOISETTE\SERVICE
*
* @uses ncore_chercher_service()
* @uses cache_lire()
* @uses cache_ecrire()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -278,7 +276,6 @@ function ncore_type_noisette_traiter_typo($plugin, $description, $stockage = '')
* @package SPIP\NCORE\TYPE_NOISETTE\SERVICE
*
* @uses ncore_chercher_service()
* @uses cache_lire()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -331,7 +328,6 @@ function ncore_type_noisette_decrire($plugin, $type_noisette, $stockage = '') {
* @package SPIP\NCORE\TYPE_NOISETTE\SERVICE
*
* @uses ncore_chercher_service()
* @uses cache_lire()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou

22
ncore_autorisations.php

@ -1,5 +1,8 @@
<?php
// Sécurité
/**
* Gestion des autorisations du plugin N-Core liées à l'utilisation des API.
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
@ -7,6 +10,7 @@ if (!defined('_ECRIRE_INC_VERSION')) {
/**
* Fonction appelée par le pipeline
*
* @pipeline autoriser
*/
function ncore_autoriser() {}
@ -16,13 +20,17 @@ function ncore_autoriser() {}
* Il faut :
* - que la noisette existe bien.
*
* @param $faire
* @param $type
* @param $id
* @param $qui
* @param $options
* @package SPIP\NCORE\NOISETTE\AUTORISATION
*
* @uses noisette_lire()
*
* @param string $faire Action demandée: l'édition (editer)
* @param string $type Type d'objet sur lequel appliquer l'action : une noisette
* @param int $id Identifiant de la noisette.
* @param array $qui Description de l'auteur demandant l'autorisation ou tableau vide.
* @param array $options Options de cette autorisation : non utilisé
*
* @return bool
* @return bool `true` si autorisé, `false` sinon.
*/
function autoriser_noisette_editer_dist($faire, $type, $id, $qui, $options) {
$autoriser = false;

10
ncore_fonctions.php

@ -9,6 +9,10 @@ if (!defined('_ECRIRE_INC_VERSION')) {
}
if (!defined('_NCORE_ENCAPSULATION_AUTO')) {
/**
* Indicateur d'encapsulation automatique. Par défaut à `true`, ce qui implique que toute les noisettes
* non conteneur sont incluses dans une capsule.
*/
define('_NCORE_ENCAPSULATION_AUTO', true);
}
@ -26,8 +30,6 @@ if (!defined('_NCORE_ENCAPSULATION_AUTO')) {
* @api
* @filtre
*
* @uses cache_lire()
* @uses cache_ecrire()
* @uses ncore_type_noisette_lister()
* @uses ncore_type_noisette_initialiser_ajax()
*
@ -101,8 +103,6 @@ function type_noisette_ajaxifier($plugin, $type_noisette, $stockage = '') {
* @api
* @filtre
*
* @uses cache_lire()
* @uses cache_ecrire()
* @uses ncore_type_noisette_initialiser_inclusion()
* @uses ncore_type_noisette_lister()
*
@ -223,8 +223,6 @@ include_spip('public/noisette_repertorier');
* @api
* @filtre
*
* @uses cache_lire()
* @uses cache_ecrire()
* @uses ncore_type_noisette_lister()
*
* @param string $plugin

Loading…
Cancel
Save