Queste sono le differenze tra la revisione selezionata e la versione attuale della pagina.
Both sides previous revision Previous revision Next revision | Previous revision | ||
users [21/05/2010 14:38] |
users [05/06/2013 17:08] (versione attuale) |
||
---|---|---|---|
Linea 3: | Linea 3: | ||
//class UsersApiController extends ApiController//\\ | //class UsersApiController extends ApiController//\\ | ||
\\ | \\ | ||
- | * getRegTypesForUser - Ritorna la stringa con il tipo di registrazione di quell'utente. | + | === _auth === |
- | //Descrizione//: | + | Verifica che l'utente sia registrato.\\ |
- | string getRegTypesForUser($id) | + | Descrizione: //_auth($username, $password)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $password - string | ||
+ | Return: string o 'false' | ||
- | * getUserByRegFieldValue - Ritorna gli utenti con un certo tipo di registrazione. | + | === _delete === |
- | //Descrizione//: | + | Cancella l'utente.\\ |
- | getUserByRegFieldValue($key, $value) | + | Descrizione: //_delete($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: boolean | ||
- | * getRegFieldsForUser - Ritorna i campi della registrazione per quel determinato utente. | + | === _edit === |
- | //Descrizione//: | + | Modifica la password dell'utente.\\ |
- | array getRegFieldsForUser($id) | + | Descrizione: //_edit($username, $data)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: boolean | ||
- | * checkRegFields - Ritorna i campi per la registrazione. | + | === _execute === |
- | //Descrizione//: | + | Esegue sull'utente l'azione passata come parametro.\\ |
- | checkRegFields($id) | + | Descrizione: //_execute($action, $username, $data)//\\ |
+ | Parametri: | ||
+ | * $action - string | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: boolean | ||
- | * _getUserData - Richiede le informazioni di un utente. | + | === _getUserData === |
- | //Descrizione//: | + | Richiede le informazioni di un utente.\\ |
- | _getUserData($username) | + | Descrizione: //_getUserData($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: string o 'false' | ||
- | * _insert - Inserisci un utente. | + | === _insert === |
- | //Descrizione//: | + | Inserisci un utente.\\ |
- | _insert($username, $data) | + | Descrizione: //_insert($username, $data)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: boolean | ||
- | * _edit - Modifica la password dell'utente. | + | === auth === |
- | //Descrizione//: | + | Autenticazione attraverso nome utente e data.\\ |
- | _edit($username, $data) | + | Descrizione: //auth($username, $data)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: void | ||
- | * _delete - Cancella l'utente. | + | === checkRegFields === |
- | //Descrizione//: | + | Ritorna i campi per la registrazione.\\ |
- | _delete($username) | + | Descrizione: //checkRegFields($id)//\\ |
+ | Parametri: $id - int\\ | ||
+ | Return: string | ||
- | * _auth - Verifica che l'utente sia registrato. | + | === check_idpc_auth === |
- | //Descrizione//: | + | ...\\ |
- | _auth($username, $password) | + | Descrizione: //check_idpc_auth($samlresponse, $assertion_consumer)//\\ |
+ | Parametri: | ||
+ | * $samlresponse - string | ||
+ | * $assertion_consumer - string | ||
+ | Return: array | ||
- | * completeUsername - Ritorna l'username completo. | + | === completeUsername === |
- | //Descrizione//: | + | Ritorna l'username completo.\\ |
- | completeUsername($username) | + | Descrizione: //completeUsername($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: string | ||
- | * userDomain - Ritorna il dominio dell'utente. | + | === delete === |
- | //Descrizione//: | + | Richiama in una sola volta la execute e la delete.\\ |
- | userDomain($username) | + | Descrizione: //delete($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: void | ||
- | * userUserpart - | + | === edit === |
- | //Descrizione//: | + | Richiama in una sola volta la execute e la edit.\\ |
- | userUserpart($username) | + | Descrizione: //edit($username,$data)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: void | ||
- | * loadUsersPlugin - | + | === getRegFieldsForUser === |
- | //Descrizione//: | + | Ritorna i campi della registrazione per quel determinato utente.\\ |
- | loadUsersPlugin($fullname) | + | Descrizione: //getRegFieldsForUser($id)//\\ |
+ | Parametri: $id - int\\ | ||
+ | Return: array | ||
- | * getUsersPluginForUser - | + | === getRegTypesForUser === |
- | //Descrizione//: | + | Ritorna la stringa con il tipo di registrazione di quell'utente.\\ |
- | getUsersPluginForUser($username) | + | Descrizione: //getRegTypesForUser($id)//\\ |
+ | Parametri: $id - int\\ | ||
+ | Return: string | ||
- | * _execute - Esegue sull'utente l'azione passata come parametro. | + | === getUserByRegFieldValue === |
- | //Descrizione//: | + | Ritorna gli utenti con un certo tipo di registrazione.\\ |
- | _execute($action, $username, $data = array()) | + | Descrizione: //getUserByRegFieldValue($key, $value)//\\ |
+ | Parametri: | ||
+ | * $key - string | ||
+ | * $value - string | ||
+ | Return: array | ||
- | * getUserData - Richiama in una sola volta la execute e le getUserData per ottenere info sull'utente. | + | === getUserData === |
- | //Descrizione//: | + | Richiama in una sola volta la execute e le getUserData per ottenere info sull'utente.\\ |
- | getUserData($username) | + | Descrizione: //getUserData($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: void | ||
- | * getUserDataById - Richiede informazioni su un utente tramite il suo id. | + | === getUserDataByEmail === |
- | //Descrizione//: | + | Richiede informazioni su un utente tramite la sua email.\\ |
- | getUserDataById($id) | + | Descrizione: //getUserDataByEmail($email)//\\ |
+ | Parametri: $email - string\\ | ||
+ | Return: array | ||
- | * getUserDataByEmail - Richiede informazioni su un utente tramite la sua email. | + | === getUserDataById === |
- | //Descrizione//: | + | Richiede informazioni su un utente tramite il suo id.\\ |
- | getUserDataByEmail($email) | + | Descrizione: //getUserDataById($id)//\\ |
+ | Parametri: $id - int\\ | ||
+ | Return: array | ||
- | * insert - Richiama in una sola volta la execute e la insert. | + | === getUsersPluginForUser === |
- | //Descrizione//: | + | ...\\ |
- | insert($username,$data) | + | Descrizione: //getUsersPluginForUser($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: string | ||
- | * edit - Richiama in una sola volta la execute e la edit. | + | === insert === |
- | //Descrizione//: | + | Richiama in una sola volta la execute e la insert.\\ |
- | edit($username,$data) | + | Descrizione: //insert($username,$data)//\\ |
+ | Parametri: | ||
+ | * $username - string | ||
+ | * $data - array | ||
+ | Return: void | ||
- | * delete - Richiama in una sola volta la execute e la delete. | + | === loadUsersPlugin === |
- | //Descrizione//: | + | ...\\ |
- | delete($username) | + | Descrizione: //loadUsersPlugin($fullname)//\\ |
+ | Parametri: $fullname - string\\ | ||
+ | Return: string o 'null' | ||
- | * auth - Autenticazione attraverso nome utente e data. | + | === permissionsGetActions === |
- | //Descrizione//: | + | Ritorna un array con le azioni prodotte dal modulo.\\ |
- | auth($username, $data) | + | Descrizione: //permissionsGetActions()//\\ |
+ | Parametri: nessun parametro\\ | ||
+ | Return: array | ||
- | * check_idpc_auth - | + | === permissionsGetObjects === |
- | //Descrizione//: | + | Ritorna un array con gli oggetti prodotti dal modulo.\\ |
- | check_idpc_auth($samlresponse, $assertion_consumer) | + | Descrizione: //permissionsGetObjects()//\\ |
+ | Parametri: nessun parametro\\ | ||
+ | Return: array | ||
- | * permissionsGetSubjects - Ritorna un array con i soggetti prodotti dal modulo. | + | === permissionsGetSubject === |
- | //Descrizione//: | + | Contenitore del permissionsGetSubjects().\\ |
- | permissionsGetSubjects() | + | Descrizione: //permissionsGetSubject()//\\ |
+ | Parametri: nessun parametro\\ | ||
+ | Return: string | ||
- | * permissionsGetObjects - Ritorna un array con gli oggetti prodotti dal modulo. | + | === permissionsGetSubjects === |
- | //Descrizione//: | + | Ritorna un array con i soggetti prodotti dal modulo.\\ |
- | permissionsGetObjects() | + | Descrizione: //permissionsGetSubjects()//\\ |
+ | Parametri: \\ | ||
+ | Return: | ||
- | * permissionsGetActions - Ritorna un array con le azioni prodotte dal modulo. | + | === registerMenuItems === |
- | //Descrizione//: | + | Ritorna i simboli di registrazione del menu.\\ |
- | permissionsGetActions() | + | Descrizione: //registerMenuItems()//\\ |
+ | Parametri: nessun parametro\\ | ||
+ | Return: string | ||
- | * permissionsGetSubject - Contenitore del permissionsGetSubjects(). | + | === userDomain === |
- | //Descrizione//: | + | Ritorna il dominio dell'utente.\\ |
- | permissionsGetSubject() | + | Descrizione: //userDomain($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: string | ||
- | * registerMenuItems - Ritorna i simboli di registrazione del menu. | + | === userUserpart === |
- | //Descrizione//: | + | ...\\ |
- | registerMenuItems() | + | Descrizione: //userUserpart($username)//\\ |
+ | Parametri: $username - string\\ | ||
+ | Return: string | ||
- | * whoIsMyParent - Ritorna i moduli a cui appartiene il modulo users. | + | === whoIsMyParent === |
- | //Descrizione//: | + | Ritorna i moduli a cui appartiene il modulo users.\\ |
- | whoIsMyParent($data) | + | Descrizione: //whoIsMyParent($data)//\\ |
+ | Parametri: $data - array\\ | ||
+ | Return: array |