Changeset 546


Ignore:
Timestamp:
02/22/06 00:28:59 (7 years ago)
Author:
anarcat
Message:

[project @ alternc: changeset 2005-03-05 17:00:49 by said]
Autres modifs et mises à jour de la doc API (anglais + Doxygen) :

Original author: said
Date: 2005-03-05 17:00:49

File:
1 edited

Legend:

Unmodified
Added
Removed

  • bureau/class/m_admin.php

    r540 r546  
    11<?php 
    22/* 
    3  $Id: m_admin.php,v 1.8 2005/03/05 16:27:30 said Exp $ 
     3 $Id: m_admin.php,v 1.9 2005/03/05 17:00:49 said Exp $ 
    44 ---------------------------------------------------------------------- 
    55 LICENSE 
    … …  
    2929* Copyleft {@link http://alternc.net/ AlternC Team} 
    3030* 
    31 * @copyright    AlternC-Team 2002-11-01 http://alternc.net/ 
    3231* 
    3332*/ 
    … …  
    199198   * the account $mid is not super-admin. 
    200199   * 
    201    * @param string $login Login name like [a-z][a-z0-9]* 
    202    * @param string $pass Password (max. 64 characters) 
    203    * @param string $nom Name of the account owner 
    204    * @param string $prenom First name of the account owner 
    205    * @param string $mail Email address of the account owner, useful to get 
     200   * @param $login string Login name like [a-z][a-z0-9]* 
     201   * @param $pass string Password (max. 64 characters) 
     202   * @param $nom string Name of the account owner 
     203   * @param $prenom string First name of the account owner 
     204   * @param $mail string Email address of the account owner, useful to get 
    206205   * one's lost password 
    207206   * @return boolean Returns FALSE if an error occurs, TRUE if not. 
    … …  
    212211   * si le compte $mid n'est pas super-admin 
    213212   *  
    214    * @param string $login Nom d'utilisateur, de la forme [a-z][a-z0-9]* 
    215    * @param string $pass Mot de passe, maxi 64 caractères 
    216    * @param string $nom Nom de la personne ou structure 
    217    * @param string $prenom Prénom de la personne ou structure 
    218    * @param string $mail Adresse email du propriétaire du compte, permet de récupérer son mot de passe 
     213   * @param $login Nom d'utilisateur, de la forme [a-z][a-z0-9]* 
     214   * @param $pass Mot de passe, maxi 64 caractères 
     215   * @param $nom Nom de la personne ou structure 
     216   * @param $prenom Prénom de la personne ou structure 
     217   * @param $mail Adresse email du propriétaire du compte, permet de récupérer son mot de passe 
    219218   * @return boolean Retourne FALSE si une erreur s'est produite, TRUE sinon. 
    220219   * 
    … …  
    281280   * the account $mid is not super-admin. 
    282281   * 
    283    * @param integer $uid the uid number of the account we want to modify 
    284    * @param string login new login name like [a-z][a-z0-9]* 
    285    * @param string $pass new password (max. 64 characters) 
    286    * @param string $nom new name of the account owner 
    287    * @param string $prenom new first name of the account owner 
    288    * @param string $mail new email address of the account owner 
    289    * @param integer $enabled (value: 0 or 1) activates or desactivates the 
     282   * @param $uid integer the uid number of the account we want to modify 
     283   * @param login string new login name like [a-z][a-z0-9]* 
     284   * @param $pass string new password (max. 64 characters) 
     285   * @param $nom string new name of the account owner 
     286   * @param $prenom string new first name of the account owner 
     287   * @param $mail string new email address of the account owner 
     288   * @param $enabled integer (value: 0 or 1) activates or desactivates the 
    290289   * access to the virtual desktop of this account. 
    291290   * @return boolean Returns FALSE if an error occurs, TRUE if not. 
    … …  
    296295   * si le compte $mid n'est pas super-admin 
    297296   * 
    298    * @param integer $uid Numéro uid de l'utilisateur que l'on souhaite modifier. 
    299    * @param string $mail Nouvelle adresse email 
    300    * @param string $nom $prenom Nouveaux nom et prénom de l'utilisateur 
    301    * @param string $pass Nouveau mot de passe. 
    302    * @param flag $enabled vaut 0 ou 1, active ou désactive l'accès au bureau virtuel de ce compte. 
     297   * @param $uid integer Numéro uid de l'utilisateur que l'on souhaite modifier. 
     298   * @param $mail string Nouvelle adresse email 
     299   * @param $nom $prenom string Nouveaux nom et prénom de l'utilisateur 
     300   * @param $pass string Nouveau mot de passe. 
     301   * @param $enabled integer vaut 0 ou 1, active ou désactive l'accès au bureau virtuel de ce compte. 
    303302   * @return boolean Retourne FALSE si une erreur s'est produite, TRUE sinon. 
    304303   *  
    … …  
    336335   * the account $mid is not super-admin. 
    337336   * 
    338    * @param integer $uid the uid number of the account we want to delete 
     337   * @param $uid integer the uid number of the account we want to delete 
    339338   * @return boolean Returns FALSE if an error occurs, TRUE if not. 
    340339   * 
    … …  
    343342   *  
    344343   * Supprime le membre spécifié. Refuse l'utilisation de l'objet si le compte $mid n'est pas super-admin 
    345    * @param integer $uid Numéro du membre à supprimer. 
    346    * @return boolean Retourne FALSE si une erreur s'est produite, TRUE sinon. 
     344   * @param $uid Numéro du membre à supprimer. 
     345   * @return Retourne FALSE si une erreur s'est produite, TRUE sinon. 
    347346   * 
    348347   */ 
    … …  
    386385   * Turns a common account into a super-admin account 
    387386   * 
    388    * @param $uid the uid number of the common account we want to turn into a 
     387   * @param $uid integer the uid number of the common account we want to turn into a 
    389388   *  super-admin account. 
    390389   * @return Returns FALSE if an error occurs, TRUE if not. 
    … …  
    393392   * Transforme un membre Normal en membre Administrateur 
    394393   * 
    395    * @param integer $uid Numéro du compte à transformer 
    396    * @return boolean Retourne FALSE si une erreur s'est produite. 
     394   * @param $uid Numéro du compte à transformer 
     395   * @return Retourne FALSE si une erreur s'est produite. 
    397396   * 
    398397   */ 
    … …  
    416415   * Turns a super-admin account into a common account 
    417416   * 
    418    * @param integer $uid the uid number of the super-admin account we want to turn into a 
     417   * @param $uid integer the uid number of the super-admin account we want to turn into a 
    419418   * common account. 
    420419   * @return boolean Returns FALSE if an error occurs, TRUE if not. 
    … …  
    502501   * Lock (or unlock) a domain, so that the member will be (not be) able to delete it 
    503502   * from its account 
    504    * @param string $dom string Domain name to lock / unlock 
     503   * @param $dom string Domain name to lock / unlock 
    505504   * @return boolean TRUE if the domain has been locked/unlocked or FALSE if it does not exist. 
    506505   */ 
    … …  
    521520   * Add a new TLD to the list of the authorized TLDs  
    522521   * 
    523    * @param string $tld top-level domain to add (org, com...) 
    524    * @param integer $mode number of the authorized mode (0 to 5) 
     522   * @param $tld string top-level domain to add (org, com...) 
     523   * @param $mode integer number of the authorized mode (0 to 5) 
    525524   * @return boolean TRUE if the tld has been successfully added, FALSE if not. 
    526525   * 
    … …  
    528527   * Ajoute un nouveau TLD autorisé à la liste des tld autorisés. 
    529528   *  
    530    * @param string $tld Top-Level Domain à ajouter (org, com ...) 
    531    * @param integer $mode Numéro du mode autorisé (0->5) 
    532    * @return booleen True si le tld a bien été ajouté, False sinon. 
     529   * @param $tld Top-Level Domain à ajouter (org, com ...) 
     530   * @param $mode Numéro du mode autorisé (0->5) 
     531   * @return boolean True si le tld a bien été ajouté, False sinon. 
    533532   *  
    534533   */  
    … …  
    547546   * Prints the list of the actually authorized TLDs 
    548547   * 
    549    * @param integer $current Value to select in the list 
     548   * @param $current integer Value to select in the list 
    550549   *  
    551550   * Affiche (echo) la liste déroulante des TLD actuellement autorisés.  
    552551   *  
    553    * @param integer $current Valeur par défaut à sélectionner dans la liste 
     552   * @param $current Valeur par défaut à sélectionner dans la liste 
    554553   *  
    555554   */ 
    … …  
    568567   * on this TLD 
    569568   * 
    570    * @param string $tld 
    571    * 
    572    * 
     569   * @param $tld string The TLD you want to delete 
     570   * @return boolean returns true if the TLD has been deleted, or 
     571   * false if an error occured. 
    573572   * 
    574573   * 
    … …  
    577576   * <b>Note</b> : Cela ne supprime pas les domaines utilisant ce TLD ! 
    578577   *  
    579    * @param string $tld TLD que l'on souhaite détruire 
     578   * @param $tld TLD que l'on souhaite détruire 
    580579   * @return boolean retourne true si le TLD a bien été effacé, false sinon 
    581580   *  
    … …  
    594593  /* ----------------------------------------------------------------- */ 
    595594  /** 
     595   * Add a TLD to the list of the authorized TLDs during the 
     596   * installation 
     597   * 
     598   * @param $tld string TLD we want to authorize 
     599   * @param $mode integer Controls to make on this TLD. 
     600   * <b>Note: </b> If you check in the whois, be sure that 
     601   *  <code>m_domains</code> knows how to name the whois of the specified 
     602   *  domain ! 
     603   * @return boolean TRUE if the TLD has been successfully 
     604   *  added. FALSE if not. 
     605   * 
     606   * 
     607   * 
    596608   * Ajoute un TLD à la liste des TLD autorisés à l'installation 
    597609   *  
    598    * @param string $tld TLD que l'on souhaite autoriser.  
    599    * @param integer $mode Contrôles à effectuer sur ce TLD. <b>Note : </b>  
     610   * @param $tld TLD que l'on souhaite autoriser.  
     611   * @param $mode Contrôles à effectuer sur ce TLD. <b>Note : </b>  
    600612   *  Si vous demandez le controle dans le Whois, assurez-vous que m_domains 
    601613   *  connaisse bien comment appeler le whois du domaine correspondant ! 
    … …  
    623635  /* ----------------------------------------------------------------- */ 
    624636  /** 
     637   * Modify a TLD of the list of the authorized TLDs  
     638   * 
     639   * @param $tld string TLD we want to modify 
     640   * @param $mode integer Controls to make on this TLD. 
     641   * @return boolean TRUE if the TLD has been successfully 
     642   * modified. FALSE if not. 
     643   * 
     644   * 
    625645   * Modifie un TLD autorisé de la liste des tld autorisés. 
    626646   *  
    627    * @param string $tld Top-Level Domain à modifier (org, com ...) 
    628    * @param integer $mode Numéro du mode autorisé (0->5) 
    629    * @return booleen True si le tld a bien été modifié, False sinon. 
     647   * @param $tld Top-Level Domain à modifier (org, com ...) 
     648   * @param $mode Numéro du mode autorisé (0->5) 
     649   * @return boolean True si le tld a bien été modifié, False sinon. 
    630650   *  
    631651   */ 
Note: See TracChangeset for help on using the changeset viewer.