LiveUser
[ class tree: LiveUser ] [ index: LiveUser ] [ all elements ]
Packages:
LiveUser_Admin
LiveUser


Classes:
LiveUser_Admin
LiveUser_Admin_Auth_Common
LiveUser_Admin_Auth_DB
LiveUser_Admin_Auth_MDB
LiveUser_Admin_Auth_MDB2
LiveUser_Admin_Perm_Complex
LiveUser_Admin_Perm_Medium
LiveUser_Admin_Perm_Simple
LiveUser_Admin_Perm_Storage_MDB2
LiveUser_Admin_Storage
LiveUser_Admin_Storage_MDB2
LiveUser_Admin_Storage_SQL
Files:
Admin.php
Common.php
Complex.php
DB.php
MDB.php
MDB2.php
MDB2.php
MDB2.php
Medium.php
Simple.php
SQL.php
Storage.php

Class: LiveUser_Admin_Perm_Simple

Source Location: /LiveUser_Admin-0.1.0/Perm/Simple.php

Class Overview




This class provides a set of functions for implementing a user  permission management system on live websites. All authorisation  backends/containers must be extensions of this base class.




Author(s):






            
    

Version:


    
  
  • $Id: Simple.php,v 1.34 2004/12/20 13:25:48 dufuz Exp $
    • 









Methods















Child classes:






LiveUser_Admin_Perm_Medium

	
This class provides a set of functions for implementing a user  permission management system on live websites. All authorisation  backends/containers must be extensions of this base class.









Inherited Variables





Inherited Methods














Class Details



[line 39]

This class provides a set of functions for implementing a user  permission management system on live websites. All authorisation  backends/containers must be extensions of this base class.


    

  • Author: Bjoern Kraus <krausbn@php.net>
    • 

  • Author: Markus Wolff <wolff@21st.de>
    • 

  • Version: $Id: Simple.php,v 1.34 2004/12/20 13:25:48 dufuz Exp $
    • 









[ Top ]








Method Detail



	
	
LiveUser_Admin_Perm_Simple (Constructor)   [line 58]

	

    

    

		LiveUser_Admin_Perm_Simple LiveUser_Admin_Perm_Simple(

&$confArray)
    

    


	
		Class constructor. Feel free to override in backend subclasses.




        
Parameters:

    

    

          

          
        &$confArray  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addApplication   [line 265]

	

    

    

		void addApplication(
array
$data)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addArea   [line 187]

	

    

    

		void addArea(
array
$data)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addRight   [line 134]

	

    

    

		void addRight(
array
$data)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addTranslation   [line 375]

	

    

    

		void addTranslation(
array
$data)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
addUser   [line 82]

	

    

    

		void addUser(
array
$data)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
disconnect   [line 724]

	

    

    

		void disconnect(
)
    

    


	
		properly disconnect from resources


    

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getApplications   [line 525]

	

    

    

		void getApplications(
[array
$params = array()])
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getAreas   [line 510]

	

    

    

		void getAreas(
[array
$params = array()])
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getCurrentApplication   [line 253]

	

    

    

		string getCurrentApplication(
)
    

    


	
		Get current application


    

  • Return: name of the current application
    • 

  • Access: public
    • 








        
[ Top ]

  

  
  
	
	
getRights   [line 476]

	

    

    

		void getRights(
[array
$params = array()])
    

    


	
		


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
LiveUser_Admin_Perm_Complex::getRights()

		

	

	


        
Parameters:

    

    

          

        array  
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getTranslations   [line 540]

	

    

    

		void getTranslations(
[array
$params = array()])
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
getUsers   [line 443]

	

    

    

		void getUsers(
[array
$params = array()])
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $params  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
grantUserRight   [line 318]

	

    

    

		void grantUserRight(
array
$data)
    

    


	
		


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
LiveUser_Admin_Perm_Complex::grantUserRight()

		

	

	


        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
outputRightsConstants   [line 573]

	

    

    

		mixed outputRightsConstants(
string
$type, [array
$options = array()], [string
$mode = null])
    

    


	
		Generate the constants to a file or define them directly.
$mode can be either 'file' or 'php'. File will write the constant  in the given file, replacing/adding constants as needed. Php will  call define() function to actually define the constants.
$options can contain  'prefix'      => 'prefix_goes_here',  'area'        => 'specific area id to grab rights from',  'application' => 'specific application id to grab rights from'  'naming'      => LIVEUSER_SECTION_RIGHT for PREFIX_RIGHTNAME  <- DEFAULT                   LIVEUSER_SECTION_AREA for PREFIX_AREANAME_RIGHTNAME                   LIVEUSER_SECTION_APPLICATION for PREFIX_APPLICATIONNAME_AREANAME_RIGHTNAME  'filename'    => if $mode is file you must give the full path for the                   output file
If not prefix is given it will not be used to generate the constants


    

  • Return: boolean, array or DB Error object
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        string  
        $type  
        — 
        type of output (constant or array)
      

          

        array  
        $options  
        — 
        options for constants generation
      

          

        string  
        $mode  
        — 
        output mode desired (file or direct)
      

        

    


        
[ Top ]

  

  
  
	
	
removeApplication   [line 294]

	

    

    

		void removeApplication(
array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeArea   [line 216]

	

    

    

		void removeArea(
array
$filters)
    

    


	
		


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
LiveUser_Admin_Perm_Complex::removeArea()

		

	

	


        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeRight   [line 163]

	

    

    

		void removeRight(
array
$filters)
    

    


	
		


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
LiveUser_Admin_Perm_Medium::removeRight()

		

	

		

	
LiveUser_Admin_Perm_Complex::removeRight()

		

	

	


        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeTranslation   [line 404]

	

    

    

		void removeTranslation(
array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
removeUser   [line 115]

	

    

    

		void removeUser(
array
$filters)
    

    


	
		


    

  • Access: public
    • 







	
Overridden in child classes as:

		

	
LiveUser_Admin_Perm_Medium::removeUser()

		

	

		

	
LiveUser_Admin_Perm_Complex::removeUser()

		

	

	


        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
revokeUserRight   [line 361]

	

    

    

		void revokeUserRight(
array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
setCurrentApplication   [line 240]

	

    

    

		boolean setCurrentApplication(
integer
$applicationId)
    

    


	
		Set current application


    

  • Return: always true
    • 

  • Access: public
    • 








        
Parameters:

    

    

          

        integer  
        $applicationId  
        — 
        id of application
      

        

    


        
[ Top ]

  

  
  
	
	
updateApplication   [line 280]

	

    

    

		void updateApplication(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
updateArea   [line 202]

	

    

    

		void updateArea(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
updateRight   [line 149]

	

    

    

		void updateRight(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
updateTranslation   [line 390]

	

    

    

		void updateTranslation(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
updateUser   [line 101]

	

    

    

		void updateUser(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  
	
	
updateUserRight   [line 347]

	

    

    

		void updateUserRight(
array
$data, array
$filters)
    

    


	
		


    

  • Access: public
    • 








        
Parameters:

    

    

          

        array  
        $data  
        — 
        
      

          

        array  
        $filters  
        — 
        
      

        

    


        
[ Top ]

  

  
  



        

		    

		    Documentation generated on Mon, 11 Mar 2019 14:00:09 -0400 by phpDocumentor 1.4.4. PEAR Logo Copyright ©  PHP Group 2004.