ListOptions
in package
ListOptions Class Doc Comment
Tags
Table of Contents
- $count : string|null
- $count
- $include : string|null
- $include
- $include_items : string|null
- $include_items
- $start_position : string|null
- $start_position
- $sub_folder_depth : string|null
- $sub_folder_depth
- $template : string|null
- $template Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
- $user_filter : string|null
- $user_filter
- getCount() : string|null
- Gets count
- getInclude() : string|null
- Gets include
- getIncludeItems() : string|null
- Gets include_items
- getStartPosition() : string|null
- Gets start_position
- getSubFolderDepth() : string|null
- Gets sub_folder_depth
- getTemplate() : string|null
- Gets template
- getUserFilter() : string|null
- Gets user_filter
- setCount() : self
- Sets count
- setInclude() : self
- Sets include
- setIncludeItems() : self
- Sets include_items
- setStartPosition() : self
- Sets start_position
- setSubFolderDepth() : self
- Sets sub_folder_depth
- setTemplate() : self
- Sets template
- setUserFilter() : self
- Sets user_filter
Properties
$count
$count
protected
string|null
$count
= null
$include
$include
protected
string|null
$include
= null
$include_items
$include_items
protected
string|null
$include_items
= null
$start_position
$start_position
protected
string|null
$start_position
= null
$sub_folder_depth
$sub_folder_depth
protected
string|null
$sub_folder_depth
= null
$template
$template Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
protected
string|null
$template
= null
$user_filter
$user_filter
protected
string|null
$user_filter
= null
Methods
getCount()
Gets count
public
getCount() : string|null
Return values
string|null —getInclude()
Gets include
public
getInclude() : string|null
Return values
string|null —getIncludeItems()
Gets include_items
public
getIncludeItems() : string|null
Return values
string|null —getStartPosition()
Gets start_position
public
getStartPosition() : string|null
Return values
string|null —getSubFolderDepth()
Gets sub_folder_depth
public
getSubFolderDepth() : string|null
Return values
string|null —getTemplate()
Gets template
public
getTemplate() : string|null
Return values
string|null —getUserFilter()
Gets user_filter
public
getUserFilter() : string|null
Return values
string|null —setCount()
Sets count
public
setCount(string|null $count) : self
Parameters
- $count : string|null
Return values
self —setInclude()
Sets include
public
setInclude(string|null $include) : self
Parameters
- $include : string|null
Return values
self —setIncludeItems()
Sets include_items
public
setIncludeItems(string|null $include_items) : self
Parameters
- $include_items : string|null
Return values
self —setStartPosition()
Sets start_position
public
setStartPosition(string|null $start_position) : self
Parameters
- $start_position : string|null
Return values
self —setSubFolderDepth()
Sets sub_folder_depth
public
setSubFolderDepth(string|null $sub_folder_depth) : self
Parameters
- $sub_folder_depth : string|null
Return values
self —setTemplate()
Sets template
public
setTemplate(string|null $template) : self
Parameters
- $template : string|null
-
Specifies the items that are returned. Valid values are: * include - The folder list will return normal folders plus template folders. * only - Only the list of template folders are returned.
Return values
self —setUserFilter()
Sets user_filter
public
setUserFilter(string|null $user_filter) : self
Parameters
- $user_filter : string|null