class PageListGenerator (View source)

Class to be used to generate the list of the pages that should be included in a sitemap.xml file.

Properties

protected Application $app
private Site|null|false $site
private Section[]|null $multilingualSections
private bool|null $isMultilingualEnabled
private Connection|null $connection
private Dashboard|null $dashboardHelper
private DateTime|null $now
private PageKey|null|false $excludeFromSiteMapAttributeKey
private PageKey|null|false $viewPagePermissionKey
private Group|null|false $visitorsUserGroup
private GroupEntity|null|false $visitorsUserGroupAccessEntity

Methods

__construct(Application $app)

Initialize the instance.

int
getApproximatePageCount()

Get the approximage numnber of pages that will be included in the sitemap (the actual value can be lower than it).

generatePageList()

Generate the list of pages that should be included in the sitemap.

bool
isMultilingualEnabled()

Check if the current site has more than one multilingual section.

Section|null
getMultilingualSectionForPage(Page $page)

Get the multilingual section where a page resides (if any).

getMultilingualSections()

Get the list of multilingual sections defined for the current site.

bool
canIncludePageInSitemap(Page $page)

Should a page be included in the sitemap?

Site|null
getSite()

Get the currently used site.

$this
setSite(Site $site)

Set the currently used site.

getNow()

No description

PageKey|null
getViewPagePermissionKey()

No description

Group|null
getVisitorsUserGroup()

No description

getConnection()

No description

getDashboardHelper()

No description

int[]
getSiteTreesIDList()

No description

bool
isPageStandard(Page $page)

No description

bool
isPagePublished(Page $page)

No description

bool
isPageExcludedFromSitemap(Page $page)

No description

bool
isPageAccessible(Page $page)

No description

Details

__construct(Application $app)

Initialize the instance.

Parameters

Application $app

int getApproximatePageCount()

Get the approximage numnber of pages that will be included in the sitemap (the actual value can be lower than it).

Return Value

int

Page|Generator generatePageList()

Generate the list of pages that should be included in the sitemap.

Return Value

Page|Generator

bool isMultilingualEnabled()

Check if the current site has more than one multilingual section.

Return Value

bool

Section|null getMultilingualSectionForPage(Page $page)

Get the multilingual section where a page resides (if any).

Parameters

Page $page

Return Value

Section|null

Section[] getMultilingualSections()

Get the list of multilingual sections defined for the current site.

Return Value

Section[]

bool canIncludePageInSitemap(Page $page)

Should a page be included in the sitemap?

Parameters

Page $page

Return Value

bool

Site|null getSite()

Get the currently used site.

Return Value

Site|null

$this setSite(Site $site)

Set the currently used site.

Parameters

Site $site

Return Value

$this

protected DateTime getNow()

Return Value

DateTime

protected PageKey|null getExcludeFromSiteMapAttributeKey()

Return Value

PageKey|null

protected PageKey|null getViewPagePermissionKey()

Return Value

PageKey|null

protected Group|null getVisitorsUserGroup()

Return Value

Group|null

protected GroupEntity|null getVisitorsUserGroupAccessEntity()

Return Value

GroupEntity|null

protected Connection getConnection()

Return Value

Connection

protected Dashboard getDashboardHelper()

Return Value

Dashboard

protected int[] getSiteTreesIDList()

Return Value

int[]

protected bool isPageStandard(Page $page)

Parameters

Page $page

Return Value

bool

protected bool isPagePublished(Page $page)

Parameters

Page $page

Return Value

bool

protected bool isPageExcludedFromSitemap(Page $page)

Parameters

Page $page

Return Value

bool

protected bool isPageAccessible(Page $page)

Parameters

Page $page

Return Value

bool