UserGroupCreateStruct

UserGroupCreateStruct.php : 16 Copy path

Extends ContentCreateStruct

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

Properties¶

$alwaysAvailable ¶

ContentCreateStruct.php : 47 Copy path

Indicates if the content object is shown in the mainlanguage if its not present in an other requested language.

public bool $alwaysAvailable

$contentType ¶

ContentCreateStruct.php : 25 Copy path

The content type for which the new content is created.

public ContentType $contentType

Required.

$fields ¶

ContentStruct.php Copy path

public array<string|int, Field> $fields

$fields ¶

ContentCreateStruct.php Copy path

public array<string|int, Field> $fields

$mainLanguageCode ¶

ContentCreateStruct.php : 67 Copy path

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

public string $mainLanguageCode

It is also used as default language for added fields.

Required.

$modificationDate ¶

ContentCreateStruct.php : 74 Copy path

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

public DateTime $modificationDate

$ownerId ¶

ContentCreateStruct.php : 40 Copy path

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

public mixed $ownerId

$remoteId ¶

ContentCreateStruct.php : 56 Copy path

Remote identifier used as a custom identifier for the object.

public string $remoteId

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

$sectionId ¶

ContentCreateStruct.php : 33 Copy path

The section the content is assigned to.

public mixed $sectionId

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

Methods¶

__construct() ¶

ValueObject.php : 30 Copy path

Construct object optionally with a set of properties.

public __construct([array<string|int, mixed> $properties = [] ])

Readonly properties values must be set using $properties as they are not writable anymore after object has been created.

Parameters

Name	Type	Default value	Description
$properties	array<string\|int, mixed>	[]	-

setField() ¶

ContentStruct.php : 32 Copy path

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

getProperties() ¶

ValueObject.php : 50 Copy path

Function where list of properties are returned.

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

Used by attributes(), override to add dynamic properties

Parameters

Name	Type	Default value	Description
$dynamicProperties	array<string\|int, mixed>	[]	Additional dynamic properties exposed on the object

Return values

array<string|int, mixed>