Skip to content

Element

Type
Class
Namespace
craft\gql\interfaces
Inherits
craft\gql\interfaces\Element » craft\gql\base\InterfaceType
Uses traits
craft\gql\base\GqlTypeTrait
Extended by
craft\gql\interfaces\Structure, craft\gql\interfaces\elements\Asset, craft\gql\interfaces\elements\Category, craft\gql\interfaces\elements\Entry, craft\gql\interfaces\elements\GlobalSet, craft\gql\interfaces\elements\MatrixBlock, craft\gql\interfaces\elements\Tag, craft\gql\interfaces\elements\User
Since
3.3.0

Class Element

View source

Public Methods

MethodDescription
getDraftFieldDefinitions()List the draft field definitions.
getFieldDefinitions()List of fields for this type.
getName()Returns the schema object name
getType()Returns an instance of this schema object's type as provided by entity registry
getTypeGenerator()Returns the associated type generator class.
resolveElementTypeName()Resolve an element type name.

getDraftFieldDefinitions()

List the draft field definitions.

View source

Returns

array

getFieldDefinitions()

List of fields for this type.

View source

Returns

array

getName()

Returns the schema object name

View source

Returns

string

getType()

Returns an instance of this schema object's type as provided by entity registry

View source

Arguments

  • $fields (array) – Optional fields to use

Returns

\GraphQL\Type\Definition\ObjectType

getTypeGenerator()

Returns the associated type generator class.

View source

Returns

string

Protected Methods

MethodDescription
getConditionalFields()Return conditional fields for this type.