contenido\classes\class.conuser.php

Show:

inherited

Classes
- \ConUser

Table of Contents

Project: Contenido Content Management System

Description: This class will be a replacement for all other user classes, which encapsulates only small parts of user related tasks.

In current version you can administer optional password checks via following configuration values:

En- or disabling checks: $cfg['password']['check_password_mask'] = [true|false] Use this flag to enable (true) or disable (false) the mask checks.

$cfg['password']['use_cracklib'] = [true|false] Use this to enable (true) or disable (false) the strength check, currently done with cracklib.
Mask checks: Password mask checks are checks belonging to the "format" of the needed password string.

$cfg['password']['min_length'], int Minimum length a password has to have. If not set, 8 chars are set as default $cfg['password']['numbers_mandatory'], int If set to a value greater than 0, at least $cfg['password']['numbers_mandatory'] numbers must be in password $cfg['password']['symbols_mandatory'], int && $cfg['password']['symbols_regex'], String If 'symbols_mandatory' set to a value greater than 0, at least so many symbols has to appear in given password. What symbols are regcognized can be administrated via 'symbols_regex'. This has to be a regular expression which is used to "find" the symbols in $sNewPassword. If not set, following RegEx is used: "/[|!@#$%&*\/=?,;.:-_+~^�\]/" $cfg['password']['mixed_case_mandatory'], int If set to a value greater than 0 so many lower and upper case character must appear in the password. (e.g.: if set to 2, 2 upper and 2 lower case characters must appear)
Strength check Passwords should have some special characteristics to be a strong, i.e. not easy to guess, password. Currently cracklib is supported. These are the configuration possibilities:

$cfg['password']['cracklib_dict'], string Path and file name (without file extension!) to dictionary you want to use. This setting is mandatory!

Keep in mind that these type of check only works if crack module is available.

Author: Bilal Arslan, Holger Librenz
Copyright: four for business AG {@internal created 04.11.2008 modified 2008-11-16, H. Librenz - added structure, comments fixed, code debugged modified 2008-11-21, H. Librenz - some documentation stuff added modified 2008-11-25, Timo Trautman - removed not existing include modified 2008-12-04, Bilal Arslan, Bugfixed for set passwort length, comments "how to use" fixed. Bugfixed for password, lower Case Upper case count, for symbols count and numbers count. modified 2008-12-04, Timo Trautman, Added Contenido $cfg as param for getErrorString() modified 2011-02-26, Ortwin Pinke, added unset for pw-request-marker, changed header svn-id and version declaration $Id:$ }}
Package: Contenido Backend classes
Subpackage: Backend User
Version: 1.4.0

\ConUser
jump to top

Package: Contenido Backend classes\Backend user

Project: Contenido Content Management System

Description: Class User to handle all user related task. In first implementations, it will only do some little things, like checking and setting passwords.

Requirements:

Parent(s): \ConUser_Abstract
Author: Bilal Arslan, Holger Librenz
Con_php_req: 5.0
Copyright: four for business AG
License: http://www.contenido.org/license/LIZENZ.txt
Link: http://www.4fb.de
Link: http://www.contenido.org
Since: file available since contenido release => 4.8.8
Version: 0.2.0

Constants

int 
                PASS_OK
                = 0

inherited

Password is ok and stored.

Inherited from: \iConUser::PASS_OK \ConUser_Abstract::PASS_OK

Final
Inherited_from: \iConUser::PASS_OK
Inherited_from: \ConUser_Abstract::PASS_OK
: int

int 
                PASS_TO_SHORT
                = 1

inherited

Given password is to short

Inherited from: \iConUser::PASS_TO_SHORT \ConUser_Abstract::PASS_TO_SHORT

Final
Inherited_from: \iConUser::PASS_TO_SHORT
Inherited_from: \ConUser_Abstract::PASS_TO_SHORT
: int

int 
                PASS_NOT_STRONG
                = 2

inherited

Given password is not strong enough

Inherited from: \iConUser::PASS_NOT_STRONG \ConUser_Abstract::PASS_NOT_STRONG

Final
Inherited_from: \iConUser::PASS_NOT_STRONG
Inherited_from: \ConUser_Abstract::PASS_NOT_STRONG
: int

int 
                PASS_NOT_COMPLEX
                = 3

inherited

Given password is not complex enough

Inherited from: \iConUser::PASS_NOT_COMPLEX \ConUser_Abstract::PASS_NOT_COMPLEX

Final
Inherited_from: \iConUser::PASS_NOT_COMPLEX
Inherited_from: \ConUser_Abstract::PASS_NOT_COMPLEX
: int

