Log in

GraphQl Module

Backpressure\BackpressureFieldValidator

Model

This class enforces rate limiting (backpressure) for GraphQL queries and mutations to prevent API abuse. It validates incoming GraphQL requests and th...

Backpressure\CompositeRequestTypeExtractor

Model

This class implements the Composite design pattern to extract request type information from GraphQL field queries. It iterates through multiple type e...

Backpressure\GraphQlContext

Model

This class represents the context information for GraphQL requests in Magento's backpressure system, which helps prevent server overload by rate-limit...

Backpressure\GraphQlTooManyRequestsException

Model

This exception is thrown when a GraphQL request is rate-limited or throttled due to too many requests from a client. Developers would use this to impl...

Config\DisableSession

Model

This class checks whether sessions are disabled for GraphQL requests in Magento 2. Developers use this to determine if the GraphQL API should operate...

EntityAttributeList

Model

This class retrieves all EAV and custom attributes for a given entity type (like products or customers) by iterating through all attribute sets. Devel...

Error\AggregateExceptionMessageFormatter

Helper

This helper class formats exception messages thrown during GraphQL query execution. It iterates through registered message formatters to find one that...

Error\MessageFormatters\GraphQlExceptionMessageFormatter

Helper

This helper class checks if an exception thrown during GraphQL query resolution is already properly formatted for GraphQL responses. If the exception...

Error\MessageFormatters\NoSuchEntityExceptionMessageFormatter

Helper

This helper class formats NoSuchEntityException errors for GraphQL responses. It intercepts internally-thrown NoSuchEntityException instances and conv...

Error\MessageFormatters\PaymentExceptionMessageFormatter

Helper

This helper class formats error messages specifically for payment-related exceptions in GraphQL responses. When a PaymentException occurs during Graph...

Error\MessageFormatters\ValidationExceptionMessageFormatter

Helper

This helper class formats validation exception messages for GraphQL responses. When a validation error occurs during GraphQL query execution, it conve...

Helper\Error\ExceptionMessageFormatterInterface

Interface

This interface defines how internal exceptions should be formatted into user-safe GraphQL error messages. Developers implement this interface to contr...

Model\Backpressure\BackpressureContextFactory

Factory

This factory class creates backpressure context objects for GraphQL field resolvers. Developers use this to enable rate limiting and request throttlin...

Model\Backpressure\RequestTypeExtractorInterface

Interface

This interface defines a contract for extracting request type identifiers from GraphQL field definitions, used in Magento's backpressure system to ide...

Model\Query\ContextFactory

Factory

This factory class creates and manages the GraphQL query context object, which holds user authentication information and extension attributes needed d...

Model\Query\ContextFactoryInterface

Interface

This interface defines a factory for creating and retrieving GraphQL context objects that contain request-specific information like user authenticatio...

Model\Query\ContextInterface

Interface

This interface defines the context object that is passed to all GraphQL field resolvers in Magento 2. Developers use it to access shared information l...

Model\Query\ContextParametersInterface

Interface

This interface defines a contract for managing context parameters in GraphQL queries, allowing developers to store and retrieve user information (user...

Model\Query\ContextParametersProcessorInterface

Interface

This interface defines a contract for processors that add custom parameters to the GraphQL context object. Developers implement this interface to inje...

Model\Query\Logger\LoggerInterface

Interface

This interface defines a contract for logging GraphQL query execution details in Magento 2. Developers implement this interface to create custom logge...

Model\Query\UserContextParametersProcessorInterface

Interface

This interface defines a contract for processors that add custom parameters to GraphQL context objects based on user context information. Developers w...

Mutation\BatchResult

Model

This class defines constants for tracking batch mutation operation statuses in GraphQL. Developers use these status constants to indicate whether a ba...

Mutation\Resolver\ErrorTypeResolver

Model

This class resolves the specific GraphQL error type for mutation operations by checking if the provided error type is valid and registered. Developers...

Query\Context

Model

This class serves as a context container for GraphQL queries, storing user authentication information (user type and user ID) and extension attributes...

Query\ContextParameters

Model

This class stores context parameters for GraphQL queries, including user authentication information (user type and ID) and custom extension attributes...

Query\Logger\LogData

Helper

This helper class collects and organizes data from GraphQL requests for logging purposes. Developers use this when implementing custom GraphQL logging...

Query\Logger\LoggerPool

Model

LoggerPool aggregates multiple GraphQL query loggers and executes them all when logging query details. Developers use this class to centrally manage a...

Query\Resolver\Context

Model

This class represents the context object passed to GraphQL query resolvers, containing information about the current user making the request. It store...