mojavi
[ class tree: mojavi ] [ index: mojavi ] [ all elements ]
Packages:
mojavi


Files:
Action.class.php
ActionChain.class.php
Appender.class.php
Controller.class.php
ExecutionChain.class.php
ExecutionFilter.class.php
Filter.class.php
FilterChain.class.php
FilterList.class.php
Layout.class.php
Logger.class.php
LogManager.class.php
Message.class.php
Renderer.class.php
Request.class.php
User.class.php
Validator.class.php
ValidatorManager.class.php
View.class.php

Classes:
Action
ActionChain
Appender
Controller
ExecutionChain
ExecutionFilter
Filter
FilterChain
FilterList
Layout
Logger
LogManager
Message
Renderer
Request
User
Validator
ValidatorManager
View

Class: User

Source Location: /User.class.php

Class Overview




User provides a clean interface to a single user, which allows for easy  manipulation of attributes and security related data.




Author(s):


    
                
  • Sean Kerr
    • 
      





        







Methods

















Inherited Variables





Inherited Methods














Class Details



[line 20]

User provides a clean interface to a single user, which allows for easy  manipulation of attributes and security related data.





Tags:





  

    since:  1.0
  

  

    author:  Sean Kerr
  










[ Top ]








Class Methods



  

	
	
constructor User [line 65]

	

    

    

		User &User(
)
    

    


	
		Create a new User instance.





Tags:





  

    since:  1.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method clearAll [line 81]

	

    

    

		void clearAll(
)
    

    


	
		Clear all user data.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method clearAttributes [line 98]

	

    

    

		void clearAttributes(
)
    

    


	
		Clear all attribute namespaces and their associated attributes.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getAttribute [line 118]

	

    

    

		mixed &getAttribute(
string
$name, [string
$namespace = 'org.mojavi'])
    

    


	
		Retrieve an attribute.





Tags:





  

    return:  An attribute value, if the given attribute exists,                otherwise NULL.
  

  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $name  
        An attribute name.
      

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method getAttributeNames [line 143]

	

    

    

		array getAttributeNames(
[mixed
$namespace = 'org.mojavi'])
    

    


	
		Retrieve an indexed array of attribute names.





Tags:





  

    return:  An array of attribute names, if the given namespace exists,                otherwise NULL.
  

  

    since:  1.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getAttributeNamespaces [line 160]

	

    

    

		array getAttributeNamespaces(
)
    

    


	
		Retrieve an indexed array of attribute namespaces.





Tags:





  

    return:  An array of attribute namespaces.
  

  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method getAttributes [line 180]

	

    

    

		array &getAttributes(
string
$namespace, [bool
$create = FALSE])
    

    


	
		Retrieve an associative array of namespace attributes.





Tags:





  

    return:  An array of attributes, if the given namespace exists,                otherwise NULL.
  

  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $namespace  
        An attribute namespace.
      

          

        bool  
        $create  
        Whether or not to auto-create the attribute namespace                if it doesn't already exist.
      

        

    


        
[ Top ]

  

  

	
	
method getContainer [line 209]

	

    

    

		Container &getContainer(
)
    

    


	
		Retrieve the container.





Tags:





  

    return:  A Container instance.
  

  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method hasAttribute [line 228]

	

    

    

		bool hasAttribute(
string
$name, [string
$namespace = 'org.mojavi'])
    

    


	
		Determine if the user has an attribute.





Tags:





  

    return:  TRUE, if the given attribute exists, otherwise               FALSE.
  

  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $name  
        An attribute name.
      

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method isAuthenticated [line 246]

	

    

    

		bool isAuthenticated(
)
    

    


	
		Determine the authenticated status of the user.





Tags:





  

    return:  TRUE, if the user is authenticated, otherwise               FALSE.
  

  

    since:  1.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method load [line 265]

	

    

    

		void load(
)
    

    


	
		Load data from the container.



<note>      This method should never be called manually.  </note>





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  

  

	
	
method mergeAttributes [line 286]

	

    

    

		void mergeAttributes(
array
$attributes)
    

    


	
		Merge a new set of attributes with the existing set.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        array  
        $attributes  
        An associative array of attributes.
      

        

    


        
[ Top ]

  

  

	
	
method removeAttribute [line 333]

	

    

    

		mixed &removeAttribute(
string
$name, [string
$namespace = 'org.mojavi'])
    

    


	
		Remove an attribute.





Tags:





  

    return:  An attribute value, if the given attribute exists and has                been removed, otherwise NULL.
  

  

    since:  1.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $name  
        An attribute name.
      

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method removeAttributes [line 361]

	

    

    

		void removeAttributes(
[string
$namespace = 'org.mojavi'])
    

    


	
		Remove an attribute namespace and all associated attributes.





Tags:





  

    since:  1.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method setAttribute [line 379]

	

    

    

		void setAttribute(
string
$name, mixed
$value, [string
$namespace = 'org.mojavi'])
    

    


	
		Set an attribute.





Tags:





  

    since:  1.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $name  
        An attribute name.
      

          

        mixed  
        $value  
        An attribute value.
      

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method setAttributeByRef [line 397]

	

    

    

		void setAttributeByRef(
string
$name, mixed
&$value, [string
$namespace = 'org.mojavi'])
    

    


	
		Set an attribute by reference.





Tags:





  

    since:  1.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        string  
        $name  
        An attribute name.
      

          

        mixed  
        &$value  
        An attribute value.
      

          

        string  
        $namespace  
        An attribute namespace.
      

        

    


        
[ Top ]

  

  

	
	
method setAuthenticated [line 413]

	

    

    

		void setAuthenticated(
bool
$status)
    

    


	
		Set the authenticated status of the user.





Tags:





  

    since:  1.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        bool  
        $status  
        The authentication status.
      

        

    


        
[ Top ]

  

  

	
	
method setContainer [line 428]

	

    

    

		void setContainer(
Container
&$container)
    

    


	
		Set the container.





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
Parameters:

    

    

          

        Container  
        &$container  
        A Container instance.
      

        

    


        
[ Top ]

  

  

	
	
method store [line 447]

	

    

    

		void store(
)
    

    


	
		Store data in the container.



<note>      This method should never be called manually.  </note>





Tags:





  

    since:  2.0
  

  

    access:  public
  












        
[ Top ]

  





        

		    

		    Documentation generated on Wed, 15 Jun 2005 11:43:45 +0900 by phpDocumentor 1.2.3