int 
                PASS_NOT_ENOUGH_NUMBERS
                = 4

inherited

Password does not contain enough numbers.

Inherited from: \iConUser::PASS_NOT_ENOUGH_NUMBERS \ConUser_Abstract::PASS_NOT_ENOUGH_NUMBERS

Final
Inherited_from: \iConUser::PASS_NOT_ENOUGH_NUMBERS
Inherited_from: \ConUser_Abstract::PASS_NOT_ENOUGH_NUMBERS
: int

int 
                PASS_NOT_ENOUGH_SYMBOLS
                = 5

inherited

Password does not contain enough symbols.

Inherited from: \iConUser::PASS_NOT_ENOUGH_SYMBOLS \ConUser_Abstract::PASS_NOT_ENOUGH_SYMBOLS

Final
Inherited_from: \iConUser::PASS_NOT_ENOUGH_SYMBOLS
Inherited_from: \ConUser_Abstract::PASS_NOT_ENOUGH_SYMBOLS
: int

int 
                PASS_NOT_ENOUGH_MIXED_CHARS
                = 6

inherited

Password does not contain enough mixed characters.

Inherited from: \iConUser::PASS_NOT_ENOUGH_MIXED_CHARS \ConUser_Abstract::PASS_NOT_ENOUGH_MIXED_CHARS

Final
Inherited_from: \iConUser::PASS_NOT_ENOUGH_MIXED_CHARS
Inherited_from: \ConUser_Abstract::PASS_NOT_ENOUGH_MIXED_CHARS
: int

int 
                PASS_NOT_ENOUGH_DIFFERENT_CHARS
                = 7

inherited

Password does not contain enough different characters.

Inherited from: \iConUser::PASS_NOT_ENOUGH_DIFFERENT_CHARS \ConUser_Abstract::PASS_NOT_ENOUGH_DIFFERENT_CHARS

Final
Inherited_from: \iConUser::PASS_NOT_ENOUGH_DIFFERENT_CHARS
Inherited_from: \ConUser_Abstract::PASS_NOT_ENOUGH_DIFFERENT_CHARS
: int

int 
                EXCEPTION_USERNAME_EXISTS
                = 8

inherited

Exception code, which is used if you try to add an user that already exists.

Inherited from: \iConUser::EXCEPTION_USERNAME_EXISTS \ConUser_Abstract::EXCEPTION_USERNAME_EXISTS

Final
Inherited_from: \iConUser::EXCEPTION_USERNAME_EXISTS
Inherited_from: \ConUser_Abstract::EXCEPTION_USERNAME_EXISTS
: int

int 
                EXCEPTION_PASSWORD_INVALID
                = 9

inherited

Exception code, which is used if an password is set to save that is not valid.

Inherited from: \iConUser::EXCEPTION_PASSWORD_INVALID \ConUser_Abstract::EXCEPTION_PASSWORD_INVALID

Final
Inherited_from: \iConUser::EXCEPTION_PASSWORD_INVALID
Inherited_from: \ConUser_Abstract::EXCEPTION_PASSWORD_INVALID
: int

 
                MIN_PASS_LENGTH_DEFAULT
                = 8

inherited

This value will be used if no minimum length for passwords are set via $cfg['password']['min_length']

Inherited from: \iConUser::MIN_PASS_LENGTH_DEFAULT \ConUser_Abstract::MIN_PASS_LENGTH_DEFAULT

Inherited_from: \iConUser::MIN_PASS_LENGTH_DEFAULT
Inherited_from: \ConUser_Abstract::MIN_PASS_LENGTH_DEFAULT

Properties

array $aAddress = array()

Array of address data fill like below values

$aAddress['street'], $aAddress['city'], $aAddress['country'], $aAddress['zip']

Default valuearray()Details

Type: array

array $aCfg = null

inherited

Contenido configuration array

Inherited from: \ConUser_Abstract::$$aCfg

Default valuenullDetails

Type: array
Inherited_from: \ConUser_Abstract::$$aCfg

int $iUseTiny = null

To Use Tiny Editor

Default valuenullDetails

Type: int

\DB_Contenido $oDb = null

inherited

Referemces database abstraction instance

Inherited from: \ConUser_Abstract::$$oDb

Default valuenullDetails

Type: \DB_Contenido
Inherited_from: \ConUser_Abstract::$$oDb

string $sMail = ""

Mail address

Default value""Details

Type: string

\unknown_type $sPassword = null

inherited

