Class Person

The main person/user class for the framework.

Alpha\Model\Person

Namespace: Alpha\Model
Copyright:

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 Alpha Framework 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 HOLDER 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.

License: The BSD License
Author: John Collins dev@alphaframework.org
Since: 1.0
Located at Model/Person.php

Methods summary

`public`	# `__construct( )` Constructor for the class that populates all of the complex types with default values. Constructor for the class that populates all of the complex types with default values. Since 1.0 Overrides `Alpha\Model\ActiveRecord::__construct`
`protected`	# `after_load_callback( )` Set up the transient attributes for the rights group after it has loaded. Set up the transient attributes for the rights group after it has loaded. Since 1.0
`protected`	# `after_loadByAttribute_callback( )` Set up the transient attributes for the site after it has loaded. Set up the transient attributes for the site after it has loaded. Since 1.0
`protected`	# `after_save_callback( )` Looks up the ID for the Standard rights group, then relates the new person to that group if they are not in it already. If that group does not exist it will be recreated! Looks up the ID for the Standard rights group, then relates the new person to that group if they are not in it already. If that group does not exist it will be recreated! Since 1.0
`protected`	# `before_save_callback( )` Encrypts password value if it is plaintext before saving. Encrypts password value if it is plaintext before saving. Since 2.0
`protected`	# `setupRels( )` Sets up the Relation definitions on this record. Sets up the Relation definitions on this record. Since 1.0
`public`	# `setUsername( string $username )` Setter for username. Setter for username. Parameters `$username` Since 1.0
`public Alpha\Model\Type\SmallText`	# `getUsername( )` Getter for username. Getter for username. Returns `Alpha\Model\Type\SmallText` Since 1.0
`public boolean`	# `inGroup( string $groupName )` Checks to see if the person is in the rights group specified. Checks to see if the person is in the rights group specified. Parameters `$groupName` Returns boolean Since 1.0
`public`	# `addToGroup( string $groupName )` Adds this person to the rights group specified. Adds this person to the rights group specified. Parameters `$groupName` Throws `Alpha\Exception\RecordNotFoundException` Since 2.0
`public`	# `sendMail( string $message, string $subject )` A generic method for mailing a person. A generic method for mailing a person. Parameters `$message` `$subject` Throws `Alpha\Exception\MailNotSentException` Since 1.0
`public string`	# `generatePassword( )` Generates a random password for the user. Generates a random password for the user. Returns string Since 1.0
`public integer`	# `getCommentCount( )` Method for getting a count of the amount of article comments posted by the user. Method for getting a count of the amount of article comments posted by the user. Returns integer Since 1.0

Methods inherited from Alpha\Model\ActiveRecord

__wakeup(), addProperty(), addToCache(), backupDatabase(), begin(), cast(), checkDatabaseExists(), checkRecordExists(), checkRecordTableExists(), checkTableExists(), checkTableNeedsUpdate(), commit(), createDatabase(), createForeignIndex(), createUniqueIndex(), delete(), deleteAllByAttribute(), disconnect(), dropDatabase(), dropTable(), findMissingFields(), get(), getCount(), getCreateTS(), getCreatorId(), getDataLabel(), getDataLabels(), getDefaultAttributes(), getFriendlyClassName(), getHistoryCount(), getID(), getIndexes(), getLastQuery(), getMAX(), getMaintainHistory(), getPersistentAttributes(), getPropObject(), getRecordClassNames(), getTableName(), getTaggedAttributes(), getTransientAttributes(), getUniqueAttributes(), getUpdateTS(), getUpdatorId(), getVersion(), getVersionNumber(), hasAttribute(), isInstalled(), isTableOverloaded(), isTagged(), isTransient(), load(), loadAll(), loadAllByAttribute(), loadAllByAttributes(), loadAllByDayUpdated(), loadAllFieldValuesByAttribute(), loadAllOldVersions(), loadByAttribute(), loadClassDef(), loadFromCache(), makeHistoryTable(), makeTable(), markPersistent(), markTransient(), markUnique(), populateFromArray(), query(), rebuildTable(), reload(), removeFromCache(), rollback(), save(), saveAttribute(), saveHistory(), saveRelations(), set(), setDataLabels(), setEnumOptions(), setID(), setLastQuery(), setMaintainHistory(), toArray(), validate()

Constants summary

`string`	`TABLE_NAME` The name of the database table for the class. The name of the database table for the class. Since 1.0	# `'Person'`

Properties summary

`protected Alpha\Model\Type\SmallText`	`$username` The forum display name of the person. The forum display name of the person. Since 1.0	#
`protected Alpha\Model\Type\SmallText`	`$email` The email address for the person. The email address for the person. Since 1.0	#
`protected Alpha\Model\Type\SmallText`	`$password` The password for the person. The password for the person. Since 1.0	#
`protected Alpha\Model\Type\Relation`	`$rights` A Relation containing all of the rights groups that this person belongs to. A Relation containing all of the rights groups that this person belongs to. Since 1.0	#
`protected Alpha\Model\Type\Relation`	`$actions` A Relation containing all of the actions carried out by this person. A Relation containing all of the actions carried out by this person. Since 1.2.2	#
`protected array`	`$dataLabels` An array of data display labels for the class properties. An array of data display labels for the class properties. Since 1.0	# `array('ID' => 'Member ID#', 'username' => 'Username', 'email' => 'E-mail Address', 'password' => 'Password', 'state' => 'Account state', 'URL' => 'Your site address', 'rights' => 'Rights Group Membership', 'actions' => 'Actions',)`
`protected Aplha\Model\Type\Enum`	`$state` The state of the person (account status). The state of the person (account status). Since 1.0	#
`protected Alpha\Model\Type\SmallText`	`$URL` The website URL of the person. The website URL of the person. Since 1.0	#

Properties inherited from Alpha\Model\ActiveRecord

$ID, $created_by, $created_ts, $defaultAttributes, $lastQuery, $transientAttributes, $uniqueAttributes, $updated_by, $updated_ts, $version_num

Namespaces

Classes

Interfaces

Class Person

Methods summary

Since

Overrides

Since

Since

Since

Since

Since

Parameters

Since

Returns

Since

Parameters

Returns

Since

Parameters

Throws

Since

Parameters

Throws

Since

Returns

Since

Returns

Since

Methods inherited from Alpha\Model\ActiveRecord

Constants summary

Since

Properties summary

Since

Since

Since

Since

Since

Since

Since

Since

Properties inherited from Alpha\Model\ActiveRecord