Quinoa
[ class tree: Quinoa ] [ index: Quinoa ] [ all elements ]

Class: Quinoa_Auth

Source Location: /Quinoa/Auth.php

Class Overview

Quinoa_Serializable
   |
   --Quinoa_Auth

Quinoa_Auth class.


Author(s):

Version:

  • 0.0.21 2007-09-23

Copyright:

  • 2007

Variables

Methods


Inherited Methods

Class: Quinoa_Serializable

Quinoa_Serializable::getClassesFiles()
Gets all necessary files for all classes in the class hierarchy and above it.

Class Details

[line 48]
Quinoa_Auth class.

Quinoa_Auth class. Represents a user and its authentication status. The class is configured in the config.xml where the database, table, user field, password field, aes_encrypt key are all defined. Based on this settings the class can log the user and be kept in a Quinoa_Session, since it is a Quinoa_Serializible. PHP version 5.x Copyright (c) 2007, Freeconcept, Lda. All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the name of the Freeconcept, Lda. nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.




Tags:

since:  File available since Release 0.0.1
link:  http://www.quinoaframework.org
version:  0.0.21 2007-09-23
copyright:  2007
author:  Marcello Duarte <marcello.duarte@gmail.com>


[ Top ]


Class Variables

$_database =

[line 56]

database used for authentication

database used for authentication




Tags:

access:  protected

Type:   string


[ Top ]

$_isLogged =

[line 98]

Whether user is logged

Whether user is logged




Tags:

access:  protected

Type:   boolean


[ Top ]

$_passField =

[line 77]

password field used for authentication

password field used for authentication




Tags:

access:  protected

Type:   string


[ Top ]

$_password =

[line 91]

password sent and confirmed at login time

password sent and confirmed at login time




Tags:

access:  protected

Type:   string


[ Top ]

$_table =

[line 63]

table used for authentication

table used for authentication




Tags:

access:  protected

Type:   string


[ Top ]

$_userField =

[line 70]

user field used for authentication

user field used for authentication




Tags:

access:  protected

Type:   string


[ Top ]

$_username =

[line 84]

username sent and confirmed at login time

username sent and confirmed at login time




Tags:

access:  protected

Type:   string


[ Top ]



Class Methods


constructor __construct [line 106]

Quinoa_Auth __construct( string $username, string $password)

Constructs the Quinoa_Auth object

Constructs the Quinoa_Auth object




Tags:

access:  public


Parameters:

string   $username  
string   $password  

[ Top ]

method getUsername [line 170]

string getUsername( )

username get accessor

username get accessor




Tags:

access:  public


[ Top ]

method isLogged [line 160]

boolean isLogged( )

Checks whether user is logged

Checks whether user is logged




Tags:

access:  public


[ Top ]

method log [line 137]

void log( )

Logs the user

Logs the user




Tags:

access:  public


[ Top ]


Documentation generated on Wed, 03 Oct 2007 14:25:23 +0100 by phpDocumentor 1.3.0RC3