CRM_Contact_Selector_Controller
class CRM_Contact_Selector_Controller extends CRM_Core_Selector_Controller
Constants
| SESSION |
|
| TEMPLATE |
|
| TRANSFER |
|
| EXPORT |
|
| SCREEN |
|
|
|
Properties
| protected object | $_object | A CRM Object that implements CRM_Core_Selector_API. | from CRM_Core_Selector_Controller |
| protected CRM_Utils_Sort | $_sort | from CRM_Core_Selector_Controller | |
| protected int | $_sortID | The current column to sort on | from CRM_Core_Selector_Controller |
| protected array | $_sortOrder | The sortOrder array | from CRM_Core_Selector_Controller |
| protected CRM_Utils_Pager | $_pager | from CRM_Core_Selector_Controller | |
| protected int | $_pageID | The pageID | from CRM_Core_Selector_Controller |
| protected int | $_pagerOffset | Offset | from CRM_Core_Selector_Controller |
| protected int | $_pagerRowCount | Number of rows to return | from CRM_Core_Selector_Controller |
| protected int | $_total | Total number of rows | from CRM_Core_Selector_Controller |
| protected | $_action | The objectAction for the WebObject | from CRM_Core_Selector_Controller |
| protected string | $_content | This caches the content for the display system | from CRM_Core_Selector_Controller |
| protected bool | $_embedded | Is this object being embedded in another object. If so the display routine needs to not do any work. (The parent object takes care of the display) | from CRM_Core_Selector_Controller |
| protected bool | $_print | Are we in print mode? if so we need to modify the display functionality to do a minimal display :) | from CRM_Core_Selector_Controller |
| protected Object | $_store | The storage object (typically a form or a page) | from CRM_Core_Selector_Controller |
| protected int | $_output | Output target, session, template or both? | from CRM_Core_Selector_Controller |
| protected int | $_prefix | Prefif for the selector variables | from CRM_Core_Selector_Controller |
| static CRM_Core_Smarty | $_template | Cache the smarty template for efficiency reasons | from CRM_Core_Selector_Controller |
| static array | $_properties | Array of properties that the controller dumps into the output object | from CRM_Core_Selector_Controller |
| protected bool | $_dynamicAction | Should we compute actions dynamically (since they are quite verbose) | from CRM_Core_Selector_Controller |
Methods
Class constructor.
Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
Heart of the Controller. This is where all the action takes place
Default function for qill.
Move the variables from the session to the template.
Details
in CRM_Core_Selector_Controller at line 196
CRM_Core_Selector_Controller
__construct(CRM_Core_Selector_API $object, int $pageID, int $sortID, int $action, CRM_Core_Page|CRM_Core_Form $store = NULL, int $output = self::TEMPLATE, null $prefix = NULL, null $case = NULL)
Class constructor.
in CRM_Core_Selector_Controller at line 264
bool
hasChanged(int $reset)
Have the GET vars changed, i.e. pageId or sortId that forces us to recompute the search values
in CRM_Core_Selector_Controller at line 302
void
run()
Heart of the Controller. This is where all the action takes place
The rows are fetched and stored depending on the type of output needed
For export/printing all rows are selected.
for displaying on screen paging parameters are used to display the required rows.
also depending on output type of session or template rows are appropriately stored in session or template variables are updated.
in CRM_Core_Selector_Controller at line 408
array
getRows(CRM_Core_Form $form)
Retrieve rows.
at line 42
string
getQill()
Default function for qill.
If needed to be implemented, we expect the subclass to do it
in CRM_Core_Selector_Controller at line 434
mixed
getSummary()
in CRM_Core_Selector_Controller at line 443
CRM_Utils_Pager
getPager()
Getter for pager.
in CRM_Core_Selector_Controller at line 452
CRM_Utils_Sort
getSort()
Getter for sort.
in CRM_Core_Selector_Controller at line 461
void
moveFromSessionToTemplate()
Move the variables from the session to the template.
in CRM_Core_Selector_Controller at line 505
void
setEmbedded(bool $embedded)
Setter for embedded.
in CRM_Core_Selector_Controller at line 515
bool
getEmbedded()
Getter for embedded.
in CRM_Core_Selector_Controller at line 526
void
setPrint(bool $print)
Setter for print.
in CRM_Core_Selector_Controller at line 536
bool
getPrint()
Getter for print.