Docs For Class pns

Description

PortableNotespace User

A PortableNotespace user class. Not to be constructed/made manually. Use with PortableNotespace. Serialized vars parts/componment of pns_db.

Located in /notespace.lib.php (line 35)

Variable Summary

Array(string) $customfields

string $pass

string $user

Method Summary

void __construct (string $user, string $pass, [Array(string) $flds = array()])

void __destruct ()

void del_field (string $field)

string get_field (string $f)

string get_passwd ()

string get_username ()

void set_field (string $field, string $val)

void set_passwd (string $passwd, [string $type = 'sha256'])

Variables

Array(string) $customfields (line 59)

Array of custom fields

string $pass (line 53)

The password of the user, in raw format

The password of the user. By default, the password is encrypted with sha256. You can change this in the setup program. Incompactible passwords when migrating databases will cause many problems.

string $user (line 42)

The username of the user

Methods

Constructor __construct (line 73)

Creates a new user

Creates a new user using the specified info.

void __construct (string $user, string $pass, [Array(string) $flds = array()])

string $user: The username of the new user
string $pass: The password of the new user, see pass
Array(string) $flds: Custom fields of the new user

Destructor __destruct (line 86)

Called when a user is destroyed/deleted

Not currently in use.

void __destruct ()

del_field (line 161)

Delete a custom field

Delete a custom field permanently

void del_field (string $field)

string $field: The field to remove

get_field (line 122)

Returns the specified field

Returns the specified field from the custom fields.

return: The resulting field

string get_field (string $f)

string $f: The field to return

get_passwd (line 110)

Returns the hashed password

Returns the hashed password of this user. See pass for more information.

return: The hashed password of this user

string get_passwd ()

get_username (line 98)

Returns the username

Returns the username of this user

return: The username of this user

string get_username ()

set_field (line 149)

Sets a field's value

Set the specified field's value

void set_field (string $field, string $val)

string $field: The field to set
string $val: The value to set to the field

set_passwd (line 136)

Sets the password

Sets the password with the password type

void set_passwd (string $passwd, [string $type = 'sha256'])

string $passwd: The password to set
string $type: The type of hash

Class pns_user