Changeset 110117 in spip-zone


Ignore:
Timestamp:
May 6, 2018, 3:39:05 PM (19 months ago)
Author:
eric@…
Message:

PHPDoc sur les balises.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _plugins_/noizetier/trunk/noizetier_fonctions.php

    r110115 r110117  
    1616// --------------------------------------------------------------------------------
    1717
     18/**
     19 * Compile la balise `#NOIZETIER_NOISETTE_PREVIEW` qui permet d'afficher la prévisualisation d'une noisette
     20 * si le squelette idoine existe (type_noisette-preview.html) dans le même répertoire que celui du type de noisette.
     21 * La signature de la balise est : `#NOIZETIER_NOISETTE_PREVIEW`.
     22 *
     23 * @package SPIP\NOIZETIER\NOISETTE\BALISE
     24 * @balise
     25 *
     26 * @param Champ $p
     27 *        Pile au niveau de la balise.
     28 *
     29 * @return Champ
     30 *         Pile complétée par le code à générer.
     31 **/
    1832function balise_NOIZETIER_NOISETTE_PREVIEW_dist($p) {
     33
    1934        $id_noisette = champ_sql('id_noisette', $p);
    2035        $type_noisette = champ_sql('type_noisette', $p);
     
    4762 * sinon cherche dans le path SPIP (find_in_path).
    4863 *
    49  * @package SPIP\NOIZETIER\API\ICONE
     64 * @package SPIP\NOIZETIER\ICONE\API
    5065 * @api
    5166 * @filtre
     
    6883 * spip du privé.
    6984 *
    70  * @package SPIP\NOIZETIER\API\ICONE
     85 * @package SPIP\NOIZETIER\ICONE\API
    7186 * @api
    7287 * @filtre
     
    98113 * ou d'un objet.
    99114 *
     115 * @package SPIP\NOIZETIER\BLOC\API
    100116 * @api
    101117 * @filtre
     
    143159        }
    144160
    145         return (isset($blocs_compteur[$page_ou_objet]) ? $blocs_compteur[$page_ou_objet] : array());
    146 }
    147 
    148 // Cette balise renvoie la description complète ou l'info donnée d'un bloc
     161        return (isset($blocs_compteur[$page_ou_objet])
     162                ? $blocs_compteur[$page_ou_objet]
     163                : array());
     164}
     165
     166/**
     167 * Compile la balise `#NOIZETIER_BLOC_INFOS` qui fournit un champ ou tous les champs descriptifs d'un bloc Z
     168 * donné. Ces champs sont lus dans le fichier YAML du bloc si il existe.
     169 * La signature de la balise est : `#NOIZETIER_BLOC_INFOS{bloc, information}`.
     170 *
     171 * @package SPIP\NOIZETIER\BLOC\BALISE
     172 * @balise
     173 *
     174 * @example
     175 *     ```
     176 *     #NOIZETIER_BLOC_INFOS{content}, renvoie tous les champs descriptifs du bloc content
     177 *     #NOIZETIER_BLOC_INFOS{content, nom}, renvoie le titre du bloc content
     178 *     ```
     179 * @param Champ $p
     180 *        Pile au niveau de la balise.
     181 *
     182 * @return Champ
     183 *         Pile complétée par le code à générer.
     184 **/
    149185function balise_NOIZETIER_BLOC_INFOS_dist($p) {
    150186        $bloc = interprete_argument_balise(1, $p);
     
    157193}
    158194
     195/**
     196 * @param string $bloc
     197 * @param string $information
     198 *
     199 * @return array|string
     200 */
    159201function calculer_infos_bloc($bloc = '', $information = '') {
    160202
     
    168210// -------------------------------------------------------------------
    169211
    170 // Cette balise renvoie le tableau de la liste des objets possédant des noisettes configurées
     212/**
     213 * Compile la balise `#NOIZETIER_PAGE_INFOS` qui fournit un champ ou tous les champs descriptifs d'une page
     214 * ou d'une composition donnée. Ces champs sont lus dans la table `spip_noizetier_pages`.
     215 * La signature de la balise est : `#NOIZETIER_PAGE_INFOS{page, information}`.
     216 *
     217 * @package SPIP\NOIZETIER\PAGE\BALISE
     218 * @balise
     219 *
     220 * @example
     221 *     ```
     222 *     #NOIZETIER_PAGE_INFOS{article}, renvoie tous les champs descriptifs de la page article
     223 *     #NOIZETIER_PAGE_INFOS{article, nom}, renvoie le titre de la page article
     224 *     #NOIZETIER_PAGE_INFOS{article-forum, nom}, renvoie le titre de la composition forum de la page article
     225 *     ```
     226 *
     227 * @param Champ $p
     228 *        Pile au niveau de la balise.
     229 *
     230 * @return Champ
     231 *         Pile complétée par le code à générer.
     232 **/
    171233function balise_NOIZETIER_PAGE_INFOS_dist($p) {
    172234
     
    184246}
    185247
     248/**
     249 * @param        $page
     250 * @param string $information
     251 *
     252 * @return array
     253 */
    186254function calculer_infos_page($page, $information = '') {
    187255
     
    195263// --------------------------------------------------------------------
    196264
    197 // Cette balise renvoie le tableau de la liste des objets possédant des noisettes configurées
     265/**
     266 * Compile la balise `#NOIZETIER_OBJET_INFOS` qui fournit un champ ou tous les champs descriptifs d'un objet
     267 * donné. Ces champs sont lus dans la table de l'objet.
     268 * La signature de la balise est : `#NOIZETIER_OBJET_INFOS{type_objet, id_objet, information}`.
     269 *
     270 * @package SPIP\NOIZETIER\OBJET\BALISE
     271 * @balise
     272 *
     273 * @example
     274 *     ```
     275 *     #NOIZETIER_OBJET_INFOS{article, 12}, renvoie tous les champs descriptifs de la page article
     276 *     #NOIZETIER_OBJET_INFOS{article, 12, nom}, renvoie le titre de la page article
     277 *     ```
     278 *
     279 * @param Champ $p
     280 *        Pile au niveau de la balise.
     281 *
     282 * @return Champ
     283 *         Pile complétée par le code à générer.
     284 **/
    198285function balise_NOIZETIER_OBJET_INFOS_dist($p) {
    199286
     
    213300}
    214301
     302/**
     303 * @param        $objet
     304 * @param        $id_objet
     305 * @param string $information
     306 *
     307 * @return mixed
     308 */
    215309function calculer_infos_objet($objet, $id_objet, $information = '') {
    216310
     
    220314
    221315
    222 // Cette balise renvoie le tableau de la liste des objets possédant des noisettes configurées
     316/**
     317 * Compile la balise `#NOIZETIER_OBJET_LISTE` qui renvoie la liste des objets possédant des noisettes
     318 * configurées. Chaque objet est fourni avec sa description complète.
     319 * La signature de la balise est : `#NOIZETIER_OBJET_LISTE`.
     320 *
     321 * @balise
     322 *
     323 * @param Champ $p
     324 *        Pile au niveau de la balise.
     325 *
     326 * @return Champ
     327 *         Pile complétée par le code à générer.
     328 **/
    223329function balise_NOIZETIER_OBJET_LISTE_dist($p) {
    224330
     
    229335}
    230336
     337/**
     338 * @return array|string
     339 */
    231340function calculer_liste_objets() {
    232341
     
    255364 *              `true` si la configuration a été modifiée, `false` sinon.
    256365 */
    257  // TODO : a voir si cette fonction n'est pas utilisée pour les noisettes on la renommera en noizetier_page_modifiee()
    258366function noizetier_configuration_est_modifiee($entite, $identifiant) {
    259367
     368        // TODO : a voir si cette fonction n'est pas utilisée pour les noisettes on la renommera en noizetier_page_modifiee()
    260369        $est_modifiee = true;
    261370
Note: See TracChangeset for help on using the changeset viewer.