Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.
 All Data Structures Functions Variables Pages
Public Member Functions | Static Public Member Functions | Protected Member Functions | Protected Attributes
SearchView Class Reference
Inheritance diagram for SearchView:
ModelView ConfigurableMetadataView MetadataView View AccountsModalSearchView ContactsModalSearchView DynamicSearchView EmailTemplatesModalSearchView EmailTemplatesSearchView GameRewardsModalSearchView ImagesModalSearchView LeadsModalSearchView MarketingListsModalSearchView OpportunitiesModalSearchView ProductsModalSearchView ProductTemplatesModalSearchView ProjectsModalSearchView ReportsModalSearchView SharedCalendarsModalSearchView UsersModalSearchView WorkflowInQueuesSearchView WorkflowMessageInQueuesSearchView

Public Member Functions

 __construct ($model, $listModelClassName, $gridIdSuffix=null, $hideAllSearchPanelsToStart=false)
 
- Public Member Functions inherited from ModelView
 getModelClassName ()
 
- Public Member Functions inherited from View
 isUniqueToAPage ()
 
 render ()
 
 setCssClasses (array $classes)
 
 getCssClasses ()
 
 getTitle ()
 
 getPostTruncatedTitleContent ()
 

Static Public Member Functions

static getDefaultMetadata ()
 
static getDesignerRulesType ()
 

Protected Member Functions

 renderContent ()
 
 getEnableAjaxValidationValue ()
 
 getClientOptions ()
 
 getFormActionUrl ()
 
 renderAfterFormLayout ($form)
 
 renderFormBottomPanel ()
 
 resolveMoreSearchOptionsLinkContent ()
 
 getClearSearchLabelPrefixContent ()
 
 getClearSearchLabelContent ()
 
 getClearSearchLinkStartingStyle ()
 
 getExtraRenderForClearSearchLinkScript ()
 
 renderClearingSearchInputContent ()
 
 getClearingSearchInputId ()
 
 registerScripts ()
 
 renderAdvancedSearchScripts ()
 
 getHideOrShowClearSearchLinkScript ()
 
 renderFormBottomPanelExtraLinks ()
 
 getExtraQueryPartForSearchFormScriptSubmitFunction ()
 
 getExtraRenderFormBottomPanelScriptPart ()
 
 renderFormLayout (ZurmoActiveForm $form)
 
 renderSummaryCloneContent ()
 
 getSelectListAttributesLinkContent ()
 
 renderListAttributesSelectionContent (ZurmoActiveForm $form)
 
 getKanbanBoardOptionsLinkContent ()
 
 renderKanbanBoardOptionsContent (ZurmoActiveForm $form)
 
 renderViewToolBarContainerForAdvancedSearch ($form)
 
 renderViewToolBarLinksForAdvancedSearch ($form)
 
 renderSaveInputAndSaveButtonContentForAdvancedSearch ($form)
 
 renderAdvancedSearchForFormLayout ($panel, $maxCellsPerRow, $form)
 
 renderStaticSearchRows ($panel, $maxCellsPerRow, $form=null)
 
 getColumnCount ($metadata)
 
 getSearchFormId ()
 
 getListViewId ()
 
 getMaxCellsPerRow ()
 
 renderModalContainer ()
 
 renderStarredFilterHidenField ($form)
 
 renderFiltersContent ($form)
 
- Protected Member Functions inherited from View
 resolveDefaultClasses ()
 
 renderContainerWrapperId ()
 
 getContainerWrapperTag ()
 
 getId ()
 
 renderContent ()
 
 getViewStyle ()
 
 renderTitleContent ()
 
 resolveCustomViewTemplateFileName ($theme, $view)
 

Protected Attributes

 $gridIdSuffix
 
 $hideAllSearchPanelsToStart
 
 $showAdvancedSearch = true
 
- Protected Attributes inherited from ModelView
 $modelClassName
 
- Protected Attributes inherited from View
 $cssClasses = array()
 
 $title
 
 $makeDefaultClassesFromClassHeirarchy = true
 

Additional Inherited Members