Holds the password which should be set.

Inherited from: \ConUser_Abstract::$$sPassword

Default valuenullDetails

Type: \unknown_type
Inherited_from: \ConUser_Abstract::$$sPassword

string $sPermName = ""

Permname

Default value""Details

Type: string

string $sRealName = ""

Realname

Default value""Details

Type: string

string $sTelNumber = ""

Telephone number

Default value""Details

Type: string

string $sUserId = null

inherited

current User ID

Inherited from: \ConUser_Abstract::$$sUserId

Default valuenullDetails

Type: string
Inherited_from: \ConUser_Abstract::$$sUserId

string $sUserName = null

inherited

Inherited from: \ConUser_Abstract::$$sUserName

Default valuenullDetails

Type: string
Inherited_from: \ConUser_Abstract::$$sUserName

string $sValidDateFrom = null

User valid date from

Default valuenullDetails

Type: string

string $sValidDateTo = null

User valid date to

Default valuenullDetails

Type: string

Methods

__construct(array $aCfg, $oDb = null, $sUserId = null) : \ConUser

Calls constructor in base class.

Checks given values and initializes class.

Parameters

Name	Type	Description
$aCfg	array
$oDb
$sUserId

Returns

Type	Description
\ConUser

Throws

Exception	Description
\ConUserException

checkPasswordMask(string $sNewPassword) : int

Following configuration values are recognized: $this->aCfg['password']['check_password_mask'], bool En- or disable these checks.

.. $this->aCfg['password']['min_length'], int Minimum length a password has to have. If not set, 8 chars are set as default $this->aCfg['password']['numbers_mandatory'], int If set to a value greater than 0, at least $this->aCfg['password']['numbers_mandatory'] numbers must be in password $this->aCfg['password']['symbols_mandatory'], int && $this->aCfg['password']['symbols_regex'], String If 'symbols_mandatory' set to a value greater than 0, at least so many symbols has to appear in given password. What symbols are regcognized can be administrated via 'symbols_regex'. This has to be a regular expression which is used to "find" the symbols in $sNewPassword. If not set, following RegEx is used: "/[|!@#$%&*\/=?,;.:-_+~^�\]/" $this->aCfg['password']['mixed_case_mandatory'], int If set to a value greater than 0 so many lower and upper case character must appear in the password. (e.g.: if set to 2, 2 upper and 2 lower case characters must appear)

Parameters

Name	Type	Description
$sNewPassword	string

Returns

Type	Description
int

checkPasswordStrength(string $sNewPassword) : int

This password checks the password strength.

In "standard" implementation, it uses cracklib, if administrated and available. Other possible checks are checks against user list with birth dates or similar, non direct "maskable" checks.

Following configuration values are recognized: $this->aCfg['password']['use_cracklib'], bool En- or disable these checks... $this->aCfg['password']['cracklib_dict'], string Path and file name (without file extension!) to dictionary you want to use. This setting is mandatory!

Please ensure that you have a working crack module installed. If the function crack_opendict is not available, the check are omitted and the result is iConUser::PASS_OK.

Parameters

Name	Type	Description
$sNewPassword	string

Returns

Type	Description
int

encodePassword(string $sPassword) : string

static

{@see iConUser::encodePassword()}

You should use one-way encodings or hash-algorithms to ensure that nobody can read simply the passwords!

Parameters

Name	Type	Description
$sPassword	string

Returns

Type	Description
string

generateUserId() : string

inherited

Generates new user id based on current user name.

Inherited from: \ConUser_Abstract::generateUserId()

Returns

Type	Description
string

getAddressData() : string

Getter method to get user adress data

Returns

Type	Description
string	Realname of user

getErrorString(int $iErrorCode, array $aCfg) : string

static

This static method provides a simple way to get error messages depending on error code $iErrorCode, which is returned by checkPassword* methods.

Parameters

Name	Type	Description
$iErrorCode	int
$aCfg	array	Contenido configuration array

Returns

Type	Description
string

getMail() : string

Getter method to get user mail

Returns

Type	Description
string	Realname of user

getPassword() : string

inherited

Returns (unencoded!) password.

Inherited from: \ConUser_Abstract::getPassword()

This method should never be public available!

Returns

Type	Description
string

getPerms() : string

Getter method to get user perm name

Returns

Type	Description
string	Realname of user

getRealName() : string

Getter method to get user realname

Returns

Type	Description
string	Realname of user

getTelNumber() : string

Getter method to get user tel number

Returns

Type	Description
string	Realname of user

getUseTiny() : string

Getter method to get user wysi

