PageListGenerator
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
Get the approximage numnber of pages that will be included in the sitemap (the actual value can be lower than it).
Generate the list of pages that should be included in the sitemap.
Check if the current site has more than one multilingual section.
Get the multilingual section where a page resides (if any).
Get the list of multilingual sections defined for the current site.
No description
No description
No description
No description
No description
No description
No description
Details
__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).
Page|Generator
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).
Section[]
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.
protected DateTime
getNow()
No description
protected PageKey|null
getExcludeFromSiteMapAttributeKey()
No description
protected PageKey|null
getViewPagePermissionKey()
No description
protected Group|null
getVisitorsUserGroup()
No description
protected GroupEntity|null
getVisitorsUserGroupAccessEntity()
No description
protected Connection
getConnection()
No description
protected Dashboard
getDashboardHelper()
No description
protected int[]
getSiteTreesIDList()
No description
protected bool
isPageStandard(Page $page)
No description
protected bool
isPagePublished(Page $page)
No description
protected bool
isPageExcludedFromSitemap(Page $page)
No description
protected bool
isPageAccessible(Page $page)
No description