- Static Protected Member Functions inherited from ModelView
static assertMetadataIsValid (array $metadata)
 

Detailed Description

The base View for a module's search view.

Definition at line 40 of file SearchView.php.

Constructor & Destructor Documentation

__construct (   $model,
  $listModelClassName,
  $gridIdSuffix = null,
  $hideAllSearchPanelsToStart = false 
)

Constructs a detail view specifying the controller as well as the model that will have its details displayed.

Definition at line 52 of file SearchView.php.

Member Function Documentation

renderContent ( )
protected

Renders content for a view including search form including two panels, the second of which is hidden on default, and bottom panel with a search buttom and 'advanced search' link and form layout.

Returns
A string containing the element's content.

Definition at line 75 of file SearchView.php.

renderFormBottomPanel ( )
protected

Renders the bottom panel of the layout. Includes the search button and the advanced search link that opens/closes the second panel. Using click.clear namespace to avoid collision with the binding from clearform.

Returns
A string containing the element's content.

Definition at line 124 of file SearchView.php.

getHideOrShowClearSearchLinkScript ( )
protected

Override as needed.

Returns
string the script to show/hide the clear link if depending on if there is any search condition

Definition at line 257 of file SearchView.php.

renderFormBottomPanelExtraLinks ( )
protected

Override as needed.

Definition at line 283 of file SearchView.php.

getExtraQueryPartForSearchFormScriptSubmitFunction ( )
protected

Override as needed.

Definition at line 291 of file SearchView.php.

getExtraRenderFormBottomPanelScriptPart ( )
protected

Override as needed.

Definition at line 299 of file SearchView.php.

renderFormLayout ( ZurmoActiveForm  $form)
protected

Render a search form that has two panels. The second panel is hidden by default in the user interface.

Returns
A string containing the element's content.

Definition at line 316 of file SearchView.php.

getKanbanBoardOptionsLinkContent ( )
protected
Returns
string

Definition at line 412 of file SearchView.php.

renderKanbanBoardOptionsContent ( ZurmoActiveForm  $form)
protected
Parameters
ZurmoActiveForm$form
Returns
string

Definition at line 424 of file SearchView.php.

static getDefaultMetadata ( )
static

Returns meta data for use in automatically generating the view. The meta data is comprised of two panels, n rows, and then n cells. Each cell can have 1 or more elements.

For search view, there should only be two panels. The second panel is hidden by default in the user interface and is where the 'advanced search' inputs are placed.

The element takes 3 parameters. The first parameter is 'attributeName' The second parameter is 'type' and refers to the element type. Using a type of 'Text' would utilize the TextElement class. The third parameter is 'wide' and refers to how many cells the field should span. An example of the 'wide' => true usage would be for a text description field. Here is an example meta data that defines a search layout with two panels. Each panel has 1 row with 2 cells each

<?php
$metadata = array(
'global' => array(
'panels' => array(
array(
'title' => 'Basic Search',
'rows' => array(
array('cells' =>
array(
array(
'elements' => array(
array('attributeName' => 'name', 'type' => 'Text'),
),
),
array(
'elements' => array(
array('attributeName' => 'officePhone', 'type' => 'Text'),
),
),
)
),
),
),
array(
'title' => 'Advanced Search',
'rows' => array(
array('cells' =>
array(
array(
'elements' => array(
array('attributeName' => 'industry', 'type' => 'DropDown'),
),
),
array(
'elements' => array(
array('attributeName' => 'officeFax', 'type' => 'Text'),
),
),
)
),
),
),
),
),
);
?>

Definition at line 584 of file SearchView.php.

renderStarredFilterHidenField (   $form)
protected

Render a hidden field to filter models by starred only

Parameters
ZurmoActiveForm$form
Returns
string

Definition at line 645 of file SearchView.php.

renderFiltersContent (   $form)
protected

This should be used to render the filters buttons element

Parameters
$form
Returns
null|string

Definition at line 661 of file SearchView.php.


The documentation for this class was generated from the following file:
Generated on Thu Aug 6 2020 07:10:59
Account Suspended
Account Suspended
This Account has been suspended.
Contact your hosting provider for more information.