Merge pull request #2799 from yearofthegus/document-magic-members

Documented magic properties of DataObject
This commit is contained in:
Ingo Schommer 2014-01-30 18:26:23 -08:00
commit 124886a7f9
9 changed files with 85 additions and 0 deletions

View File

@ -61,6 +61,18 @@
*
* @package framework
* @subpackage filesystem
*
* @property string Name Basename of the file
* @property string Title Title of the file
* @property string Filename Filename including path
* @property string Content
* @property string ShowInSearch Boolean that indicates if file is shown in search. Doesn't apply to Folder
*
* @property int ParentID ID of parent File/Folder
* @property int OwnerID ID of Member who owns the file
*
* @method File Parent() Returns parent File
* @method Member Owner() Returns Member object of file owner.
*/
class File extends DataObject {

View File

@ -65,6 +65,11 @@
*
* @package framework
* @subpackage model
*
* @property integer ID ID of the DataObject, 0 if the DataObject doesn't exist in database.
* @property string ClassName Class name of the DataObject
* @property string LastEdited Date and time of DataObject's last modification.
* @property string Created Date and time of DataObject creation.
*/
class DataObject extends ViewableData implements DataObjectInterface, i18nEntityProvider {

View File

@ -4,6 +4,20 @@
*
* @package framework
* @subpackage security
*
* @property string Title Name of the group
* @property string Description Description of the group
* @property string Code Group code
* @property string Locked Boolean indicating whether group is locked in security panel
* @property int Sort
* @property string HtmlEditorConfig
*
* @property int ParentID ID of parent group
*
* @method Group Parent() Return parent group
* @method HasManyList Permissions() List of group permissions
* @method HasManyList Groups() List of child groups
* @method ManyManyList Roles() List of PermissionRoles
*/
class Group extends DataObject {

View File

@ -11,6 +11,14 @@
*
* @package framework
* @subpackage security
*
* @property string Email Email address used for login attempt
* @property string Status Status of the login attempt, either 'Success' or 'Failure'
* @property string IP IP address of user attempting to login
*
* @property int MemberID ID of the Member, only if Member with Email exists
*
* @method Member Member() Member object of the user trying to log in, only if Member with Email exists
*/
class LoginAttempt extends DataObject {

View File

@ -4,6 +4,24 @@
*
* @package framework
* @subpackage security
*
* @property string FirstName
* @property string Surname
* @property string Email
* @property string Password
* @property string RememberLoginHash
* @property int NumVisit
* @property string LastVisited Date and time of last visit
* @property string AutoLoginHash
* @property string AutoLoginExpired
* @property string PasswordEncryption
* @property string Salt
* @property string PasswordExpiry
* @property string LockedOutUntil
* @property string Locale
* @property int FailedLoginCount
* @property string DateFormat
* @property string TimeFormat
*/
class Member extends DataObject implements TemplateGlobalProvider {

View File

@ -3,6 +3,14 @@
* Keep track of users' previous passwords, so that we can check that new passwords aren't changed back to old ones.
* @package framework
* @subpackage security
*
* @property string Password
* @property string Salt
* @property string PasswordEncryption
*
* @property int MemberID ID of the Member
*
* @method Member Member() Owner of the password
*/
class MemberPassword extends DataObject {
private static $db = array(

View File

@ -3,6 +3,14 @@
* Represents a permission assigned to a group.
* @package framework
* @subpackage security
*
* @property string Code
* @property int Arg
* @property int Type
*
* @property int GroupID
*
* @method Group Group()
*/
class Permission extends DataObject implements TemplateGlobalProvider {

View File

@ -12,6 +12,12 @@
*
* @package framework
* @subpackage security
*
* @property string Title
* @property string OnlyAdminCanApply
*
* @method HasManyList Codes() List of PermissionRoleCode objects
* @method ManyManyList Groups() List of Group objects
*/
class PermissionRole extends DataObject {
private static $db = array(

View File

@ -4,6 +4,12 @@
*
* @package framework
* @subpackage security
*
* @property string Code
*
* @property int RoleID
*
* @method PermissionRole Role()
*/
class PermissionRoleCode extends DataObject {
private static $db = array(