ComponentParts
extends AbstractBase
in package
Component parts display tab
Tags
Table of Contents
- $accessPermission : string
- Permission that must be granted to access this module (null for no restriction)
- $driver : AbstractBase|null
- Record driver associated with the tab
- $maxResults : int
- Maximum results to display
- $request : Request|bool
- User request associated with the tab (false for none)
- $results : array<string|int, mixed>
- Similar records
- $searchService : Service
- Search service
- __construct() : mixed
- Constructor
- getDescription() : string
- Get the on-screen description for this tab.
- getMaxResults() : int
- Get the maximum result count.
- getResults() : RecordCollectionInterface
- Get the contents for display.
- isActive() : bool
- Is this tab active?
- isVisible() : bool
- Is this tab initially visible?
- setRecordDriver() : AbstractBase
- Set the record driver
- setRequest() : AbstractBase
- Set the user request
- supportsAjax() : bool
- Can this tab be loaded via AJAX?
- getRecordDriver() : AbstractBase
- Get the record driver
- getRequest() : Request|bool
- Get the user request (or false if unavailable)
Properties
$accessPermission
Permission that must be granted to access this module (null for no restriction)
protected
string
$accessPermission
= null
$driver
Record driver associated with the tab
protected
AbstractBase|null
$driver
= null
$maxResults
Maximum results to display
protected
int
$maxResults
= 100
$request
User request associated with the tab (false for none)
protected
Request|bool
$request
= false
$results
Similar records
protected
array<string|int, mixed>
$results
$searchService
Search service
protected
Service
$searchService
Methods
__construct()
Constructor
public
__construct(Service $search) : mixed
Parameters
- $search : Service
-
Search service
Return values
mixed —getDescription()
Get the on-screen description for this tab.
public
getDescription() : string
Return values
string —getMaxResults()
Get the maximum result count.
public
getMaxResults() : int
Return values
int —getResults()
Get the contents for display.
public
getResults() : RecordCollectionInterface
Return values
RecordCollectionInterface —isActive()
Is this tab active?
public
isActive() : bool
Return values
bool —isVisible()
Is this tab initially visible?
public
isVisible() : bool
Return values
bool —setRecordDriver()
Set the record driver
public
setRecordDriver(AbstractBase $driver) : AbstractBase
Parameters
- $driver : AbstractBase
-
Record driver
Return values
AbstractBase —setRequest()
Set the user request
public
setRequest(Request $request) : AbstractBase
Parameters
- $request : Request
-
Request
Return values
AbstractBase —supportsAjax()
Can this tab be loaded via AJAX?
public
supportsAjax() : bool
Return values
bool —getRecordDriver()
Get the record driver
protected
getRecordDriver() : AbstractBase
Tags
Return values
AbstractBase —getRequest()
Get the user request (or false if unavailable)
protected
getRequest() : Request|bool