Zikula: A Flexible Open Source Content Management System
home | forum | international support | contact us

Docs For Class SecurityUtil

[ class tree: Zikula_Core ] [ index: Zikula_Core ] [ all elements ] [ Todo List ]

Class: SecurityUtil

Source Location: /pnobjlib/SecurityUtil.class.php

Class Overview



SecurityUtil


Author(s):


    
        





    







Methods











Inherited Variables



Inherited Methods







Class Details



[line 19]
SecurityUtil







Tags:





  

    author:  Drak
  








[ Top ]







Class Methods



  

	
	
method checkPermission [line 30]

	

    

    

		bool checkPermission(
[string
$component = null], [string
$instance = null], [string
$level = null], [string
$user = null])
    

    


	
		Check permissions











        
Parameters:

    

    

          

        string  
        $component  
        
      

          

        string  
        $instance  
        
      

          

        string  
        $level  
        
      

          

        string  
        $user  
        
      

        

    


        
[ Top ]

  

  

	
	
method checkSignedData [line 374]

	

    

    

		mixed checkSignedData(
string
$data)
    

    


	
		verify signed data object







Tags:





  

    return:  array or string of data if true or bool false if false
  










        
Parameters:

    

    

          

        string  
        $data  
        of serialized $data
      

        

    


        
[ Top ]

  

  

	
	
method confirmAuthKey [line 85]

	

    

    

		bool confirmAuthKey(
[string
$modname = ''], [string
$varname = 'authid'])
    

    


	
		confirm auth key











        
Parameters:

    

    

          

        string  
        $modname  
        
      

          

        string  
        $varname  
        
      

        

    


        
[ Top ]

  

  

	
	
method generateAuthKey [line 136]

	

    

    

		string generateAuthKey(
[string
$modname = ''])
    

    


	
		generate auth key







Tags:





  

    return:  an encrypted key for use in authorisation of operations
  










        
Parameters:

    

    

          

        string  
        $modname  
        module name
      

        

    


        
[ Top ]

  

  

	
	
method getAuthInfo [line 168]

	

    

    

		array getAuthInfo(
[unknown_type
$user = null])
    

    


	
		get auth info







Tags:





  

    return:  two element array of user and group permissions
  










        
Parameters:

    

    

          

        unknown_type  
        $user  
        
      

        

    


        
[ Top ]

  

  

	
	
method getSecurityLevel [line 250]

	

    

    

		int getSecurityLevel(
array
$perms, string
$component, string
$instance)
    

    


	
		get security level







Tags:





  

    return:  matching security level
  










        
Parameters:

    

    

          

        array  
        $perms  
        
      

          

        string  
        $component  
        
      

          

        string  
        $instance  
        
      

        

    


        
[ Top ]

  

  

	
	
method registerPermissionSchema [line 71]

	

    

    

		bool registerPermissionSchema(
string
$component, string
$schema)
    

    


	
		register a permission schema











        
Parameters:

    

    

          

        string  
        $component  
        
      

          

        string  
        $schema  
        
      

        

    


        
[ Top ]

  

  

	
	
method signData [line 357]

	

    

    

		serialized signData(
unknown_type
$data)
    

    


	
		sign data object leaving data clearly visible







Tags:





  

    return:  string of signed data
  










        
Parameters:

    

    

          

        unknown_type  
        $data  
        
      

        

    


        
[ Top ]

  




	





		  
Packages:

      

							
Files:

		




				
				
Classes: