This class is used to create a new user in the repository.
Properties¶
$alwaysAvailable
¶
Indicates if the content object is shown in the mainlanguage if its not present in an other requested language.
|
|
|
$contentType
¶
The content type for which the new content is created.
|
|
|
Required.
$email
¶
User E-Mail address.
|
|
|
Required.
$enabled
¶
Indicates if the user is enabled after creation.
|
|
|
$fields
¶
|
|
|
$login
¶
User login.
|
|
|
Required.
$mainLanguageCode
¶
the main language code for the content. This language will also be used for as initial language for the first created version.
|
|
|
It is also used as default language for added fields.
Required.
$modificationDate
¶
Modification date. If not given the current timestamp is used.
|
|
|
$ownerId
¶
The owner of the content. If not given the current authenticated user is set as owner.
|
|
|
$password
¶
The plain password.
|
|
|
Required.
$remoteId
¶
Remote identifier used as a custom identifier for the object.
|
|
|
Needs to be a unique Content->remoteId string value.
$sectionId
¶
The section the content is assigned to.
|
|
|
If not set the section of the parent is used or a default section.
Methods¶
__construct()
¶
Construct object optionally with a set of properties.
|
|
|
Readonly properties values must be set using $properties as they aren't writable anymore
after object has been created.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $properties | array<string, mixed> | [] | - |
setField()
¶
Adds a field to the field collection.
|
|
|
This method could also be implemented by a magic setter so that $fields[$fieldDefIdentifier][$language] = $value or without language $fields[$fieldDefIdentifier] = $value is an equivalent call.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $fieldDefIdentifier | string | - |
the identifier of the field definition |
| $value | mixed | - |
Either a plain value which is understandable by the corresponding field type or an instance of a Value class provided by the field type |
| $language | string|null | null |
If not given on a translatable field the initial language is used |
getProperties()
¶
Returns list of available properties' names.
|
|
|
Override to add dynamic properties.
Parameters
| Name | Type | Default value | Description |
|---|---|---|---|
| $dynamicProperties | array<int, string> | [] |
Additional dynamic properties exposed on the object |
Return values
array<int, string>