members
Packages
Interfaces
Classes
Files

Class: Group

Source Location: /members/groups.class.php [line 38]

Class Overview



This class provides methods to manage user in groups.

		

	    
Author(s):

	    
	




		





    

    
    

        
Methods

        
    

    		











Class Details


This class provides methods to manage user in groups.
    
Tags:

    

        
    




[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]



	

	
Class Methods

	
  

    
    
constructor Group [line 45]

    

    

    

        Group Group(

&$groups_info, array
$groups_info)
    

    

    
        
Constructor. Loads informations groups.

    
        
Parameters:

    

    

          

        array  
        $groups_info  
        Informations of all groups.
      

          

          
        &$groups_info  
        
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method add_member [line 58]

    

    

    

        boolean add_member(
int
$user_id, int
$idgroup)
    

    

    
        
Adds a member in a group
    
Tags:

    

        
  • return: True if the member has been succefully added.

    


    
        
Parameters:

    

    

          

        int  
        $user_id  
        User id
      

          

        int  
        $idgroup  
        Group id
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method edit_member [line 84]

    

    

    

        void edit_member(
int
$user_id, array
$array_user_groups)
    

    

    
        
Edits the user groups, compute difference between previous and new groups.

    
        
Parameters:

    

    

          

        int  
        $user_id  
        The user id
      

          

        array  
        $array_user_groups  
        The new array of groups.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method get_groups_array [line 113]

    

    

    

        array get_groups_array(
)
    

    

    
        
Returns the array of user groups (id => name)
    
Tags:

    

        
  • return: The array groups

    


    
        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  

  

    
    
method remove_member [line 123]

    

    

    

        void remove_member(
int
$user_id, int
$idgroup)
    

    

    
        
Removes a member in a group.

    
        
Parameters:

    

    

          

        int  
        $user_id  
        The user id
      

          

        int  
        $idgroup  
        The id group.
      

        

    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    

  

  





    

    
Class Variables

    
                    

                            
                [line 137]  
                mixed 
                $groups_auth 
                                                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
                

                            
                [line 136]  
                mixed 
                $groups_name 
                                                

                                

                                    

                    

        
[ Top ] - [ Class Details ] - [ Methods ] - [ Variables ]
    



            		
        

            

    
    
         
    

    
Documentation generated on Tue, 28 Jul 2009 22:43:38 +0200 by phpDocumentor 1.4.1



			

			
	        

				

 

 

Annonces