LinkPageContentBuilder
in package
implements
BuilderInterface, LinkPageContentBuilderInterface
Class LinkPageContentBuilder
This class represents a link page content builder
Tags
Interfaces, Classes and Traits
- BuilderInterface
- Interface BuilderInterface
- LinkPageContentBuilderInterface
- Interface LinkPageContentBuilderInterface
Table of Contents
- $deletable : ContentDeleteInterface
- Content is deletable
- $id : int|null
- Content group id
- $links : ContentLinkCollection
- Localized content links
- $names : ContentNameCollection
- Localized content names
- $openInNewTabStatus : ContentOpenInNewTabStatus
- Whether the link page is opened in a new tab
- $position : PagePosition
- Content position
- $sortOrder : ContentSortOrderInterface
- Content sort order
- $status : ContentStatus
- Content status
- $titles : ContentTitleCollection
- Localized content titles
- build() : LinkPageContent
- Return the created LinkPageContent instance
- create() : LinkPageContentBuilder
- Return new instance of the builder
- inPosition() : LinkPageContentBuilder
- Set the page position
- usingDelete() : LinkPageContentBuilder
- Set the content sort order
- usingId() : LinkPageContentBuilder
- Set the content group id
- usingLinks() : LinkPageContentBuilder
- Set the localized content links
- usingNames() : LinkPageContentBuilder
- Set the localized content names
- usingOpenInNewTabStatus() : LinkPageContentBuilder
- Set whether the link page opens in a new tab
- usingSortOrder() : LinkPageContentBuilder
- Set the content sort order
- usingStatus() : LinkPageContentBuilder
- Set the activation status
- usingTitles() : LinkPageContentBuilder
- Set the localized content titles
Properties
$deletable
Content is deletable
protected
ContentDeleteInterface
$deletable
$id
Content group id
protected
int|null
$id
$links
Localized content links
protected
ContentLinkCollection
$links
$names
Localized content names
protected
ContentNameCollection
$names
$openInNewTabStatus
Whether the link page is opened in a new tab
protected
ContentOpenInNewTabStatus
$openInNewTabStatus
$position
Content position
protected
PagePosition
$position
$sortOrder
Content sort order
protected
ContentSortOrderInterface
$sortOrder
$status
Content status
protected
ContentStatus
$status
$titles
Localized content titles
protected
ContentTitleCollection
$titles
Methods
build()
Return the created LinkPageContent instance
public
build() : LinkPageContent
Tags
Return values
LinkPageContent —Link page content entity object
create()
Return new instance of the builder
public
static create() : LinkPageContentBuilder
Return values
LinkPageContentBuilder —New instance
inPosition()
Set the page position
public
inPosition(PagePosition $position) : LinkPageContentBuilder
Parameters
- $position : PagePosition
-
Page position
Return values
LinkPageContentBuilder —Same instance
usingDelete()
Set the content sort order
public
usingDelete([ContentDeleteInterface $deletable = null ]) : LinkPageContentBuilder
Parameters
- $deletable : ContentDeleteInterface = null
Return values
LinkPageContentBuilder —Same instance
usingId()
Set the content group id
public
usingId([ContentIdentificationInterface|null $id = null ]) : LinkPageContentBuilder
Parameters
- $id : ContentIdentificationInterface|null = null
Return values
LinkPageContentBuilder —Same instance
usingLinks()
Set the localized content links
public
usingLinks(ContentLinkCollection $links) : LinkPageContentBuilder
Parameters
- $links : ContentLinkCollection
-
Localized links
Return values
LinkPageContentBuilder —Same instance
usingNames()
Set the localized content names
public
usingNames(ContentNameCollection $names) : LinkPageContentBuilder
Parameters
- $names : ContentNameCollection
-
Localized names
Return values
LinkPageContentBuilder —Same instance
usingOpenInNewTabStatus()
Set whether the link page opens in a new tab
public
usingOpenInNewTabStatus(ContentOpenInNewTabStatusCollection $openInNewTabStatus) : LinkPageContentBuilder
Parameters
- $openInNewTabStatus : ContentOpenInNewTabStatusCollection
-
Whether the link page opens in a new tab
Return values
LinkPageContentBuilder —Same instance
usingSortOrder()
Set the content sort order
public
usingSortOrder([ContentSortOrderInterface|null $sortOrder = null ]) : LinkPageContentBuilder
Parameters
- $sortOrder : ContentSortOrderInterface|null = null
Return values
LinkPageContentBuilder —Same instance
usingStatus()
Set the activation status
public
usingStatus(ContentStatusCollection $status) : LinkPageContentBuilder
Parameters
- $status : ContentStatusCollection
-
Activation status
Return values
LinkPageContentBuilder —Same instance
usingTitles()
Set the localized content titles
public
usingTitles(ContentTitleCollection $titles) : LinkPageContentBuilder
Parameters
- $titles : ContentTitleCollection
-
Localized titles
Return values
LinkPageContentBuilder —Same instance