FormMetadata

Read onlyYes
FinalYes

FormMetadata - Lightweight DTO for form listings Contains only metadata, not the full form definition

Internal

Table of Contents

Properties

$duplicateIdentifier  : bool
$fileUid  : int|null
$identifier  : string
$invalid  : bool
$name  : string
$persistenceIdentifier  : string|null
$prototypeName  : string
$readOnly  : bool
$referenceCount  : int
$removable  : bool
$storageType  : string|null
$type  : string

Methods

__construct()  : mixed
createFromYaml()  : self
createInvalid()  : self
fromArray()  : self
toArray()  : array<string|int, mixed>
withDuplicateIdentifier()  : self
withFileUid()  : self
withInvalid()  : self
withPersistenceIdentifier()  : self
withReadOnly()  : self
withReferenceCount()  : self
withRemovable()  : self
withStorageType()  : self

Properties

$duplicateIdentifier

public bool $duplicateIdentifier = false

$persistenceIdentifier

public string|null $persistenceIdentifier = null

$prototypeName

public string $prototypeName

$referenceCount

public int $referenceCount = 0

$storageType

public string|null $storageType = null

Methods

__construct()

public __construct(string $identifier, string $type, string $name, string $prototypeName[, string|null $persistenceIdentifier = null ][, bool $invalid = false ][, bool $readOnly = false ][, bool $removable = true ][, string|null $storageType = null ][, bool $duplicateIdentifier = false ][, int|null $fileUid = null ][, int $referenceCount = 0 ]) : mixed
Parameters
$identifier : string
$type : string
$name : string
$prototypeName : string
$persistenceIdentifier : string|null = null
$invalid : bool = false
$readOnly : bool = false
$removable : bool = true
$storageType : string|null = null
$duplicateIdentifier : bool = false
$fileUid : int|null = null
$referenceCount : int = 0

createFromYaml()

public static createFromYaml(array<string|int, mixed> $yamlData, string $persistenceIdentifier[, int|null $fileUid = null ]) : self
Parameters
$yamlData : array<string|int, mixed>
$persistenceIdentifier : string
$fileUid : int|null = null
Return values
self

createInvalid()

public static createInvalid(string $persistenceIdentifier, string $errorMessage) : self
Parameters
$persistenceIdentifier : string
$errorMessage : string
Return values
self

fromArray()

public static fromArray(array<string|int, mixed> $data) : self
Parameters
$data : array<string|int, mixed>
Return values
self

toArray()

public toArray() : array<string|int, mixed>
Return values
array<string|int, mixed>

withDuplicateIdentifier()

public withDuplicateIdentifier(bool $duplicateIdentifier) : self
Parameters
$duplicateIdentifier : bool
Return values
self

withFileUid()

public withFileUid(int|null $fileUid) : self
Parameters
$fileUid : int|null
Return values
self

withInvalid()

public withInvalid(bool $invalid) : self
Parameters
$invalid : bool
Return values
self

withPersistenceIdentifier()

public withPersistenceIdentifier(string $persistenceIdentifier) : self
Parameters
$persistenceIdentifier : string
Return values
self

withReadOnly()

public withReadOnly(bool $readOnly) : self
Parameters
$readOnly : bool
Return values
self

withReferenceCount()

public withReferenceCount(int $referenceCount) : self
Parameters
$referenceCount : int
Return values
self

withRemovable()

public withRemovable(bool $removable) : self
Parameters
$removable : bool
Return values
self

withStorageType()

public withStorageType(string $storageType) : self
Parameters
$storageType : string
Return values
self 

        

        
    




    

    

                            

            

                            
    

        On this page

        
    


            

                    

        

    

        

            
Search results