Changeset 320

Show
Ignore:
Timestamp:
06/03/08 21:23:49 (6 months ago)
Author:
juank
Message:

avatars/trunk/lib/avatars_functions.php documentation

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved
  • avatars/trunk/lib/avatars_functions.php

    r318 r320  
    1212 
    1313 
     14/** 
     15 * 
     16 * avatars_gat_loggeduser_data function 
     17 * 
     18 * This function preperes the loggedin user data, to be used in the update 
     19 * and insert process 
     20 * 
     21 * 
     22 * @param: no param recived 
     23 * @return: an array with the user data available in the _SESION vars, null other wise 
     24 * 
     25 */ 
     26 
    1427function avatars_get_loggeduser_data() 
    1528{ 
     
    2437        return $user; 
    2538} 
     39 
     40 
     41/** 
     42 * 
     43 * avatars__loggeduser_create_usericon_folder function 
     44 * 
     45 * This function creates the user icon folder, available in the data/icons directory, 
     46 * in this directory, the news avatar will be saved.  
     47 * 
     48 * 
     49 * @param: array $user with the user data available in the _SESSION vars   
     50 * @return: void (the results of this function are evaluated in the index.php file) 
     51 * 
     52 */ 
     53 
    2654 
    2755function avatars_create_usericon_folder($user) 
     
    4068 
    4169} 
     70 
     71 
     72/** 
     73 * 
     74 * avatars_update_icon_user function 
     75 * 
     76 * This function creates a new record in the table "icons", and update the user record 
     77 * in the table "users" on the elgg's database 
     78 * 
     79 * 
     80 * @param: array $user with the user data available in the _SESSION vars   
     81 * @param: Int(11) $profile_id 
     82 * @return: void (the results of this function are evaluated in the index.php file) 
     83 * 
     84 */ 
     85 
    4286 
    4387function avatars_update_icon_user($user, $profile_id)