Log in

PageBuilder Module

Api\Data\TemplateExtensionInterface

Interface

This interface defines the contract for extension attributes on Page Builder template entities. Developers use this to add custom attributes to Page B...

Api\Data\TemplateInterface

Interface

This interface defines the data structure for Page Builder templates in Magento 2. Developers use it when working with the Template Manager feature to...

Api\Data\TemplateSearchResultsInterface

Interface

This interface defines the contract for search results when querying Page Builder templates. Developers use this to retrieve and manipulate collection...

Api\TemplateRepositoryInterface

Repository

This repository interface defines standard CRUD operations for managing Page Builder templates in Magento 2. Developers use this to save, retrieve, se...

Catalog\ProductTotals

Model

This class calculates product totals for Magento 2 PageBuilder's Products content type. Developers use it to retrieve counts of products matching spec...

Catalog\Sorting

Model

This class manages sorting options for product collections in Page Builder catalog widgets. Developers use it to retrieve available sorting methods (l...

Catalog\Sorting\Options

Model

This class provides sorting options for catalog products in Page Builder as a standardized array format for dropdowns and select fields. Developers us...

Catalog\Sorting\Price

Model

This class provides price-based sorting functionality for product collections in PageBuilder. Developers use this class when they need to sort catalog...

Catalog\Sorting\SimpleOption

Model

This class provides a simple sorting option for product collections in PageBuilder catalog widgets. Developers use it to define custom sorting criteri...

Config

Model

This class manages Page Builder's configuration data, providing access to menu sections, content types, and feature toggles. Developers use it to chec...

Config\CompositeReader

Model

This class aggregates multiple configuration readers for PageBuilder into a single unified reader. Developers use this when they need to combine PageB...

Config\ContentType\Converter

Model

This class converts Page Builder content type configuration from XML format into a PHP array structure that Magento can process. Developers use this w...

Config\ContentType\Reader

Model

This class reads and parses XML configuration files that define Page Builder content types from the content_type directory. It extends Magento's files...

Config\ContentType\SchemaLocator

Model

This class provides the locations of XSD schema files used to validate Page Builder content type configuration XML files. Developers use this when the...

Config\FileResolver

Model

This class resolves and retrieves Page Builder configuration files from the theme hierarchy. Developers would use this to load XML configuration files...

Config\MenuSection\Converter

Model

This class converts XML configuration data for Page Builder menu sections into a PHP array structure. Developers would use this when defining custom m...

Config\MenuSection\Reader

Model

This class reads and processes menu_section.xml configuration files for PageBuilder's menu sections. It parses XML configuration files that define cus...

Config\MenuSection\SchemaLocator

Model

This class locates and provides paths to XSD schema files used for validating PageBuilder menu section configuration XML files. Developers would typic...

Config\Source\Country

Model

This class provides a list of countries as options for dropdown fields in Page Builder configuration. Developers would use this as a source model in s...

ContentType\DataProvider

Model

This class provides data for Page Builder UI component forms but intentionally returns empty data since Page Builder populates forms dynamically via J...

Dom\Attr

Model

This class serves as a wrapper for PhpGt DOM library's Attr class, providing a standardized interface for working with HTML element attributes in Page...

Dom\CharacterData

Model

This class serves as a wrapper for the PhpGt DOM CharacterData implementation in Magento's PageBuilder module. Developers would use this when working...

Dom\Comment

Model

This class serves as a wrapper for DOM Comment nodes in Magento Page Builder. It implements the CommentInterface to provide a standardized way to hand...

Dom\Document

Model

This class wraps PhpGt DOM Document functionality to provide a unified interface for parsing and manipulating HTML content in Magento's Page Builder....

Dom\DocumentFragment

Model

This class wraps the PhpGt DOM DocumentFragment library to provide DOM manipulation capabilities for PageBuilder content. Developers use it to parse H...

Dom\DocumentType

Model

This class serves as a wrapper for PhpGt DOM DocumentType functionality in Page Builder. It implements the DocumentTypeInterface to provide a standard...

Dom\DomDocument

Model

This class serves as a wrapper for the PhpGt DOM Document library, providing Magento-specific DOM manipulation capabilities for Page Builder content....

Dom\Element

Model

This class provides a wrapper around PhpGt DOM elements for manipulating HTML elements within PageBuilder content. Developers use it to programmatical...

Dom\HtmlDocument

Model

This class is a wrapper around PhpGt's DOM HTMLDocument library, providing Magento-specific functionality for parsing and manipulating HTML content in...

Dom\Node

Model

This class serves as a wrapper for PhpGt DOM Node objects in Magento's Page Builder module. It implements NodeInterface to provide a standardized way...

Dom\NodeList

Model

This class wraps the PhpGt DOM NodeList to provide a Magento-specific interface for working with collections of DOM nodes in PageBuilder content. Deve...

Dom\PropertyAttribute

Model

This class serves as a wrapper for PhpGt DOM PropertyAttribute functionality within Magento's Page Builder module. Developers would use this when work...

Dom\StringMap

Model

This class is a wrapper around PhpGt's DOMStringMap that provides access to HTML element dataset attributes (data-* attributes) in Page Builder. Devel...

Dom\Text

Model

This class is a wrapper around the PhpGt DOM Text node, providing a standardized interface for working with text elements in Page Builder content. Dev...

Dom\TokenList

Model

This class wraps the PhpGt DOM TokenList library to provide a consistent interface for managing space-separated tokens in HTML element attributes (lik...

Dom\XmlDocument

Model

This class serves as a wrapper around the PhpGt DOM XMLDocument library, providing XML document handling capabilities within Magento's Page Builder mo...

EditorConfigCacheCleaner

Model

This class is responsible for clearing the Page Builder editor configuration cache. Developers would use this when they need to force a refresh of Pag...

Filter\Template

Model

This class processes and transforms Page Builder content after it's been filtered, handling background images, HTML content types, and script tags. De...

GoogleMaps\ApiKeyValidator

Model

This class validates Google Maps API keys by making a test request to the Google Maps Embed API. Developers use this to verify that a provided API key...

Model\Catalog\Sorting\Factory

Factory

This factory class creates instances of sorting option classes for PageBuilder catalog product sorting. Developers use this when they need to dynamica...

Model\Catalog\Sorting\OptionInterface

Interface

This interface defines the contract for sorting options used in PageBuilder product widgets. Developers implement this interface to create custom sort...

Model\ConfigInterface

Interface

This interface defines the contract for accessing PageBuilder configuration data in Magento 2. Developers use this to retrieve available content types...

Model\Dom\Adapter\AttrInterface

Interface

This interface defines a contract for DOM attribute wrapper classes in Magento's Page Builder module. Developers would implement this interface when c...

Model\Dom\Adapter\CharacterDataInterface

Interface

This is a marker interface for wrapping DOM CharacterData objects in Magento's Page Builder module. Developers would implement this interface when cre...

Model\Dom\Adapter\CommentInterface

Interface

This interface defines a contract for wrapper classes that handle HTML/XML comment nodes in Page Builder's DOM manipulation functionality. Developers...

Model\Dom\Adapter\DocumentFragmentInterface

Interface

This interface defines the contract for DOM document fragment adapters in PageBuilder, allowing manipulation of HTML fragments through methods like ap...

Model\Dom\Adapter\DocumentInterface

Interface

This interface defines a contract for DOM document adapters in PageBuilder, providing methods to manipulate HTML documents like creating elements, que...

Model\Dom\Adapter\DocumentTypeInterface

Interface

This interface defines a contract for DocumentType wrapper implementations in the PageBuilder module. Developers would implement this interface when c...

Model\Dom\Adapter\ElementInterface

Interface

This interface defines a contract for DOM element wrapper classes in PageBuilder, providing methods to manipulate HTML elements similar to JavaScript...

Model\Dom\Adapter\HtmlCollectionInterface

Interface

This interface defines a contract for HTML collection wrappers in Page Builder, providing methods to access and iterate through DOM elements. It imple...

Model\Dom\Adapter\HtmlDocumentInterface

Interface

This interface defines a contract for HTML document wrapper classes in Page Builder that need to manipulate DOM elements. Developers would implement t...

Model\Dom\Adapter\NodeInterface

Interface

This is a marker interface for DOM node wrapper classes in Magento's Page Builder module. Developers would implement this interface when creating adap...

Model\Dom\Adapter\NodeListInterface

Interface

This interface defines a contract for NodeList wrapper classes in PageBuilder's DOM manipulation layer. It provides methods for iterating through, acc...

Model\Dom\Adapter\PropertyAttributeInterface

Interface

This interface defines a contract for property attribute wrapper classes in Magento's Page Builder module. Developers would implement this interface w...

Model\Dom\Adapter\StringMapInterface

Interface

This interface defines a contract for string map wrappers in PageBuilder's DOM adapter layer. Developers use implementations of this interface to work...

Model\Dom\Adapter\TextInterface

Interface

This interface defines a contract for text wrapper classes in PageBuilder's DOM manipulation system. Developers use it to check if DOM text elements c...

Model\Dom\Adapter\TokenListInterface

Interface

This interface defines a contract for managing space-separated tokens in DOM element attributes (like CSS classes). Developers use implementations of...

Model\Dom\Adapter\XmlDocumentInterface

Interface

This interface defines a contract for XML document wrapper classes in Magento's PageBuilder module. Developers would implement this interface when cre...

Model\Dom\HtmlCollection

Collection

This class wraps the PhpGt DOM NodeList to provide an iterable collection of HTML elements in Page Builder. Developers use it when working with multip...

Model\ResourceModel\Template\Collection

Collection

This collection class manages groups of Page Builder template records from the database. Developers use this to retrieve, filter, and manipulate multi...

Model\Stage\RendererInterface

Interface

This interface defines a contract for rendering content types in the Page Builder stage (admin editing view). Developers would implement this interfac...

ResourceModel\Template

Model

This resource model handles database operations for Page Builder templates. Developers use this class to interact with the 'pagebuilder_template' data...

Session\RandomKey

Model

This class generates and manages a random key stored in the user's session, primarily used as a cache key suffix for PageBuilder configuration. It ens...

Source\VisualSelect

Model

This class prepares and formats options for PageBuilder's Visual Select UI component, converting icon paths to full URLs and adding size specification...

Stage\Config

Model

This class provides configuration data for the Page Builder visual editor in the Magento admin panel. It aggregates settings like content types, menu...

Stage\Config\UiComponentConfig

Model

This class retrieves field configurations and default values from UI component forms associated with PageBuilder content types. Developers use it to e...

Stage\HtmlFilter

Model

This class sanitizes HTML content from the Page Builder stage editor by removing potentially dangerous elements like script tags, event handlers, and...

Stage\Preview

Model

This class manages Page Builder's preview mode functionality, which allows administrators to see how content will appear on the frontend while editing...

Stage\RendererPool

Model

This class manages a collection of renderers for different Page Builder content types. Developers use it to retrieve the appropriate renderer for a sp...

Stage\Renderer\Block

Model

This class renders backend blocks for PageBuilder content types in the admin stage editor. Developers use it when creating custom PageBuilder content...

Stage\Renderer\CmsStaticBlock

Model

This class renders CMS static blocks for display within Page Builder's stage preview in the Magento admin. Developers use this when they need to displ...

Stage\Renderer\WidgetDirective

Model

This class renders widget directives for the Page Builder stage preview in the Magento admin panel. When a content editor places a widget in Page Buil...

State

Model

This class determines whether PageBuilder is currently being used in the system. Developers use this to check if content should be rendered using Page...

Template

Model

This model represents a saved Page Builder template that users can create and reuse in the Template Manager. Developers use this class to programmatic...

TemplateRepository

Model

This repository manages CRUD operations for Page Builder templates in Magento 2. Developers use this class to save, retrieve, search, and delete Page...

Template\Source\TemplateTypes

Model

This class provides a list of available Page Builder template types as option array data, typically used to populate dropdown or select fields in the...

UpgradableEntitiesPool

Model

This class serves as a registry pool that stores and manages a collection of upgradable Page Builder entities. Developers use it to retrieve entities...

Validator\IframeSrcAttributeValidator

Model

This validator ensures that iframe src attributes in Page Builder content only reference allowed hosts for security purposes. Developers would use thi...

Validator\InnerHtmlValidator

Model

This validator checks HTML content within Page Builder elements that have the 'data-content-type="html"' attribute. It recursively validates the inner...

WidgetInitializerConfig

Model

This class manages configuration for Page Builder's widget initializer mechanism, which dynamically loads JavaScript components for content types on t...

Wysiwyg\DefaultConfigProvider

Model

This class provides default TinyMCE WYSIWYG editor configuration for Page Builder in Magento 2. Developers would use this when they need to customize...

Wysiwyg\InlineEditingSupportedAdapterList

Model

This class determines whether a specific WYSIWYG editor adapter supports inline editing functionality in PageBuilder. Developers use this to check if...