Documentation

EntityProvider
in package

FinalYes

Table of Contents

Properties

$entityName  : string
$meta  : EntityMetadataInterface
$storage  : EntityStorageInterface

Methods

__construct()  : mixed
deleteRecords()  : array<string|int, mixed>
getCustomFields()  : array<string|int, mixed>
getField()  : array<string|int, mixed>|null
getFields()  : array<string|int, mixed>
getMeta()  : mixed
getOptions()  : array<string|int, mixed>|null
getReferenceCounts()  : array<string|int, mixed>
getSupportedFields()  : array<string|int, mixed>
writeRecords()  : array<string|int, mixed>
getMetaProvider()  : EntityMetadataInterface
getStorageProvider()  : EntityStorageInterface

Properties

Methods

__construct()

public __construct(string $entityName) : mixed
Parameters
$entityName : string

deleteRecords()

public deleteRecords(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed>

getCustomFields()

public getCustomFields([array<string|int, mixed> $customGroupFilters = [] ]) : array<string|int, mixed>
Parameters
$customGroupFilters : array<string|int, mixed> = []
Return values
array<string|int, mixed>

getField()

public getField(string $fieldName) : array<string|int, mixed>|null
Parameters
$fieldName : string
Return values
array<string|int, mixed>|null

getFields()

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

List of field descriptors, keyed by name. Fields may or may not be defined in the underlying data-store, depending on the status of upgrade.

Ex: ['field_1' => ['title' => ..., 'sqlType' => ...]]

getMeta()

public getMeta(string $property) : mixed
Parameters
$property : string

getOptions()

public getOptions(string $fieldName[, array<string|int, mixed> $values = [] ][, bool $includeDisabled = false ][, bool $checkPermissions = false ][, int|null $userId = null ][, bool $isView = false ]) : array<string|int, mixed>|null
Parameters
$fieldName : string
$values : array<string|int, mixed> = []
$includeDisabled : bool = false
$checkPermissions : bool = false
$userId : int|null = null
$isView : bool = false
Return values
array<string|int, mixed>|null

getReferenceCounts()

public getReferenceCounts(array<string|int, mixed> $record) : array<string|int, mixed>
Parameters
$record : array<string|int, mixed>
Return values
array<string|int, mixed>

getSupportedFields()

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

List of field descriptors, keyed by name. Only include fields that are currently expected to be active/supported.

Ex: ['field_1' => ['title' => ..., 'sqlType' => ...]]

writeRecords()

public writeRecords(array<string|int, mixed> $records) : array<string|int, mixed>
Parameters
$records : array<string|int, mixed>
Return values
array<string|int, mixed> 

        

        
    




    

    

                                

                

                                
    

        On this page

        
    


                

                            

            

    

        

            
Search results