STAG - documentation
[ class tree: STAG - documentation ] [ index: STAG - documentation ] [ all elements ]

Class: CLogin

Source Location: /classes/clogin.php

Class Overview


classes for login/logout users, show users policy, etc.


Methods



Class Details

[line 10]
classes for login/logout users, show users policy, etc.



[ Top ]


Class Methods


constructor __construct [line 22]

BOOLEAN __construct( string $username, string $password)

this class connect to DB vali d username and return BOOLEAN which user is authorized



Tags:

return:  true if user is logged
access:  public


Parameters:

string   $username   Name of logged user
string   $password   Password of logged user

[ Top ]

method authorized [line 116]

BOOLEAN authorized( )

validate user. User is valid

returned value:

  • 1: user is validate
  • 0: user is not valid




Tags:

return:  true if user is authorized
access:  public


[ Top ]

method getPolicy [line 86]

string getPolicy( $data)



Tags:

return:  named value of policy from number value
access:  public


Parameters:

   $data  

[ Top ]

method info [line 64]

string info( string $info)

used for getting information about user from DB row

usable only when user is logged




Tags:

return:  with information
access:  public


Parameters:

string   $info  

[ Top ]

method link_policy [line 100]

string link_policy( )



Tags:

return:  for address bar by policy
access:  public


[ Top ]

method policy [line 73]

string policy( )



Tags:

return:  named value of policy from number value
access:  public


[ Top ]

method user_logout [line 127]

void user_logout( )

destroy session - logged out current user



Tags:

access:  public


[ Top ]


Documentation generated on Sat, 24 Jan 2009 19:10:31 +0100 by phpDocumentor 1.4.1