Class TfishUser

User object class.

Represents a user. Since Tuskfish is a single-user system, this class will probably be deprecated in due course.

Package: user
Copyright: Simon Wilkinson 2013-2017 (https://tuskfish.biz)
License: GNU General Public License (GPL) V2
Author: Simon Wilkinson simon@isengard.biz
Version: Release: 1.0
Since: 1.0
Located at trust_path/libraries/tuskfish/class/TfishUser.php

Methods summary

`public mixed\|null`	# `__get( string $property )` Get the value of a property. Get the value of a property. Intercepts direct calls to access an object property. This method can be overridden to impose processing logic to the value before returning it. Parameters `$property` Name of property. Returns mixed\|null $property Value of property if it is set; otherwise null.
`public`	# `__set( string $property, mixed $value )` Set the value of a whitelisted property. Set the value of a whitelisted property. Intercepts direct calls to set the value of an object property. This method is overridden by child classes to impose data type restrictions and range checks before allowing the property to be set. Tuskfish objects are designed not to trust other components; each conducts its own internal validation checks. Parameters `$property` Name of property. `$value` Value of property.
`public boolean`	# `__isset( string $property )` Check if a property is set. Check if a property is set. Intercepts isset() calls to correctly read object properties. Can be overridden in child objects to add processing logic for specific properties. Parameters `$property` Name of property. Returns boolean True if set otherwise false.
`public boolean`	# `__unset( string $property )` Unsets a property. Unsets a property. Intercepts unset() calls to correctly unset object properties. Can be overridden in child objects to add processing logic for specific properties. Parameters `$property` Name of property. Returns boolean True on success, false on failure.

Properties summary

`protected array`	`$__data` $__data Array holding values of this object's properties. $__data Array holding values of this object's properties.	# `array( 'id', 'admin_email', 'password_hash', 'user_salt', 'user_group', 'yubikey_id', 'yubikey_id2', 'login_errors' )`

Magic properties

`public integer`	`$id` ID of this user
`public string`	`$admin_email` email address of this user
`public string`	`$password_hash`
`public integer`	`$user_group`

Packages

Classes

Class TfishUser

Methods summary

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Properties summary

Magic properties