Member
class Member extends DataObject
The member class which represents the users of the system
Traits
Constants
| CHANGE_NONE |
Represents a field that hasn't changed (before === after, thus before == after) |
| CHANGE_STRICT |
Represents a field that has changed type, although not the loosely defined value. (before !== after && before == after) E.g. change 1 to true or "true" to true, but not true to 0. Value changes are by nature also considered strict changes. |
| CHANGE_VALUE |
Represents a field that has changed the loosely defined value (before != after, thus, before !== after)) E.g. change false to true, but not false to 0 |
Config options
| notify_password_change | boolean | ||
| summary_fields | array | ||
| casting | array | ||
| hidden_fields | array | Internal-use only fields | |
| title_format | array | ||
| unique_identifier_field | string | The unique field used to identify this member. | |
| password_expiry_days | |||
| password_logging_enabled | bool | ||
| lock_out_after_incorrect_logins | Int | ||
| lock_out_delay_mins | integer | ||
| login_marker_cookie | String | ||
| session_regenerate_id | boolean | Indicates that when a {@link Member} logs in, Member:session_regenerate_id() should be called as a security precaution. | |
| temp_id_lifetime | int | Default lifetime of temporary ids. | |
| auto_login_token_lifetime | int | Default lifetime of auto login token. |
Properties
| bool | $destroyed | from DataObject | |
| int | $ID | ID of the DataObject, 0 if the DataObject doesn't exist in database. | from DataObject |
| int | $OldID | ID of object, if deleted | from DataObject |
| string | $Title | from DataObject | |
| string | $ClassName | Class name of the DataObject | from DataObject |
| string | $LastEdited | Date and time of DataObject's last modification. | from DataObject |
| string | $Created | Date and time of DataObject creation. | from DataObject |
| string | $ObsoleteClassName | If ClassName no longer exists this will be set to the legacy value | from DataObject |
| string | $FirstName | ||
| string | $Surname | ||
| string | |||
| string | $Password | ||
| string | $TempIDHash | ||
| string | $TempIDExpired | ||
| string | $AutoLoginHash | ||
| string | $AutoLoginExpired | ||
| string | $PasswordEncryption | ||
| string | $Salt | ||
| string | $PasswordExpiry | ||
| string | $LockedOutUntil | ||
| string | $Locale | ||
| int | $FailedLoginCount | ||
| string | $DateFormat | ||
| string | $TimeFormat |
Methods
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
Return the names of all the methods available on this object
Add an extension to a specific class.
No description
Get extra config sources for this class
Return TRUE if a class has a specified extension.
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Get an extension instance attached to this object by name.
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Get all extension instances for this specific object instance.
An implementation of the factory method, allows you to create an instance of a class
Creates a class instance by the "singleton" design pattern.
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
Gets the uninherited value for the given config option
Construct a new DataObject.
Check if a field exists on this object or its failover.
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
Set a failover object to attempt to get data from if it is not present on this object.
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
Get the class name a field on this object will be casted to.
Return the string-format type for the given field.
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
Get an array of XML-escaped values by field name
Return a single-item iterator so you can iterate over the fields of a single record.
Find appropriate templates for SSViewer to use to render this object
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
Get part of the current classes ancestry to be used as a CSS class.
Return debug information about this object that can be rendered into a template
Create a duplicate of this node. Can duplicate many_many relations
Return obsolete class name, if this is no longer a valid class
Set the ClassName attribute. {@link $class} is also updated.
Create a new instance of a different class from this object's record.
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Get the user friendly plural name of this DataObject If the name is not defined (by renaming $plural_name in the subclass), this returns a pluralised version of the class name.
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
Get the complete name of the member, by default in the format "
Returns the associated database record - in this case, the object itself.
Update a number of fields on this object, given a map of the desired changes.
Pass changes as a map, and try to get automatic casting for these fields.
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
Validate this member object.
Find all objects that will be cascade deleted if this object is deleted
Ensure the locale is set to something sensible by default.
Writes all changes to this object to the database.
Write the cached components to the database. Cached components could refer to two different instances of the same record.
Delete the record with the given ID.
Return a unary component object from a one to one relationship, as a DataObject.
Returns a one-to-many relation as a HasManyList
Find the foreign class of a relation on this DataObject, regardless of the relation type.
Given a relation name, determine the relation type
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Returns a many-to-many component, as a ManyManyList.
Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.
Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
Return the many-to-many extra fields specification.
This returns an array (if it exists) describing the database extensions that are required, or false if none
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.
Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.
Return a {@link FieldList} of fields that would appropriate for editing this member.
need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.
Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.
Return the fields that have changed since the last write.
Uses {@link getChangedFields()} to determine if fields have been changed since loading them from the database.
Set the value of the field, using a casting object.
Returns true if the given field exists as a database column
Returns true if the member is allowed to do the given action.
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
Return the DBField object that represents the given field.
Traverses to a DBField referenced by relationships between data objects.
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
Return all objects matching the filter sub-classes are automatically selected and included
Return the first item matching the given query.
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
Flush the get_one global cache and destroy associated objects.
Return the given element, searching by ID.
Get list of parameters that should be inherited to relations on this object
Add default records to database. This function is called whenever the database is built, after the database tables have all been created. Overload this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
No description
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
Defines a default list of filters for the search context.
Temporarily disable subclass access in data object qeur
Returns the list of provided translations for this object.
If selected through a many_many through relation, this is the instance of the joined record
Find objects in the given relationships, merging them into the given list
Helper method to merge owned/owning items into a list.
Get the default admin record if it exists, or creates it otherwise if enabled
Check if the passed password matches the stored one (if the member is not locked out).
Check if this user is the currently configured default admin
Check if this user can login
Returns a valid {@link ValidationResult} if this member can currently log in, or an invalid one with error messages to display if the member is locked out.
Returns true if this user is locked out
Set a {@link PasswordValidator} object to use to validate member's passwords.
Returns the default {@link PasswordValidator}
No description
Called before a member is logged in via session/cookie/etc
Called after a member is logged in via session/cookie/etc
Trigger regeneration of TempID.
Check if the member ID logged in session actually has a database record of the same ID. If there is no logged in user, FALSE is returned anyway.
Audit logging hook, called before a member is logged out
Audit logging hook, called after a member is logged out
Utility for generating secure password hashes for this member.
Generate an auto login token which can be used to reset the password, at the same time hashing it and storing in the database.
Check the token against the member.
Return the member for the auto login hash
Find a member record with the given TempIDHash value
Returns the fields for the member form - used in the registration/profile module.
Builds "Change / Create Password" field for this member
Returns the {@link RequiredFields} instance for the Member object. This Validator is used when saving a {@link CMSProfileController} or added to any form responsible for saving a users data.
Generate a random password, with randomiser to kick in if there's no words file on the filesystem.
Event handler called before writing to the database.
No description
No description
Filter out admin groups to avoid privilege escalation, If any admin groups are requested, deny the whole save operation.
Adds the member to a group. This will create the group if the given group code does not return a valid group object.
Removes a member from a group.
No description
Simple proxy method to get the Surname property of the member
Return a SQL CONCAT() fragment suitable for a SELECT statement.
Get the complete name of the member
Set first- and surname
Alias for {@link setName}
Return the date format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.
Get user locale, falling back to the configured default locale
Return the time format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.
Get a "many-to-many" map that holds for all members their group memberships, including any parent groups where membership is implied.
No description
Get a member SQLMap of members in specific groups
Get a map of all members in the groups given that have CMS permissions
Get the groups in which the member is NOT in
Change password. This will cause rehashing according to the PasswordEncryption property via the
onBeforeWrite() method. This method will allow extensions to perform actions and augment the validation
result if required before the password is written and can check it after the write also.
Tell this member that someone made a failed attempt at logging in as them.
Tell this member that a successful login has been made
Get the HtmlEditorConfig for this user to be used in the CMS.
No description
No description
Details
in CustomMethods at line 50
mixed
__call(string $method, array $arguments)
Attempts to locate and call a method dynamically added to a class at runtime if a default cannot be located
You can add extra methods to a class using {@link Extensions}, {@link Object::createMethod()} or {@link Object::addWrapperMethod()}
in CustomMethods at line 144
bool
hasMethod(string $method)
Return TRUE if a method exists on this object
This should be used rather than PHP's inbuild method_exists() as it takes into account methods added via extensions
in CustomMethods at line 172
array
allMethodNames(bool $custom = false)
Return the names of all the methods available on this object
in Extensible at line 163
static bool
add_extension(string $classOrExtension, string $extension = null)
Add an extension to a specific class.
The preferred method for adding extensions is through YAML config, since it avoids autoloading the class, and is easier to override in more specific configurations.
As an alternative, extensions can be added to a specific class directly in the {@link Object::$extensions} array. See {@link SiteTree::$extensions} for examples. Keep in mind that the extension will only be applied to new instances, not existing ones (including all instances created through {@link singleton()}).
in Extensible at line 224
static
remove_extension(string $extension)
Remove an extension from a class.
Note: This will not remove extensions from parent classes, and must be called directly on the class assigned the extension.
Keep in mind that this won't revert any datamodel additions of the extension at runtime, unless its used before the schema building kicks in (in your _config.php). Doesn't remove the extension from any {@link Object} instances which are already created, but will have an effect on new extensions. Clears any previously created singletons through {@link singleton()} to avoid side-effects from stale extension information.
in Extensible at line 264
static array
get_extensions(string $class = null, bool $includeArgumentString = false)
in Extensible at line 298
static array|null
get_extra_config_sources(string $class = null)
Get extra config sources for this class
in Extensible at line 359
static bool
has_extension(string $classOrExtension, string $requiredExtension = null, boolean $strict = false)
Return TRUE if a class has a specified extension.
This supports backwards-compatible format (static Object::has_extension($requiredExtension)) and new format ($object->has_extension($class, $requiredExtension))
in Extensible at line 395
array
invokeWithExtensions(string $method, mixed $arguments)
Calls a method if available on both this object and all applied {@link Extensions}, and then attempts to merge all results into an array
in Extensible at line 424
array
extend(string $method, mixed $arguments)
Run the given function on all of this object's extensions. Note that this method originally returned void, so if you wanted to return results, you're hosed
Currently returns an array, with an index resulting every time the function is called. Only adds returns if they're not NULL, to avoid bogus results from methods just defined on the parent extension. This is important for permission-checks through extend, as they use min() to determine if any of the returns is FALSE. As min() doesn't do type checking, an included NULL return would fail the permission checks.
The extension methods are defined during {@link __construct()} in {@link defineMethods()}.
in Extensible at line 465
Extension|null
getExtensionInstance(string $extension)
Get an extension instance attached to this object by name.
in Extensible at line 494
bool
hasExtension(string $extension)
Returns TRUE if this object instance has a specific extension applied in {@link $extension_instances}. Extension instances are initialized at constructor time, meaning if you use {@link add_extension()} afterwards, the added extension will just be added to new instances of the extended class. Use the static method {@link has_extension()} to check if a class (not an instance) has a specific extension.
Caution: Don't use singleton(
in Extensible at line 508
Extension[]
getExtensionInstances()
Get all extension instances for this specific object instance.
See {@link get_extensions()} to get all applied extension classes for this class (not the instance).
This method also provides lazy-population of the extension_instances property.
in Injectable at line 26
static Injectable
create(array $args)
An implementation of the factory method, allows you to create an instance of a class
This method will defer class substitution to the Injector API, which can be customised via the Config API to declare substitution classes.
This can be called in one of two ways - either calling via the class directly, or calling on Object and passing the class name as the first parameter. The following are equivalent: $list = DataList::create('SiteTree'); $list = SiteTree::get();
in Injectable at line 43
static Injectable
singleton(string $class = null)
Creates a class instance by the "singleton" design pattern.
It will always return the same instance for this class, which can be used for performance reasons and as a simple way to access instance methods which don't rely on instance data (e.g. the custom SilverStripe static handling).
in Configurable at line 20
static Config_ForClass
config()
Get a configuration accessor for this class. Short hand for Config::inst()->get($this->class, .
....).
in Configurable at line 32
mixed
stat(string $name)
deprecated
deprecated 5.0 Use ->config()->get() instead
Get inherited config value
in Configurable at line 44
mixed
uninherited(string $name)
Gets the uninherited value for the given config option
in Configurable at line 57
$this
set_stat(string $name, mixed $value)
deprecated
deprecated 5.0 Use ->config()->set() instead
Update the config value for a given property
in DataObject at line 327
__construct(array|null $record = null, boolean $isSingleton = false, array $queryParams = array())
Construct a new DataObject.
in ViewableData at line 106
bool
__isset(string $property)
Check if a field exists on this object or its failover.
Note that, unlike the core isset() implementation, this will return true if the property is defined and set to null.
in ViewableData at line 129
mixed
__get(string $property)
Get the value of a property/field on this object. This will check if a method called get{$property} exists, then check if a field is available using {@link ViewableData::getField()}, then fall back on a failover object.
in ViewableData at line 152
__set(string $property, mixed $value)
Set a property/field on this object. This will check for the existence of a method called set{$property}, then use the {@link ViewableData::setField()} method.
in ViewableData at line 167
setFailover(ViewableData $failover)
Set a failover object to attempt to get data from if it is not present on this object.
in ViewableData at line 183
ViewableData|null
getFailover()
Get the current failover object if set
in DataObject at line 2827
bool
hasField(string $field)
Returns true if the given field exists in a database column on any of
the objects tables and optionally look up a dynamic getter with
get
in DataObject at line 2470
mixed
getField(string $field)
Gets the value of a field.
Called by {@link __get()} and any getFieldName() methods you might create.
in DataObject at line 2688
$this
setField(string $fieldName, mixed $val)
Set the value of the field Called by {@link __set()} and any setFieldName() methods you might create.
in DataObject at line 717
defineMethods()
Adds methods from the extensions.
Called by Object::__construct() once per class.
in ViewableData at line 258
ViewableData_Customised
customise(array|ViewableData $data)
Merge some arbitrary data in with this object. This method returns a {@link ViewableData_Customised} instance with references to both this and the new custom data.
Note that any fields you specify will take precedence over the fields on this object.
in DataObject at line 755
bool
exists()
Returns true if this object "exists", i.e., has a sensible value.
The default behaviour for a DataObject is to return true if the object exists in the database, you can override this in subclasses.
in ViewableData at line 289
string
__toString()
in ViewableData at line 297
ViewableData
getCustomisedObj()
in ViewableData at line 305
setCustomisedObj(ViewableData $object)
in DataObject at line 2798
string
castingHelper(string $field)
Return the "casting helper" (a piece of PHP code that when evaluated creates a casted value object) for a field on this object. This helper will be a subclass of DBField.
in ViewableData at line 352
string
castingClass(string $field)
Get the class name a field on this object will be casted to.
in ViewableData at line 365
string
escapeTypeForField(string $field)
Return the string-format type for the given field.
in ViewableData at line 389
DBHTMLText
renderWith(string|array|SSViewer $template, array $customFields = null)
Render this object into the template, and get the result as a string. You can pass one of the following as the $template parameter: - a template name (e.g. Page) - an array of possible template names - the first valid one will be used - an SSViewer instance
in ViewableData at line 471
Object|DBField
obj(string $fieldName, array $arguments = [], bool $cache = false, string $cacheName = null)
Get the value of a field on this object, automatically inserting the value into any available casting objects that have been specified.
in ViewableData at line 516
Object|DBField
cachedCall(string $field, array $arguments = [], string $identifier = null)
A simple wrapper around {@link ViewableData::obj()} that automatically caches the result so it can be used again without re-running the method.
in DataObject at line 4091
bool
hasValue(string $field, array $arguments = null, bool $cache = true)
Returns true if the given method/parameter has a value (Uses the DBField::hasValue if the parameter is a database field)
in ViewableData at line 545
string
XML_val(string $field, array $arguments = [], bool $cache = false)
Get the string value of a field on this object that has been suitable escaped to be inserted directly into a template.
in ViewableData at line 558
array
getXMLValues(array $fields)
Get an array of XML-escaped values by field name
in ViewableData at line 579
ArrayIterator
getIterator()
Return a single-item iterator so you can iterate over the fields of a single record.
This is useful so you can use a single record inside a <% control %> block in a template - and then use to access individual fields on this object.
in DataObject at line 2458
array
getViewerTemplates(string $suffix = '')
Find appropriate templates for SSViewer to use to render this object
in ViewableData at line 603
ViewableData
Me()
When rendering some objects it is necessary to iterate over the object being rendered, to do this, you need access to itself.
in ViewableData at line 620
string
ThemeDir()
deprecated
deprecated 4.0.0:5.0.0 Use $resourcePath or $resourceURL template helpers instead
Return the directory if the current active theme (relative to the site root).
This method is useful for things such as accessing theme images from your template without hardcoding the theme
page - e.g. 
.
This method should only be used when a theme is currently active. However, it will fall over to the current project directory.
in ViewableData at line 647
string
CSSClasses(string $stopAtClass = self::class)
Get part of the current classes ancestry to be used as a CSS class.
This method returns an escaped string of CSS classes representing the current classes ancestry until it hits a stop point - e.g. "Page DataObject ViewableData".
in ViewableData at line 676
ViewableData_Debugger
Debug()
Return debug information about this object that can be rendered into a template
in DataObject at line 312
static DataObjectSchema
getSchema()
Get schema object
in DataObject at line 408
destroy()
Destroy all of this objects dependant objects and local caches.
You'll need to call this to get the memory of an object that has components or extensions freed.
in DataObject at line 425
DataObject
duplicate(bool $doWrite = true, array|null|false $relations = null)
Create a duplicate of this node. Can duplicate many_many relations
in DataObject at line 631
string
getObsoleteClassName()
Return obsolete class name, if this is no longer a valid class
in DataObject at line 645
string
getClassName()
Gets name of this class
in DataObject at line 664
$this
setClassName(string $className)
Set the ClassName attribute. {@link $class} is also updated.
Warning: This will produce an inconsistent record, as the object instance will not automatically switch to the new subclass. Please use {@link newClassInstance()} for this purpose, or destroy and reinstanciate the record.
in DataObject at line 692
DataObject
newClassInstance(string $newClassName)
Create a new instance of a different class from this object's record.
This is useful when dynamically changing the type of an instance. Specifically, it ensures that the instance of the class is a match for the className of the record. Don't set the {@link DataObject->class} or {@link DataObject->ClassName} property manually before calling this method, as it will confuse change detection.
If the new class is different to the original class, defaults are populated again because this will only occur automatically on instantiation of a DataObject if there is no record, or the record has no ID. In this case, we do have an ID but we still need to repopulate the defaults.
in DataObject at line 766
boolean
isEmpty()
Returns TRUE if all values (other than "ID") are considered empty (by weak boolean comparison).
in DataObject at line 794
string
i18n_pluralise(string $count)
Pluralise this item given a specific count.
E.g. "0 Pages", "1 File", "3 Images"
in DataObject at line 811
string
singular_name()
Get the user friendly singular name of this DataObject.
If the name is not defined (by redefining $singular_name in the subclass), this returns the class name.
in DataObject at line 835
string
i18n_singular_name()
Get the translated user friendly singular name of this DataObject same as singular_name() but runs it through the translating function
Translating string is in the form: $this->class.SINGULARNAME Example: Page.SINGULARNAME
in DataObject at line 847
string
plural_name()
Get the user friendly plural name of this DataObject If the name is not defined (by renaming $plural_name in the subclass), this returns a pluralised version of the class name.
in DataObject at line 870
string
i18n_plural_name()
Get the translated user friendly plural name of this DataObject Same as plural_name but runs it through the translation function Translation string is in the form: $this->class.PLURALNAME Example: Page.PLURALNAME
at line 1149
string
getTitle()
Get the complete name of the member, by default in the format "
Falls back to showing either field on its own.
You can overload this getter with {@link set_title_format()} and {@link set_title_sql()}.
in DataObject at line 911
DataObject
data()
Returns the associated database record - in this case, the object itself.
This is included so that you can call $dataOrController->data() and get a DataObject all the time.
in DataObject at line 921
array
toMap()
Convert this object to a map.
in DataObject at line 935
array
getQueriedDatabaseFields()
Return all currently fetched database fields.
This function is similar to toMap() but doesn't trigger the lazy-loading of all unfetched fields. Obviously, this makes it a lot faster.
in DataObject at line 955
DataObject
update(array $data)
Update a number of fields on this object, given a map of the desired changes.
The field names can be simple names, or you can use a dot syntax to access $has_one relations. For example, array("Author.FirstName" => "Jim") will set $this->Author()->FirstName to "Jim".
Doesn't write the main object, but if you use the dot syntax, it will write() the related objects that it alters.
When using this method with user supplied data, it's very important to whitelist the allowed keys.
in DataObject at line 1016
DataObject
castedUpdate(array $data)
Pass changes as a map, and try to get automatic casting for these fields.
Doesn't write to the database. To write the data, use the write() method.
in DataObject at line 1045
Boolean
merge(DataObject $rightObj, string $priority = 'right', bool $includeRelations = true, bool $overwriteWithEmpty = false)
Merges data and relations from another object of same class, without conflict resolution. Allows to specify which dataset takes priority in case its not empty.
has_one-relations are just transferred with priority 'right'. has_many and many_many-relations are added regardless of priority.
Caution: has_many/many_many relations are moved rather than duplicated, meaning they are not connected to the merged object any longer. Caution: Just saves updated has_many/many_many relations to the database, doesn't write the updated object itself (just writes the object-properties). Caution: Does not delete the merged object. Caution: Does now overwrite Created date on the original object.
in DataObject at line 1126
$this
forceChange()
Forces the record to think that all its data has changed.
Doesn't write to the database. Force-change preseved until next write. Existing CHANGE_VALUE or CHANGE_STRICT values are preserved.
at line 1701
ValidationResult
validate()
Validate this member object.
in DataObject at line 1170
ValidationResult
doValidate()
Public accessor for {see DataObject::validate()}
in DataObject at line 1218
ArrayList
findCascadeDeletes(bool $recursive = true, ArrayList $list = null)
Find all objects that will be cascade deleted if this object is deleted
Notes: - If this object is versioned, objects will only be searched in the same stage as the given record. - This will only be useful prior to deletion, as post-deletion this record will no longer exist.
at line 268
DataObject
populateDefaults()
Ensure the locale is set to something sensible by default.
in DataObject at line 1517
write(boolean $showDebug = false, boolean $forceInsert = false, boolean $forceWrite = false, boolean|array $writeComponents = false)
Writes all changes to this object to the database.
- It will insert a record whenever ID isn't set, otherwise update.
- All relevant tables will be updated.
- $this->onBeforeWrite() gets called beforehand.
- Extensions such as Versioned will ammend the database-write to ensure that a version is saved.
in DataObject at line 1584
writeRelations()
Writes cached relation lists to the database, if possible
in DataObject at line 1607
DataObject
writeComponents(bool $recursive = false, array $skip = [])
Write the cached components to the database. Cached components could refer to two different instances of the same record.
in DataObject at line 1674
delete()
Delete this data object.
$this->onBeforeDelete() gets called. Note that in Versioned objects, both Stage and Live will be deleted.
in DataObject at line 1718
static
delete_by_id(string $className, int $id)
Delete the record with the given ID.
in DataObject at line 1736
array
getClassAncestry()
Get the class ancestry, including the current class name.
The ancestry will be returned as an array of class names, where the 0th element will be the class that inherits directly from DataObject, and the last element will be the current class.
in DataObject at line 1750
DataObject
getComponent(string $componentName)
Return a unary component object from a one to one relationship, as a DataObject.
If no component is available, an 'empty component' will be returned for non-polymorphic relations, or for polymorphic relations with a class set.
in DataObject at line 1830
$this
setComponent(string $componentName, DataObject|null $item)
Assign an item to the given component
in DataObject at line 1876
HasManyList|UnsavedRelationList
getComponents(string $componentName, int|array $id = null)
Returns a one-to-many relation as a HasManyList
in DataObject at line 1922
string
getRelationClass(string $relationName)
Find the foreign class of a relation on this DataObject, regardless of the relation type.
in DataObject at line 1959
string
getRelationType(string $component)
Given a relation name, determine the relation type
in DataObject at line 1989
DataList|DataObject
inferReciprocalComponent(string $remoteClass, string $remoteRelation)
Given a relation declared on a remote class, generate a substitute component for the opposite side of the relation.
Notes on behaviour: - This can still be used on components that are defined on both sides, but do not need to be. - All has_ones on remote class will be treated as local has_many, even if they are belongs_to - Polymorphic relationships do not have two natural endpoints (only on one side) and thus attempting to infer them will return nothing. - Cannot be used on unsaved objects.
in DataObject at line 2089
ManyManyList|UnsavedRelationList
getManyManyComponents(string $componentName, int|array $id = null)
Returns a many-to-many component, as a ManyManyList.
in DataObject at line 2158
string|array
hasOne()
Return the class of a one-to-one component. If $component is null, return all of the one-to-one components and their classes. If the selected has_one is a polymorphic field then 'DataObject' will be returned for the type.
in DataObject at line 2171
string|array
belongsTo(bool $classOnly = true)
Returns the class of a remote belongs_to relationship. If no component is specified a map of all components and their class name will be returned.
in DataObject at line 2189
string|array|false
hasMany(bool $classOnly = true)
Gets the class of a one-to-many relationship. If no $component is specified then an array of all the one-to-many relationships and their classes will be returned.
in DataObject at line 2207
array|null
manyManyExtraFields()
Return the many-to-many extra fields specification.
If you don't specify a component name, it returns all extra fields for all components available.
in DataObject at line 2220
array|null
manyMany()
Return information about a many-to-many component.
The return value is an array of (parentclass, childclass). If $component is null, then all many-many components are returned.
in DataObject at line 2237
array|false
database_extensions(string $class)
This returns an array (if it exists) describing the database extensions that are required, or false if none
This is experimental, and is currently only a Postgres-specific enhancement.
in DataObject at line 2253
SearchContext
getDefaultSearchContext()
Generates a SearchContext to be used for building and processing a generic search form for properties on this object.
in DataObject at line 2277
FieldList
scaffoldSearchFields(array $_params = null)
Determine which properties on the DataObject are searchable, and map them to their default {@link FormField} representations. Used for scaffolding a searchform for {@link ModelAdmin}.
Some additional logic is included for switching field labels, based on how generic or specific the field type is.
Used by {@link SearchContext}.
in DataObject at line 2352
FieldList
scaffoldFormFields(array $_params = null)
Scaffold a simple edit form for all properties on this dataobject, based on default {@link FormField} mapping in {@link DBField::scaffoldFormField()}.
Field labels/titles will be auto generated from {@link DataObject::fieldLabels()}.
at line 1469
FieldList
getCMSFields()
Return a {@link FieldList} of fields that would appropriate for editing this member.
in DataObject at line 2431
FieldList
getCMSActions()
need to be overload by solid dataobject, so that the customised actions of that dataobject, including that dataobject's extensions customised actions could be added to the EditForm.
in DataObject at line 2450
FieldList
getFrontEndFields(array $params = null)
Used for simple frontend forms without relation editing or {@link TabSet} behaviour. Uses {@link scaffoldFormFields()} by default. To customize, either overload this method in your subclass, or extend it by {@link DataExtension->updateFrontEndFields()}.
in DataObject at line 2601
array
getChangedFields(boolean|array $databaseFieldsOnly = false, int $changeLevel = self::CHANGE_STRICT)
Return the fields that have changed since the last write.
The change level affects what the functions defines as "changed": - Level CHANGE_STRICT (integer 1) will return strict changes, even !== ones. - Level CHANGE_VALUE (integer 2) is more lenient, it will only return real data changes, for example a change from 0 to null would not be included.
Example return:
array(
'Title' = array('before' => 'Home', 'after' => 'Home-Changed', 'level' => DataObject::CHANGE_VALUE)
)
in DataObject at line 2669
boolean
isChanged(string $fieldName = null, int $changeLevel = self::CHANGE_STRICT)
Uses {@link getChangedFields()} to determine if fields have been changed since loading them from the database.
in DataObject at line 2780
$this
setCastedField(string $fieldName, mixed $value)
Set the value of the field, using a casting object.
This is useful when you aren't sure that a date is in SQL format, for example. setCastedField() can also be used, by forms, to set related data. For example, uploaded images can be saved into the Image table.
in DataObject at line 2846
boolean
hasDatabaseField(string $field)
Returns true if the given field exists as a database column
in DataObject at line 2863
boolean
can(string $perm, Member $member = null, array $context = array())
Returns true if the member is allowed to do the given action.
See {@link extendedCan()} for a more versatile tri-state permission control.
in DataObject at line 2907
boolean|null
extendedCan(string $methodName, Member|int $member, array $context = array())
Process tri-state responses from permission-alterting extensions. The extensions are expected to return one of three values:
- false: Disallow this permission, regardless of what other extensions say
- true: Allow this permission, as long as no other extensions return false
- NULL: Don't affect the outcome
This method itself returns a tri-state value, and is designed to be used like this:
$extended = $this->extendedCan('canDoSomething', $member);
if($extended !== null) return $extended;
else return $normalValue;
at line 1595
boolean
canView(Member $member = null)
Users can view their own record.
Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions. This is likely to be customized for social sites etc. with a looser permission model.
at line 1627
boolean
canEdit(Member $member = null)
Users can edit their own record.
Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
at line 1664
boolean
canDelete(Member $member = null)
Users can edit their own record.
Otherwise they'll need ADMIN or CMS_ACCESS_SecurityAdmin permissions
in DataObject at line 2969
boolean
canCreate(Member $member = null, array $context = array())
in DataObject at line 2983
string
debug()
Debugging used by Debug::show()
in DataObject at line 3006
DBField
dbObject(string $fieldName)
Return the DBField object that represents the given field.
This works similarly to obj() with 2 key differences: - it still returns an object even when the field has no value. - it only matches fields and not methods - it matches foreign keys generated by has_one relationships, eg, "ParentID"
in DataObject at line 3054
mixed
relObject(string $fieldPath)
Traverses to a DBField referenced by relationships between data objects.
The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName).
If a relation is blank, this will return null instead. If a relation name is invalid (e.g. non-relation on a parent) this can throw a LogicException.
in DataObject at line 3092
mixed
relField(string $fieldName)
Traverses to a field referenced by relationships between data objects, returning the value The path to the related field is specified with dot separated syntax (eg: Parent.Child.Child.FieldName)
in DataObject at line 3119
string
getReverseAssociation(string $className)
Temporary hack to return an association name, based on class, to get around the mangle of having to deal with reverse lookup of relationships to determine autogenerated foreign keys.
in DataObject at line 3160
static DataList
get(string $callerClass = null, string|array $filter = "", string|array $sort = "", string $join = "", string|array $limit = null, string $containerClass = DataList::class)
Return all objects matching the filter sub-classes are automatically selected and included
in DataObject at line 3225
static DataObject|null
get_one(string|null $callerClass = null, string|array $filter = "", boolean $cache = true, string $orderBy = "")
Return the first item matching the given query.
All calls to get_one() are cached.
The filter argument supports parameterised queries (see SQLSelect::addWhere() for syntax examples). Because
of that (and differently from e.g. DataList::filter()) you need to manually escape the field names:
$member = DataObject::get_one('Member', [ '"FirstName"' => 'John' ]);
in DataObject at line 3268
DataObject
flushCache(boolean $persistent = true)
Flush the cached results for all relations (has_one, has_many, many_many) Also clears any cached aggregate data.
in DataObject at line 3291
static
flush_and_destroy_cache()
Flush the get_one global cache and destroy associated objects.
in DataObject at line 3310
static
reset()
Reset all global caches associated with DataObject.
in DataObject at line 3332
static DataObject
get_by_id(string|int $classOrID, int|bool $idOrCache = null, boolean $cache = true)
Return the given element, searching by ID.
This can be called either via DataObject::get_by_id(MyClass::class, $id)
or MyClass::get_by_id($id)
in DataObject at line 3354
string
baseTable()
Get the name of the base table for this object
in DataObject at line 3364
string
baseClass()
Get the base class for this object
in DataObject at line 3380
array
getSourceQueryParams()
in DataObject at line 3390
array
getInheritableQueryParams()
Get list of parameters that should be inherited to relations on this object
in DataObject at line 3401
setSourceQueryParams(array $array)
in DataObject at line 3411
setSourceQueryParam(string $key, string $value)
in DataObject at line 3421
string
getSourceQueryParam(string $key)
in DataObject at line 3436
requireTable()
Check the database schema and update it as necessary.
at line 274
requireDefaultRecords()
Add default records to database. This function is called whenever the database is built, after the database tables have all been created. Overload this to add default records when the database is built, but make sure you call parent::requireDefaultRecords().
in DataObject at line 3566
array
searchableFields()
Get the default searchable fields for this object, as defined in the $searchable_fields list. If searchable fields are not defined on the data object, uses a default selection of summary fields.
at line 1556
array
fieldLabels(boolean $includerelations = true)
in DataObject at line 3732
string
fieldLabel(string $name)
Get a human-readable label for a single field, see {@link fieldLabels()} for more details.
in DataObject at line 3745
array
summaryFields()
Get the default summary fields for this object.
in DataObject at line 3804
array
defaultSearchFilters()
Defines a default list of filters for the search context.
If a filter class mapping is defined on the data object, it is constructed here. Otherwise, the default filter specified in {@link DBField} is used.
in DataObject at line 3825
boolean
isInDB()
in DataObject at line 3838
static
disable_subclass_access()
Temporarily disable subclass access in data object qeur
in DataObject at line 3843
static
enable_subclass_access()
in DataObject at line 4065
array
provideI18nEntities()
Returns the list of provided translations for this object.
Note: Pluralised forms are always returned in array format.
Example usage:
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [];
foreach($this->config()->get('my_static_array') as $key => $value) {
$entities["MyTestClass.my_static_array_{$key}"] = $value;
}
$entities["MyTestClass.PLURALS"] = [
'one' => 'A test class',
'other' => '{count} test classes',
]
return $entities;
}
}
Example usage in {@link DataObject->provideI18nEntities()}.
You can ask textcollector to add the provided entity to a different module. Simply wrap the returned value for any item in an array with the format: [ 'default' => $defaultValue, 'module' => $module ]
class MyTestClass implements i18nEntityProvider
{
public function provideI18nEntities()
{
$entities = [
'MyOtherModuleClass.MYENTITY' => [
'default' => $value,
'module' => 'myothermodule',
]
];
}
return $entities;
}
in DataObject at line 4107
DataObject
getJoin()
If selected through a many_many through relation, this is the instance of the joined record
in DataObject at line 4119
$this
setJoin(DataObject $object, string $alias = null)
Set joining object
in DataObject at line 4142
ArrayList
findRelatedObjects(string $source, bool $recursive = true, ArrayList $list = null)
Find objects in the given relationships, merging them into the given list
in DataObject at line 4191
ArrayList
mergeRelatedObjects(ArrayList $list, mixed $items)
Helper method to merge owned/owning items into a list.
Items already present in the list will be skipped.
at line 288
static Member
default_admin()
deprecated
deprecated 4.0.0:5.0.0 Use DefaultAdminService::findOrCreateDefaultAdmin() instead
Get the default admin record if it exists, or creates it otherwise if enabled
at line 302
ValidationResult
checkPassword(string $password)
deprecated
deprecated 4.0.0:5.0.0 Use Authenticator::checkPassword() instead
Check if the passed password matches the stored one (if the member is not locked out).
at line 323
bool
isDefaultAdmin()
Check if this user is the currently configured default admin
at line 333
bool
canLogin()
Check if this user can login
at line 347
ValidationResult
validateCanLogin(ValidationResult $result = null)
Returns a valid {@link ValidationResult} if this member can currently log in, or an invalid one with error messages to display if the member is locked out.
You can hook into this with a "canLogIn" method on an attached extension.
at line 373
bool
isLockedOut()
Returns true if this user is locked out
at line 419
static
set_password_validator(PasswordValidator $validator = null)
Set a {@link PasswordValidator} object to use to validate member's passwords.
at line 435
static PasswordValidator
password_validator()
Returns the default {@link PasswordValidator}
at line 443
isPasswordExpired()
at line 456
logIn()
deprecated
deprecated 5.0.0 Use Security::setCurrentUser() or IdentityStore::logIn()
at line 469
beforeMemberLoggedIn()
Called before a member is logged in via session/cookie/etc
at line 478
afterMemberLoggedIn()
Called after a member is logged in via session/cookie/etc
at line 499
regenerateTempID()
Trigger regeneration of TempID.
This should be performed any time the user presents their normal identification (normally Email) and is successfully authenticated.
at line 519
static boolean
logged_in_session_exists()
deprecated
deprecated Not needed anymore, as it returns Security::getCurrentUser();
Check if the member ID logged in session actually has a database record of the same ID. If there is no logged in user, FALSE is returned anyway.
at line 538
logOut()
deprecated
deprecated Use Security::setCurrentUser(null) or an IdentityStore Logs this member out.
at line 554
beforeMemberLoggedOut(HTTPRequest $request = null)
Audit logging hook, called before a member is logged out
at line 564
afterMemberLoggedOut(HTTPRequest $request = null)
Audit logging hook, called after a member is logged out
at line 576
string
encryptWithUserSettings(string $string)
Utility for generating secure password hashes for this member.
at line 602
string
generateAutologinTokenAndStoreHash(int|null $lifetime = null)
Generate an auto login token which can be used to reset the password, at the same time hashing it and storing in the database.
at line 639
validateAutoLoginToken(string $autologinToken)
Check the token against the member.
at line 656
static Member
member_from_autologinhash(string $hash, bool $login = false)
Return the member for the auto login hash
at line 677
static Member
member_from_tempid(string $tempid)
Find a member record with the given TempIDHash value
at line 700
FieldList
getMemberFormFields()
Returns the fields for the member form - used in the registration/profile module.
It should return fields that are editable by the admin and the logged-in user.
at line 726
ConfirmedPasswordField
getMemberPasswordField()
Builds "Change / Create Password" field for this member
at line 763
Member_Validator
getValidator()
Returns the {@link RequiredFields} instance for the Member object. This Validator is used when saving a {@link CMSProfileController} or added to any form responsible for saving a users data.
To customize the required fields, add a {@link DataExtension} to member
calling the updateValidator() method.
at line 780
static Member
currentUser()
deprecated
deprecated 5.0.0 use Security::getCurrentUser()
Returns the current logged in user
at line 806
static mixed
actAs(Member|null|int $member, callable $callback)
Temporarily act as the specified user, limited to a $callback, but without logging in as that user.
E.g.
Member::logInAs(Security::findAnAdministrator(), function() {
$record->write();
});
at line 830
static int
currentUserID()
deprecated
deprecated 5.0.0 use Security::getCurrentUser()
Get the ID of the current logged in user
at line 850
static string
create_new_password()
Generate a random password, with randomiser to kick in if there's no words file on the filesystem.
at line 876
onBeforeWrite()
Event handler called before writing to the database.
at line 941
onAfterWrite()
at line 952
onAfterDelete()
at line 983
bool
onChangeGroups(array $ids)
Filter out admin groups to avoid privilege escalation, If any admin groups are requested, deny the whole save operation.
at line 1014
bool
inGroups(array|SS_List $groups, boolean $strict = false)
Check if the member is in one of the given groups.
at line 1035
bool
inGroup(int|Group|string $group, boolean $strict = false)
Check if the member is in the given group or any parent groups.
at line 1072
addToGroupByCode(string $groupcode, string $title = "")
Adds the member to a group. This will create the group if the given group code does not return a valid group object.
at line 1099
removeFromGroupByCode(string $groupcode)
Removes a member from a group.
at line 1112
static
set_title_columns(array $columns, String $sep = ' ')
at line 1134
string
getLastName()
Simple proxy method to get the Surname property of the member
at line 1181
static String
get_title_sql()
Return a SQL CONCAT() fragment suitable for a SELECT statement.
Useful for custom queries which assume a certain member title format.
at line 1209
string
getName()
Get the complete name of the member
at line 1223
setName(string $name)
Set first- and surname
This method assumes that the last part of the name is the surname, e.g. A B C will result in firstname A B and surname C
at line 1237
splitName(string $name)
Alias for {@link setName}
at line 1248
string
getDateFormat()
Return the date format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.
at line 1265
getLocale()
Get user locale, falling back to the configured default locale
at line 1281
string
getTimeFormat()
Return the time format based on the user's chosen locale, falling back to the default format defined by the i18n::config()->get('default_locale') config setting.
at line 1306
Member_Groupset
Groups()
Get a "many-to-many" map that holds for all members their group memberships, including any parent groups where membership is implied.
Use {@link DirectGroups()} to only retrieve the group relations without inheritance.
at line 1319
ManyManyList|UnsavedRelationList
DirectGroups()
at line 1332
static Map
map_in_groups(mixed $groups = null)
Get a member SQLMap of members in specific groups
If no $groups is passed, all members will be returned
at line 1374
static Map
mapInCMSGroups(array $groups = null)
Get a map of all members in the groups given that have CMS permissions
If no groups are passed, all groups with CMS permissions will be used.
at line 1444
array
memberNotInGroups(array $groupList, array $memberGroups = null)
Get the groups in which the member is NOT in
When passed an array of groups, and a component set of groups, this function will return the array of groups the member is NOT in.
at line 1732
ValidationResult
changePassword(string $password, bool $write = true)
Change password. This will cause rehashing according to the PasswordEncryption property via the
onBeforeWrite() method. This method will allow extensions to perform actions and augment the validation
result if required before the password is written and can check it after the write also.
onBeforeWrite() will encrypt the password prior to writing.
at line 1793
registerFailedLogin()
Tell this member that someone made a failed attempt at logging in as them.
This can be used to lock the user out temporarily if too many failed attempts are made.
at line 1813
registerSuccessfulLogin()
Tell this member that a successful login has been made
at line 1830
string
getHtmlEditorConfigForCMS()
Get the HtmlEditorConfig for this user to be used in the CMS.
This is set by the group. If multiple configurations are set, the one with the highest priority wins.