VisibilityAspect implements AspectInterface
Read onlyYes
FinalYes
The aspect contains whether to show hidden pages, records (content) or even deleted records.
Allowed properties:
- includeHiddenPages
- includeHiddenContent
- includeDeletedRecords
- includeScheduledRecords
Table of Contents
Interfaces
- AspectInterface
- Interface AspectInterface Think of an aspect like a property bag
Methods
- __construct() : mixed
- create() : VisibilityAspect
- Creates an empty VisibilityAspect with all values set to false.
- get() : mixed
- Fetch the values
- includeDeletedRecords() : bool
- includeHidden() : bool
- includeHiddenContent() : bool
- includeHiddenPages() : bool
- includeScheduledRecords() : bool
- withIncludeDeletedRecords() : VisibilityAspect
- withIncludeHiddenContent() : VisibilityAspect
- withIncludeHiddenPages() : VisibilityAspect
- withIncludeScheduledRecords() : VisibilityAspect
Methods
__construct()
public
__construct([bool $includeHiddenPages = false ][, bool $includeHiddenContent = false ][, bool $includeDeletedRecords = false ][, bool $includeScheduledRecords = false ]) : mixed
Parameters
- $includeHiddenPages : bool = false
-
whether to include hidden=1 in pages tables
- $includeHiddenContent : bool = false
-
whether to include hidden=1 in tables except for pages
- $includeDeletedRecords : bool = false
-
whether to include deleted=1 records (only for use in recycler)
- $includeScheduledRecords : bool = false
-
whether to ignore access time in tables
create()
Creates an empty VisibilityAspect with all values set to false.
public
static create() : VisibilityAspect
you should consider using the existing instance of VisibilityAspect from the Context instead of creating a new instance. only if you want to reset the VisibilityAspect you should use this method to create a new instance.
Return values
VisibilityAspectget()
Fetch the values
public
get(string $name) : mixed
Parameters
- $name : string
Tags
includeDeletedRecords()
public
includeDeletedRecords() : bool
Return values
boolincludeHidden()
public
includeHidden() : bool
Return values
boolincludeHiddenContent()
public
includeHiddenContent() : bool
Return values
boolincludeHiddenPages()
public
includeHiddenPages() : bool
Return values
boolincludeScheduledRecords()
public
includeScheduledRecords() : bool
Return values
boolwithIncludeDeletedRecords()
public
withIncludeDeletedRecords(bool $includeDeletedRecords) : VisibilityAspect
Parameters
- $includeDeletedRecords : bool
Return values
VisibilityAspectwithIncludeHiddenContent()
public
withIncludeHiddenContent(bool $includeHiddenContent) : VisibilityAspect
Parameters
- $includeHiddenContent : bool
Return values
VisibilityAspectwithIncludeHiddenPages()
public
withIncludeHiddenPages(bool $includeHiddenPages) : VisibilityAspect
Parameters
- $includeHiddenPages : bool
Return values
VisibilityAspectwithIncludeScheduledRecords()
public
withIncludeScheduledRecords(bool $includeScheduledRecords) : VisibilityAspect
Parameters
- $includeScheduledRecords : bool