Copied!

UserCreateStruct

UserCreateStruct.php : 16
Abstract
Extends ContentCreateStruct

This class is used to create a new user in the repository.

Properties

public $alwaysAvailable

ContentCreateStruct.php : 51

Indicates if the content object is shown in the main language if it's not present in another requested language.

 
public bool|null $alwaysAvailable = null

public $contentType

ContentCreateStruct.php : 26

The content type for which the new content is created.

 
public ContentType $contentType

Required.

public $email

UserCreateStruct.php : 34

User E-Mail address.

 
public string $email

Required.

public $enabled

UserCreateStruct.php : 50

Indicates if the user is enabled after creation.

 
public bool $enabled = true

public $fields

ContentCreateStruct.php 
public array<string|int, Field> $fields

public $login

UserCreateStruct.php : 25

User login.

 
public string $login

Required.

public $mainLanguageCode

ContentCreateStruct.php : 35

The main language code for the content. This language will also be used as an initial language for the first created version.

 
public string $mainLanguageCode

It is also used as the default language for added fields.

Required.

public $modificationDate

ContentCreateStruct.php : 63

Modification date. If not given, the current timestamp is used.

 
public DateTimeInterface|null $modificationDate = null

public $ownerId

ContentCreateStruct.php : 46

The owner of the content. If not given, the current authenticated user is set as owner.

 
public int|null $ownerId = null

public $password

UserCreateStruct.php : 43

The plain password.

 
public string $password

Required.

public $remoteId

ContentCreateStruct.php : 58

Remote identifier used as a custom identifier for the object.

 
public string|null $remoteId = null

Needs to be a unique Content->remoteId string value.

public $sectionId

ContentCreateStruct.php : 41

The section to which the content is assigned.

 
public int|null $sectionId = null

If not set, either the parent section or a default section is used.

Methods

public__construct()

ValueObject.php : 32

Construct object optionally with a set of properties.

 
public __construct([array<string, mixed> $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> [] -

publicsetField()

ContentStruct.php : 32

Adds a field to the field collection.

 
public abstract setField(string $fieldDefIdentifier, mixed $value[, string|null $language = null ]) : void

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

protectedgetProperties()

ValueObject.php : 53

Returns list of available properties' names.

 
protected getProperties([array<int, string> $dynamicProperties = [] ]) : array<int, string>

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>

Attributes
#[Ignore]