GqlEntityRegistry

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

Class GqlEntityRegistry

View source (opens new window)

# Public Methods

Method Description
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 (opens new window)

Arguments

Returns

mixed

# flush()

Flush all registered entities.

View source (opens new window)

# getEntity()

Return a registered entity.

View source (opens new window)

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 (opens new window)

Arguments

Returns

mixed

# getPrefix()

Since
3.6.0

Returns the type prefix.

View source (opens new window)

Returns

string (opens new window), null (opens new window)

# prefixTypeName()

Prefix GQL type name with the configured prefix.

View source (opens new window)

Arguments

Returns

string (opens new window)

# setPrefix()

Since
3.6.0

Sets the type prefix.

View source (opens new window)

Arguments