modules/Home/UnifiedSearchAdvanced.php

Show: inherited
Table of Contents

Functions

functionunified_search_modules_cmp(  $a,  $b ) : void

Parameters
Name Type Description
$a
$b

\UnifiedSearchAdvanced

Package:

Properties

Propertypublic  $query_string= ''''
Default value''Details
Type
n/a
Propertypublic  $searchFormClass= ''SearchForm''
Default value'SearchForm'Details
Type
n/a
Propertypublic  $searchFormPath= ''include/SearchForm/SearchForm2.php''
Default value'include/SearchForm/SearchForm2.php'Details
Type
n/a

Methods

methodpublic__construct( ) : void

methodpublicbuildCache( ) : void

methodpublicgetDropDownDiv(  $tpl = 'modules/Home/UnifiedSearchAdvanced.tpl' ) : void

Parameters
Name Type Description
$tpl
methodpublicgetUnifiedSearchModules( ) : \$unified_search_modules

getUnifiedSearchModules

Returns the value of the $unified_search_modules variable based on the module's vardefs.php file and which fields are marked with the unified_search attribute.

Returns
Type Description
\$unified_search_modules Array of metadata module definitions along with their fields
methodpublicgetUnifiedSearchModulesDisplay( ) : \$unified_search_modules_display

getUnifiedSearchModulesDisplay

Returns the value of the $unified_search_modules_display variable which is based on the $unified_search_modules entries that have been selected to be allowed for searching.

Returns
Type Description
\$unified_search_modules_display Array value of modules that have enabled for searching
methodpublicretrieveEnabledAndDisabledModules( ) : array

Retrieve the enabled and disabled modules used for global search.

Returns
Type Description
array
methodpublicsaveGlobalSearchSettings( ) : void

saveGlobalSearchSettings This method handles the administrator's request to save the searchable modules selected and stores the results in the unified_search_modules_display.php file

methodpublicsearch( ) : void

search

Search function run when user goes to Show All and runs a search again. This outputs the search results calling upon the various listview display functions for each module searched on.

Todo: Sync this up with SugarSpot.php search method.

methodpublicunlinkUnifiedSearchModulesFile( ) : void
static

methodprivatewriteUnifiedSearchModulesDisplayFile(  $unified_search_modules_display ) : void

Parameters
Name Type Description
$unified_search_modules_display
Documentation was generated by DocBlox 0.18.1.