accounts::get_list(".print_r($_type,True).",start='$start',sort='$sort',order='$order',query='$query',offset='$offset')
\n"; @@ -336,6 +346,11 @@ return $account_list[$serial]['data']; } + /** + * test if the account this class is instanciated for is expired + * + * @return boolean true=expired (no more login possible), false otherwise + */ function is_expired() { if ($this->data['expires'] != -1 && $this->data['expires'] < time()) @@ -349,22 +364,30 @@ } /** - * Invalidate the cache (or parts of it) after change in $account_id - * - * Atm simplest approach - delete it all ;-) - */ + * Invalidate the cache (or parts of it) after change in $account_id + * + * Atm simplest approach - delete it all ;-) + */ function cache_invalidate($account_id) { //echo "accounts::cache_invalidate($account_id)
\n"; $GLOBALS['egw_info']['accounts']['cache'] = array(); } + /** + * saves the account-data in the internal data-structure of this class to the repository + */ function save_repository() { $this->cache_invalidate($this->account_id); accounts_::save_repository(); } + /** + * Deletes the account spezified by $accountid, deletes also all acl-entries for that account + * + * @param int $accountid numeric account-id + */ function delete($accountid) { $this->cache_invalidate($accountid); @@ -374,6 +397,12 @@ $GLOBALS['egw']->acl->delete_account($accountid); } + /** + * Create a new account with the given $account_info + * + * @param array data for the new account + * @return int new nummeric account-id + */ function create($account_info,$default_prefs=True) { $account_id = accounts_::create($account_info,$default_prefs); @@ -382,6 +411,11 @@ return $account_id; } + /** + * Reads the data of the account this class is instanciated for + * + * @return array with the internal data + */ function read_repository() { $this->setup_cache(); @@ -394,6 +428,13 @@ return $account_data[$this->account_id] = accounts_::read_repository(); } + /** + * Return data of the account this class is instanciated for + * + * only calls read_repository if no data read so far + * + * @return array with the internal data + */ function read() { if (count($this->data) == 0) @@ -405,6 +446,12 @@ return $this->data; } + /** + * copies the given $data into the internal array + * + * @param array with data + * @return array $this->data = $data + */ function update_data($data) { reset($data); @@ -415,6 +462,13 @@ return $this->data; } + /** + * Get all memberships of an account $accountid / groups the account is a member off + * + * @param int/string $accountid='' numeric account-id or alphanum. account-lid, + * default account of the user of this session + * @return array or arrays with keys 'account_id' and 'account_name' for the groups $accountid is a member of + */ function membership($accountid = '') { $this->setup_cache(); @@ -446,6 +500,13 @@ return $membership_list[$account_id] = $this->memberships; } + /** + * Get all members of the group $accountid + * + * @param int/string $accountid='' numeric account-id or alphanum. account-lid, + * default account of the user of this session + * @return array or arrays with keys 'account_id' and 'account_name' + */ function member($accountid = '') { $account_id = get_account_id($accountid); @@ -472,9 +533,11 @@ /** * Using the common functions next_id and last_id, find the next available account_id * - * @param $account_type (optional, default to 'u') + * NOTE: to my knowledge this is not used any more RalfBecker 2004/06/15 + * + * @deprecated + * @param $string $account_type='u' (optional, default to 'u') */ - // NOTE: to my knowledge this is not used any more RalfBecker 2004/06/15 function get_nextid($account_type='u') { $min = $GLOBALS['egw_info']['server']['account_min_id'] ? $GLOBALS['egw_info']['server']['account_min_id'] : 0; @@ -523,16 +586,15 @@ return $nextid; } - /** - * splits users and groups from a array of id's or the accounts with run-rights for a given app-name - * - * @param $app_users array of user-id's or app-name (if you use app-name the result gets cached!) - * @param $use string what should be returned only an array with id's of either 'accounts' or 'groups'. - * Or an array with arrays for 'both' under the keys 'groups' and 'accounts' or 'merge' for accounts - * and groups merged into one array - * @return see $use - */ + * splits users and groups from a array of id's or the accounts with run-rights for a given app-name + * + * @param array $app_users array of user-id's or app-name (if you use app-name the result gets cached!) + * @param string $use what should be returned only an array with id's of either 'accounts' or 'groups'. + * Or an array with arrays for 'both' under the keys 'groups' and 'accounts' or 'merge' for accounts + * and groups merged into one array + * @return array/boolean see $use, false on error (wront $use) + */ function split_accounts($app_users,$use='both') { if (!is_array($app_users)) @@ -593,6 +655,8 @@ /** * phpgw compatibility function, better use split_accounts + * + * @deprecated */ function return_members($accounts) { @@ -604,6 +668,13 @@ ); } + /** + * convert an alphanumeric account-value (account_lid, account_email) to the account_id + * + * @param string $name value to convert + * @param string $which='account_lid' type of $name: account_lid (default), account_email + * @return int/false numeric account_id or false on error ($name not found) + */ function name2id($name,$which='account_lid') { $this->setup_cache(); @@ -622,6 +693,13 @@ return $name_list[$which][$name] = accounts_::name2id($name,$which); } + /** + * convert an numeric account_id to any other value of that account (account_lid, account_email, ...) + * + * @param int $account_id numerica account_id + * @param string $which='account_lid' type to convert to: account_lid (default), account_email, ... + * @return string/false converted value or false on error ($account_id not found) + */ function id2name($account_id,$which='account_lid') { $this->setup_cache(); @@ -639,6 +717,13 @@ return $id_list[$account_id][$which] = accounts_::id2name($account_id,$which); } + /** + * get the type of an account: 'u' = user, 'g' = group + * + * @param int/string $accountid numeric account-id or alphanum. account-lid, + * if !$accountid account of the user of this session + * @return string/false 'u' = user, 'g' = group or false on error ($accountid not found) + */ function get_type($accountid) { $this->setup_cache(); @@ -662,6 +747,16 @@ return $account_type[$account_id] = accounts_::get_type($account_id); } + /** + * Gets account-name (lid), firstname and lastname of an account $accountid + * + * @param int/string $accountid='' numeric account-id or alphanum. account-lid, + * if !$accountid account of the user of this session + * @param string &$lid on return: alphanumeric account-name (lid) + * @param string &$fname on return: first name + * @param string &$lname on return: last name + * @return boolean true if $accountid was found, false otherwise + */ function get_account_name($accountid,&$lid,&$fname,&$lname) { $this->setup_cache(); @@ -685,6 +780,14 @@ return $Ok; } + /** + * Reads account-data for a given $account_id from the repository AND sets the class-vars with it + * + * Same effect as instanciating the class with that account, dont do it with $GLOBALS['egw']->account !!! + * + * @param int $accountid numeric account-id + * @return array with keys lid, firstname, lastname, fullname, type + */ function get_account_data($account_id) { $this->account_id = $account_id;