HelpGuide
extends ControllerBase
in package
Provides a controller for help guide nodes.
This controller class includes methods for creating and managing various types of help guide content, including guide pages, guide boxes, and their items.
Table of Contents
Methods
- attachChildBoxes() : void
- attachChildBoxItems() : void
- attachChildNodes() : void
- Attaches child nodes to a parent node.
- attachHTMLItemsToBoxItems() : void
- createGuideBoxItemNode() : ContentEntityBase|EntityInterface|Node|EntityBase
- Creates a new guide box item node associated with a guide box.
- createGuideBoxNode() : ContentEntityBase|EntityInterface|Node|EntityBase
- Creates a new guide box node associated with a guide page.
- createGuidePageNode() : ContentEntityBase|EntityInterface|Node|EntityBase
- Creates a new guide page node associated with a help guide.
- createHelpGuide() : array<string|int, mixed>
- Orchestrates the creation of a complete help guide structure.
- createHelpGuideNode() : ContentEntityBase|EntityInterface|Node|EntityBase
- Creates a new help guide node.
- createHtmlItemNode() : ContentEntityBase|EntityInterface|Node|EntityBase
- Creates a new HTML item node associated with a guide box item.
- createNodeOfType() : Node
- Creates a new node of the specified type with given fields.
Methods
attachChildBoxes()
public
attachChildBoxes(ContentEntityBase|EntityInterface|Node|EntityBase $html_page, ContentEntityBase|EntityInterface|Node|EntityBase $html_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $reuse_html_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $book_page, ContentEntityBase|EntityInterface|Node|EntityBase $book_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $reuse_book_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $database_page, ContentEntityBase|EntityInterface|Node|EntityBase $database_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $reuse_database_guide_box) : void
Parameters
- $html_page : ContentEntityBase|EntityInterface|Node|EntityBase
- $html_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $reuse_html_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_page : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $reuse_book_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_page : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $reuse_database_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
Tags
attachChildBoxItems()
public
attachChildBoxItems(ContentEntityBase|EntityInterface|Node|EntityBase $html_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $html_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $book_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $book_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $database_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $database_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $media_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $media_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $create_box_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $create_box_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $create_guide_box, ContentEntityBase|EntityInterface|Node|EntityBase $create_guide_box_item) : void
Parameters
- $html_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $html_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $media_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $media_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_box_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_box_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_guide_box : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_guide_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
Tags
attachChildNodes()
Attaches child nodes to a parent node.
public
attachChildNodes(EntityInterface $parentNode, string $field_name, array<string|int, mixed> $childNodeIds) : void
Parameters
- $parentNode : EntityInterface
-
The parent node to attach children to.
- $field_name : string
-
The field name on the parent entity where children are referenced.
- $childNodeIds : array<string|int, mixed>
-
Array of child node IDs to attach.
Tags
attachHTMLItemsToBoxItems()
public
attachHTMLItemsToBoxItems(ContentEntityBase|EntityInterface|Node|EntityBase $html_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $the_html_content, ContentEntityBase|EntityInterface|Node|EntityBase $book_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $book_html_content, ContentEntityBase|EntityInterface|Node|EntityBase $database_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $database_html_content, ContentEntityBase|EntityInterface|Node|EntityBase $media_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $media_html_content, ContentEntityBase|EntityInterface|Node|EntityBase $create_box_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $create_box_html_content, ContentEntityBase|EntityInterface|Node|EntityBase $create_guide_box_item, ContentEntityBase|EntityInterface|Node|EntityBase $create_guide_html_content) : void
Parameters
- $html_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $the_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $book_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $database_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
- $media_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $media_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_box_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_box_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_guide_box_item : ContentEntityBase|EntityInterface|Node|EntityBase
- $create_guide_html_content : ContentEntityBase|EntityInterface|Node|EntityBase
Tags
createGuideBoxItemNode()
Creates a new guide box item node associated with a guide box.
public
createGuideBoxItemNode(int $guideBoxId, string $title) : ContentEntityBase|EntityInterface|Node|EntityBase
Parameters
- $guideBoxId : int
-
The ID of the guide box to which this item belongs.
- $title : string
-
The title of the guide box item.
Tags
Return values
ContentEntityBase|EntityInterface|Node|EntityBase —The newly created guide box item node. The newly created guide box item node.
createGuideBoxNode()
Creates a new guide box node associated with a guide page.
public
createGuideBoxNode(int $guidePageId, string $title) : ContentEntityBase|EntityInterface|Node|EntityBase
Parameters
- $guidePageId : int
-
The ID of the guide page to which this box belongs.
- $title : string
-
The title of the guide box.
Tags
Return values
ContentEntityBase|EntityInterface|Node|EntityBase —The newly created guide box node. The newly created guide box node.
createGuidePageNode()
Creates a new guide page node associated with a help guide.
public
createGuidePageNode(int $guideNodeId, string $title, string $description) : ContentEntityBase|EntityInterface|Node|EntityBase
Parameters
- $guideNodeId : int
-
The ID of the guide node to which this page belongs.
- $title : string
-
The title of the guide page.
- $description : string
-
The description of the guide page.
Tags
Return values
ContentEntityBase|EntityInterface|Node|EntityBase —The newly created guide page node. The newly created guide page node.
createHelpGuide()
Orchestrates the creation of a complete help guide structure.
public
createHelpGuide() : array<string|int, mixed>
This includes creating the main help guide node, associated guide pages, guide boxes, and various items within those boxes. Each step in the guide creation process is handled by dedicated methods within this class.
Tags
Return values
array<string|int, mixed> —An array of created node entities, keyed by their respective roles in the guide structure.
createHelpGuideNode()
Creates a new help guide node.
public
createHelpGuideNode() : ContentEntityBase|EntityInterface|Node|EntityBase
Tags
Return values
ContentEntityBase|EntityInterface|Node|EntityBase —The newly created help guide node. The newly created help guide node.
createHtmlItemNode()
Creates a new HTML item node associated with a guide box item.
public
createHtmlItemNode(int $guideBoxItemId, string $title, string $html) : ContentEntityBase|EntityInterface|Node|EntityBase
Parameters
- $guideBoxItemId : int
-
The ID of the guide box item to which this HTML item belongs.
- $title : string
-
The title of the HTML item.
- $html : string
-
The HTML content.
Tags
Return values
ContentEntityBase|EntityInterface|Node|EntityBase —The newly created HTML item node. The newly created HTML item node.
createNodeOfType()
Creates a new node of the specified type with given fields.
public
createNodeOfType(string $type, string $title, array<string|int, mixed> $fields) : Node
Parameters
- $type : string
-
The machine name of the content type.
- $title : string
-
The title of the node.
- $fields : array<string|int, mixed>
-
Additional fields to be attached to the node.
Tags
Return values
Node —The newly created node.