Changeset 70318 in spip-zone


Ignore:
Timestamp:
Mar 1, 2013, 9:00:51 PM (6 years ago)
Author:
marcimat@…
Message:

PHPdoc et 2 notices.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • _core_/plugins/sites/action/editer_site.php

    r69328 r70318  
    1111\***************************************************************************/
    1212
     13/**
     14 * Gestion de l'action editer__site et de l'API d'édition d'un site
     15 *
     16 * @package SPIP\Sites\Edition
     17 */
     18 
    1319if (!defined("_ECRIRE_INC_VERSION")) return;
    1420
    15 // http://doc.spip.org/@action_editer_site_dist
     21
     22/**
     23 * Action d'édition d'un site dans la base de données dont
     24 * l'identifiant est donné en paramètre de cette fonction ou
     25 * en argument de l'action sécurisée
     26 *
     27 * Si aucun identifiant n'est donné, on crée alors un nouvel article,
     28 * à condition que la rubrique parente (id_rubrique) puisse être obtenue
     29 * (avec _request(id_parent))
     30 *
     31 * @uses site_inserer()
     32 * @uses site_modifier()
     33 *
     34 * @param null|int $arg
     35 *     Identifiant du site. En absence utilise l'argument
     36 *     de l'action sécurisée.
     37 * @return array
     38 *     Liste (identifiant du site, Texte d'erreur éventuel)
     39 */
    1640function action_editer_site_dist($arg=null) {
    1741
     
    4165
    4266/**
    43  * Inserer un nouveau site en base
    44  *
    45  * http://doc.spip.org/@insert_syndic
    46  *
    47  * @param  $id_rubrique
    48  * @return bool
     67 * Insérer un nouveau site en base
     68 *
     69 * @pipeline_appel pre_insertion
     70 * @pipeline_appel post_insertion
     71 *
     72 * @param int $id_rubrique
     73 *     Identifiant de rubrique parente
     74 * @return int
     75 *     Identifiant du site créé
    4976 */
    5077function site_inserer($id_rubrique) {
     
    97124 * Modifier un site
    98125 *
    99  * $c est un contenu (par defaut on prend le contenu via _request())
    100  *
    101  * @param int $id_syndic
     126 * Appelle toutes les fonctions de modification d'un site
     127 *
     128 * @uses objet_modifier_champs()
     129 * @uses objet_instituer()
     130 *
     131 * @param int $id_syndic
     132 *     Identifiant du site à modifier
    102133 * @param array|bool $set
    103  * @return string
     134 *     Couples (colonne => valeur) de données à modifier.
     135 *     En leur absence, on cherche les données dans les champs éditables
     136 *     qui ont été postés (via collecter_requests())
     137 * @return string
     138 *     - Chaîne vide si aucune erreur,
     139 *     - Chaîne contenant un texte d'erreur sinon.
    104140 */
    105141function site_modifier($id_syndic, $set=false) {
     
    129165        // Si le site est publie, invalider les caches et demander sa reindexation
    130166        $t = sql_getfetsel("statut", "spip_syndic", "id_syndic=".intval($id_syndic));
     167        $invalideur = $indexation = false;
    131168        if ($t == 'publie') {
    132169                $invalideur = "id='site/$id_syndic'";
     
    159196
    160197
     198// Fonctions Dépréciées
     199// --------------------
     200
     201/**
     202 * Insérer un site
     203 *
     204 * @deprecated Utiliser site_inserer()
     205 * @uses site_inserer()
     206 *
     207 * @param int $id_rubrique
     208 * @return int
     209**/
    161210function insert_syndic($id_rubrique) {
    162211        return site_inserer($id_rubrique);
    163212}
     213
     214/**
     215 * Modifier un site
     216 *
     217 * @deprecated Utiliser site_modifier()
     218 * @uses site_modifier()
     219 *
     220 * @param int $id_syndic
     221 * @param array|bool $set
     222 * @return string
     223**/
    164224function syndic_set($id_syndic, $set=false) {
    165225        return site_modifier($id_syndic,$set);
    166226}
    167 // http://doc.spip.org/@revisions_sites
     227
     228/**
     229 * Créer une révision d'un site
     230 *
     231 * @deprecated Utiliser site_modifier()
     232 * @uses site_modifier()
     233 *
     234 * @param int $id_syndic
     235 * @param array|bool $set
     236 * @return string
     237**/
    168238function revisions_sites($id_syndic, $set=false){
    169239        return site_modifier($id_syndic,$set);
    170240}
     241
     242/**
     243 * Instituer un site
     244 *
     245 * @deprecated Utiliser objet_instituer()
     246 * @uses objet_instituer()
     247 *
     248 * @param int $id_syndic
     249 * @param array $c
     250 * @param bool $calcul_rub
     251 * @return string
     252**/
    171253function instituer_syndic($id_syndic, $c, $calcul_rub=true){
    172254        include_spip('action/editer_objet');
Note: See TracChangeset for help on using the changeset viewer.