Documentation

Entity class

Class represents a dialog entity.

Method Description Available from version
static create(array $entityOptions): ?Entity Static factory method for creating entity objects.
  • $entityOptions — array with entity settings.
    • id: string — entity identifier.
    • options — entity options.
    • searchable: bool — defines entity item participation in search.
    • dynamicSearch: bool — defines support for dynamic backend search.
    • dynamicLoad: bool — defines support for dynamic load of backend items.
getId(): string Returns entity ID.
getOptions(): array Returns entity options.
getProvider(): BaseProvider Returns provider object.
isSearchable(): bool Returns true when entity items participate in search.
hasDynamicSearch(): bool Returns true when entity supports dynamic search at backend.
hasDynamicLoad(): bool Returns true when entity supports backend data dynamic loading.
© «Bitrix24», 2001-2024
Up