Returns

Type	Description
string	Realname of user

getUserId() : string

inherited

Returns user id, currently set.

Inherited from: \ConUser_Abstract::getUserId()

Returns

Type	Description
string

getUserName() : string

inherited

Returns user name, currently set

Inherited from: \ConUser_Abstract::getUserName()

Returns

Type	Description
string

getValidDateFrom() : string

Getter method to get user valid date from-to

Returns

Type	Description
string	Realname of user

getValidDateTo() : string

Getter method to get user valid date from-to

Returns

Type	Description
string	Realname of user

insert() : boolean

Creates new user.

This method creates a new user with base informations. It is called within the iConUser::save() method.

Returns

Type	Description
boolean

Details

Todo: add value checks!

load(string $sUserId) : boolean

Currently not implemented!

Parameters

Name	Type	Description
$sUserId	string

Returns

Type	Description
boolean

Details

See: \ConUser_Abstract::load()
Todo: implement it

save() : boolean

This method tries to save all information collected for an user.

If everything is fine, it returns true - otherwise false. On fatal errors a ConUserException will be thrown.

Returns

Type	Description
boolean

Details

See: \ConUser_Abstract::save()

savePassword(string $sNewPassword) : int

This method saves the given password $sNewPassword.

The password has to be checked, before it is set to the database. The resulting integer value represents the result code. Use the PASS_* constants to check what happens.

Parameters

Name	Type	Description
$sNewPassword	string	Password to set

Returns

Type	Description
int

Throws

Exception	Description
\ConUserException

Details

See: The method uses following config values:

saveUser() : void

This function does update without password column to all columns of con_phplib_auth_user_md5 table.

setAddressData( $sAddressStreet, $sAddressCity, $sAddressZip, $sAddressCountry) : void

Setter method to set Adress Data

Parameters

Name	Type	Description
$sAddressStreet
$sAddressCity
$sAddressZip
$sAddressCountry

setCity(string $sCity) : void

Sets value for city.

Parameters

Name	Type	Description
$sCity	string

setCountry(string $sCountry) : void

Sets value for country.

Parameters

Name	Type	Description
$sCountry	string

setMail( $sMail) : void

Setter method to set user mail address

Parameters

Name	Type	Description
$sMail

setPassword(string $sPassword) : int

inherited

Checks password which has to be set and return PASS_* values (i.e.

Inherited from: \ConUser_Abstract::setPassword()

on success PASS_OK).

Parameters

Name	Type	Description
$sPassword	string

Returns

Type	Description
int

setPerms( $aPerms) : void

setter method to set

Parameters

Name	Type	Description
$aPerms

setRealName( $sRealName) : void

Setter method to set user real name

Parameters

Name	Type	Description
$sRealName

setStreet(string $sStreet) : void

Sets value for street.

Parameters

Name	Type	Description
$sStreet	string

setTelNumber( $sTelNumber) : void

setter method to set user tel number

Parameters

Name	Type	Description
$sTelNumber

setUseTiny( $iUseTiny) : void

Setter method to set

Parameters

Name	Type	Description
$iUseTiny

setUserId(\unknown_type $sUserId) : void

inherited

Sets user ID.

Inherited from: \ConUser_Abstract::setUserId()

Parameters

Name	Type	Description
$sUserId	\unknown_type	TODO check this

setUserName(string $sUserName) : void

inherited

Sets up new user name.

Inherited from: \ConUser_Abstract::setUserName()

Parameters

Name	Type	Description
$sUserName	string

setValidDateFrom( $sValidateFrom) : void

setter method to set

Parameters

Name	Type	Description
$sValidateFrom

setValidDateTo( $sValidateTo) : void

setter method to set User

Parameters

Name	Type	Description
$sValidateTo

setZip(string $sZip) : void

Sets value for ZIP.

Parameters

Name	Type	Description
$sZip	string

update() : boolean

Updates a user

This method update base user informations in user table. It is called within the iConUser::save() method.

Returns

Type	Description
boolean

Details

Todo: add type checks!

userExists( $sUserId) : boolean

Checks if an user with user id $sUserId already exists in DB.

Parameters

Name	Type	Description
$sUserId

Returns

Type	Description
boolean

usernameExists(string $sUsername) : boolean

Checks if username $sUsername is already in use.

Parameters

Name	Type	Description
$sUsername	string

Returns

Type	Description
boolean

Details

Todo: to be implemented

contenido\classes\class.conuser.php

\ConUserjump to top

Constants

Properties

Methods

\ConUser
jump to top