Browse Source

Suite de PSR et PHPDoc

svn/root/tags/v010
eric@smellup.net 5 years ago
parent
commit
858842e78e
  1. 36
      inc/ncore_cache.php
  2. 118
      inc/ncore_type_noisette.php
  3. 20
      inc/ncore_utils.php
  4. 78
      ncore/ncore.php
  5. 13
      ncore_fonctions.php

36
inc/ncore_cache.php

@ -61,14 +61,14 @@ if (!defined('_NCORE_NOMCACHE_NOISETTE_CONTEXTE')) {
* @api
* @uses lire_fichier_securise()
*
* @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 string $nom_cache
* Nom et extension du fichier cache.
* @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 string $nom_cache
* Nom et extension du fichier cache.
*
* @return array
* Contenu du fichier sous la forme d'un tableau éventuellement vide.
* Contenu du fichier sous la forme d'un tableau éventuellement vide.
*/
function cache_lire($plugin, $nom_cache) {
@ -93,13 +93,13 @@ function cache_lire($plugin, $nom_cache) {
* @api
* @uses ecrire_fichier_securise()
*
* @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 string $nom_cache
* Nom et extension du fichier cache.
* @param array $contenu_cache
* Contenu sous forme de tableau à stocker dans un fichier cache après sérialisation.
* @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 string $nom_cache
* Nom et extension du fichier cache.
* @param array $contenu_cache
* Contenu sous forme de tableau à stocker dans un fichier cache après sérialisation.
*
* @return void
*/
@ -129,11 +129,11 @@ function cache_ecrire($plugin, $nom_cache, $contenu_cache) {
* @api
* @uses supprimer_fichier()
*
* @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 string $nom_cache
* Nom et extension du fichier cache.
* @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 string $nom_cache
* Nom et extension du fichier cache.
*
* @return void
*/

118
inc/ncore_type_noisette.php

@ -20,22 +20,22 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* @uses ncore_type_noisette_lister()
* @uses ncore_type_noisette_stocker()
*
* @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 string $dossier
* Chemin relatif (avec un `/` final) dans lequel chercher les fichiers YAML de description des noisettes.
* Par défaut, les noisettes seront recherchées dans le dossier `noisettes/`.
* @param bool $recharger
* Si `true` force le rechargement de toutes les types de noisettes, sinon le chargement se base sur le
* md5 des fichiers YAML. Par défaut vaut `false`.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
* @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 string $dossier
* Chemin relatif (avec un `/` final) dans lequel chercher les fichiers YAML de description des noisettes.
* Par défaut, les noisettes seront recherchées dans le dossier `noisettes/`.
* @param bool $recharger
* Si `true` force le rechargement de toutes les types de noisettes, sinon le chargement se base sur le
* md5 des fichiers YAML. Par défaut vaut `false`.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
*
* @return bool
* `false` si une erreur s'est produite, `true` sinon.
* `false` si une erreur s'est produite, `true` sinon.
*/
function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = false, $stockage = '') {
@ -76,17 +76,17 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
// Initialisation de la description par défaut du type de noisette
// -- on y inclut le plugin appelant et la signature
$description_defaut = array(
'noisette' => $type_noisette,
'nom' => $type_noisette,
'description' => '',
'icon' => 'noisette-24.png',
'necessite' => array(),
'contexte' => array(),
'ajax' => 'defaut',
'inclusion' => 'statique',
'parametres' => array(),
'plugin' => $plugin,
'signature' => '',
'noisette' => $type_noisette,
'nom' => $type_noisette,
'description' => '',
'icon' => 'noisette-24.png',
'necessite' => array(),
'contexte' => array(),
'ajax' => 'defaut',
'inclusion' => 'statique',
'parametres' => array(),
'plugin' => $plugin,
'signature' => '',
);
// On vérifie que le md5 du fichier YAML est bien différent de celui stocké avant de charger
@ -96,7 +96,7 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
include_spip('inc/yaml');
$description = yaml_charger_inclusions(yaml_decode_file($_chemin));
// Traitements des champs pouvant être soit une chaine soit un tableau
// Traitements des champs pouvant être soit une chaine soit un tableau
if (!empty($description['necessite']) and is_string($description['necessite'])) {
$description['necessite'] = array($description['necessite']);
}
@ -112,7 +112,7 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
$type_noisette_a_garder = true;
if (!empty($description['necessite'])) {
foreach ($description['necessite'] as $_plugin_necessite) {
if (!defined('_DIR_PLUGIN_'.strtoupper($_plugin_necessite))) {
if (!defined('_DIR_PLUGIN_' . strtoupper($_plugin_necessite))) {
$type_noisette_a_garder = false;
break;
}
@ -163,7 +163,7 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
// -- Update des types de noisette modifiés.
// -- Insertion des nouveaux types de noisette.
if ($recharger
or (!$recharger and ($types_noisette_a_ajouter or $types_noisette_a_effacer or $types_noisette_a_changer))) {
or (!$recharger and ($types_noisette_a_ajouter or $types_noisette_a_effacer or $types_noisette_a_changer))) {
$types_noisette = array('a_ajouter' => $types_noisette_a_ajouter);
if (!$recharger) {
$types_noisette['a_effacer'] = $types_noisette_a_effacer;
@ -184,28 +184,28 @@ function type_noisette_charger($plugin, $dossier = 'noisettes/', $recharger = fa
* @api
* @uses ncore_type_noisette_decrire()
*
* @param string $plugin
* Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou
* un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
* La fonction utilisera la fonction de lecture de la description brute d'un type de noisette, spécifique
* au service, ou à défaut, celle fournie par N-Core.
* @param string $type_noisette
* Identifiant du type de noisette.
* @param string $information
* Information spécifique à retourner ou vide pour retourner toute la description.
* @param boolean $traiter_typo
* Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées
* en utilisant la fonction _T_ou_typo. Par défaut l'indicateur vaut `false`.
* Les champs sérialisés sont eux toujours désérialisés.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
* @param string $plugin
* Le service permet de distinguer l'appelant qui peut-être un plugin comme le noiZetier ou
* un script. Pour un plugin, le plus pertinent est d'utiliser le préfixe.
* La fonction utilisera la fonction de lecture de la description brute d'un type de noisette, spécifique
* au service, ou à défaut, celle fournie par N-Core.
* @param string $type_noisette
* Identifiant du type de noisette.
* @param string $information
* Information spécifique à retourner ou vide pour retourner toute la description.
* @param boolean $traiter_typo
* Indique si les données textuelles doivent être retournées brutes ou si elles doivent être traitées
* en utilisant la fonction _T_ou_typo. Par défaut l'indicateur vaut `false`.
* Les champs sérialisés sont eux toujours désérialisés.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
*
* @return array|string
* La description complète ou champ précis demandé pour un type de noisette donné. Les champs
* de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être
* traités avec la fonction _T_ou_typo().
* La description complète ou champ précis demandé pour un type de noisette donné. Les champs
* de type tableau sont systématiquement désérialisés et si demandé, les champs textuels peuvent être
* traités avec la fonction _T_ou_typo().
*/
function type_noisette_lire($plugin, $type_noisette, $information = '', $traiter_typo = false, $stockage = '') {
@ -267,19 +267,19 @@ function type_noisette_lire($plugin, $type_noisette, $information = '', $traiter
* @api
* @uses ncore_type_noisette_lister()
*
* @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 $filtres
* Tableau associatif `[champ] = valeur` de critères de filtres sur les descriptions de types de noisette.
* Le seul opérateur possible est l'égalité.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
* @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 $filtres
* Tableau associatif `[champ] = valeur` de critères de filtres sur les descriptions de types de noisette.
* Le seul opérateur possible est l'égalité.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
*
* @return array
* Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
* Tableau des descriptions des types de noisette trouvés indexé par le type de noisette.
*/
function type_noisette_repertorier($plugin, $filtres = array(), $stockage = '') {

20
inc/ncore_utils.php

@ -13,18 +13,18 @@ if (!defined('_ECRIRE_INC_VERSION')) {
* Cherche une fonction donnée en se basant sur le service de stockage ou à défaut sur le plugin appelant.
* Si ni le service de stockage ni le plugin ne fournissent la fonction demandée la chaine vide est renvoyée.
*
* @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 bool $fonction
* Nom de la fonction à chercher.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
* @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 bool $fonction
* Nom de la fonction à chercher.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin
* ni celui de N-Core ne seront utilisés. En général, cet identifiant est le préfixe d'un plugin
* fournissant le service de stockage souhaité.
*
* @return string
* Nom complet de la fonction si trouvée ou chaine vide sinon.
* Nom complet de la fonction si trouvée ou chaine vide sinon.
*/
function ncore_chercher_service($plugin, $fonction, $stockage = '') {

78
ncore/ncore.php

@ -28,8 +28,8 @@ if (!defined('_ECRIRE_INC_VERSION')) {
*
* @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
*
* @uses cache_lire()
* @uses cache_ecrire()
* @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
@ -121,7 +121,7 @@ function ncore_type_noisette_stocker($plugin, $types_noisette, $recharger, $stoc
*
* @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
*
* @uses cache_lire()
* @uses cache_lire()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -168,7 +168,7 @@ function ncore_type_noisette_decrire($plugin, $type_noisette, $stockage = '') {
*
* @package SPIP\NCORE\SERVICE\TYPE_NOISETTE
*
* @uses cache_lire()
* @uses cache_lire()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -227,8 +227,8 @@ function ncore_type_noisette_lister($plugin, $information = '', $stockage = '')
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -311,8 +311,8 @@ function ncore_noisette_stocker($plugin, $description, $stockage = '') {
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -383,15 +383,15 @@ function ncore_noisette_ranger($plugin, $description, $rang_destination, $stocka
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @param string $plugin
* @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 $description
* @param array|string $description
* Description complète de la noisette ou identifiant du squelette contextualisé.
* @param string $stockage
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
* ne seront utilisés. En général, cet identifiant est le préfixe du plugin fournissant le stockage.
*
@ -456,21 +456,23 @@ function ncore_noisette_destocker($plugin, $description, $stockage = '') {
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @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 string $squelette
* Chemin relatif du squelette où ajouter la noisette.
* @param array $contexte
* Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
* @param string $information
* Champ précis de la description d'une noisette ou vide pour toute la description.
* @param string $cle
* Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit `id_noisette`
* soit `rang`.
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @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 string $squelette
* Chemin relatif du squelette où ajouter la noisette.
* @param array $contexte
* Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
* @param string $information
* Identifiant d'un champ de la description d'une type de noisette.
* Si l'argument est vide, la fonction renvoie les descriptions complètes et si l'argument est
* un champ invalide la fonction renvoie un tableau vide.
* @param string $cle
* Champ de la description d'une noisette servant d'index du tableau. En général on utilisera soit `id_noisette`
* soit `rang`.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
* ne seront utilisés. En général, cet identifiant est le préfixe du plugin fournissant le stockage.
@ -531,8 +533,8 @@ function ncore_noisette_lister($plugin, $squelette = '', $contexte = array(), $i
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
* @uses ncore_chercher_service()
* @uses ncore_squelette_identifier()
*
* @param string $plugin
* Identifiant qui permet de distinguer le module appelant qui peut-être un plugin comme le noiZetier ou
@ -616,15 +618,15 @@ function ncore_noisette_decrire($plugin, $noisette, $stockage = '') {
*
* @package SPIP\NCORE\SERVICE\NOISETTE
*
* @uses ncore_chercher_service()
* @uses ncore_chercher_service()
*
* @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 string $squelette
* Chemin relatif du squelette où ajouter la noisette.
* @param array $contexte
* Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
* @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 string $squelette
* Chemin relatif du squelette où ajouter la noisette.
* @param array $contexte
* Tableau éventuellement vide matérialisant le contexte d'utilisation du squelette.
* @param string $stockage
* Identifiant du service de stockage à utiliser si précisé. Dans ce cas, ni celui du plugin ni celui de N-Core
* ne seront utilisés. En général, cet identifiant est le préfixe du plugin fournissant le stockage.

13
ncore_fonctions.php

@ -1,13 +0,0 @@
<?php
/**
* Ce fichier contient l'API N-Core de gestion des noisettes.
*
*/
if (!defined('_ECRIRE_INC_VERSION')) {
return;
}
// -------------------------------------------------------------------
// ------------------------- API COMPILATION ---------------------------
// -------------------------------------------------------------------
Loading…
Cancel
Save