Skip to content

GqlEntityRegistry

Type
Class
Namespace
craft\gql
Inherits
craft\gql\GqlEntityRegistry
Since
3.3.0

Class GqlEntityRegistry

View source

Public Methods

MethodDescription
createEntity()Create an entity registry entry.
flush()Flush all registered entities.
getEntity()Return a registered entity.
getOrCreate()Returns a registered entity, creating it in the process if it doesn’t exist yet.
getPrefix()Returns the type prefix.
prefixTypeName()Prefix GQL type name with the configured prefix.
setPrefix()Sets the type prefix.

createEntity()

Create an entity registry entry.

View source

Arguments

  • $entityName (string)
  • $entity (mixed)

Returns

mixed

flush()

Flush all registered entities.

View source

getEntity()

Return a registered entity.

View source

Arguments

Returns

mixed

getOrCreate()

Since
4.5.0

Returns a registered entity, creating it in the process if it doesn’t exist yet.

View source

Arguments

Returns

mixed

getPrefix()

Since
3.6.0

Returns the type prefix.

View source

Returns

string, null

prefixTypeName()

Prefix GQL type name with the configured prefix.

View source

Arguments

Returns

string

setPrefix()

Since
3.6.0

Sets the type prefix.

View source

Arguments