include/SearchForm/SearchForm2.php

Show:

inherited

Classes
- \SearchForm

Table of Contents

\SearchForm
jump to top

Package:

Old EditView

Parent(s): \EditView
Children: \SearchFormReports; \EmployeesSearchForm

Properties


                 $action= ''index''

Default value'index'Details

Type: n/a


                 $customFieldDefs= ''

Details

Type: n/a


                 $displaySavedSearch= 'true'

Default valuetrueDetails

Type: n/a


                 $displayType= ''searchView''

Default value'searchView'Details

Type: n/a


                 $displayView= ''basic_search''

Default value'basic_search'Details

Type: n/a


                 $fieldDefs= ''

Details

Type: n/a


                 $formData= ''

Details

Type: n/a


                 $listViewDefs= 'array()'

Default valuearray()Details

Type: n/a


                 $lv= ''

Details

Type: n/a

string
                 $module= ''''

Module to use

Default value''Details

Type: string


                 $nbTabs= '0'

Default value0Details

Type: n/a

array
                 $options= ''

Details

Type: array


                 $parsedView= ''basic''

Default value'basic'Details

Type: n/a


                 $searchFields= ''

Details

Type: n/a


                 $searchdefs= 'array()'

Default valuearray()Details

Type: n/a


                 $seed= 'null'

Default valuenullDetails

Type: n/a


                 $showAdvanced= 'true'

Default valuetrueDetails

Type: n/a


                 $showBasic= 'true'

Default valuetrueDetails

Type: n/a


                 $showCustom= 'false'

Default valuefalseDetails

Type: n/a


                 $showSavedSearchesOptions= 'true'

Default valuetrueDetails

Type: n/a

object
                 $ss= ''

inherited

smarty object

Inherited from: \EditView::$$ss

Details

Type: object
Inherited_from: \EditView::$$ss


                 $tabs= ''

Details

Type: n/a

string
                 $template= ''

inherited

location of template to use

Inherited from: \EditView::$$template

Details

Type: string
Inherited_from: \EditView::$$template


                 $th= ''

Details

Type: n/a


                 $tpl= ''

Details

Type: n/a


                 $view= ''SearchForm''

Default value'SearchForm'Details

Type: n/a

Methods

EditView(
          string $module, string $template
          )
        
        :
          void

inherited

Inherited from: \EditView::EditView()

Parameters

Name	Type	Description
$module	string	module to use
$template	string	template of the form to retreive

SearchForm(
           $seed,  $module,  $action
              =
              'index',  $options
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$seed
$module
$action
$options

_build_field_defs(
          
          )
        
        :
          void

_displayTabs(
          string $currentKey
          )
        
        :
          string

displays the tabs (top of the search form)

Parameters

Name	Type	Description
$currentKey	string	key in $this->tabs to show as the current tab

Returns

Type	Description
string	html

display(
           $header
              =
              true
          )
        
        :
          string

Displays the template

Parameters

Name	Type	Description
$header

Returns

Type	Description
string	HTML of parsed template

displaySavedSearch(
          
          )
        
        :
          void

displaySavedSearchSelect(
          
          )
        
        :
          void

generateSearchWhere(
          bool $add_custom_fields
              =
              false, string $module
              =
              ''
          )
        
        :
          string

generateSearchWhere

This function serves as the central piece of SearchForm2.php It is responsible for creating the WHERE clause for a given search operation

Parameters

Name	Type	Description
$add_custom_fields	bool	boolean indicating whether or not custom fields should be added
$module	string	Module to search against

Returns

Type	Description
string	the SQL WHERE clause based on the arguments supplied in SearchForm2 instance

getOptions(
          
          )
        
        :
          array

Get Options

Returns

Type	Description
array

isEmptyDropdownField(
          \$value $name
              =
              '',  $value
              =
              array()
          )
        
        :
          void

isEmptyDropdownField

This function checks to see if a blank dropdown field was supplied. This scenario will occur where a dropdown select is in single selection mode

Parameters

Name	Type	Description
$name	\$value	Mixed dropdown value
$value

locateFile(
          string $file
          )
        
        :
          bool | string

Locate a file in the custom or stock folders. Look in the custom folders first.

Parameters

Name	Type	Description
$file	string	The file we are looking for

Returns

Type	Description
bool \| string	If the file is found return the path, False if not

parseDateExpression(
          string $operator, string $db_field, string $field_type
              =
              ''
          )
        
        :
          void

Parse date expression and return WHERE clause

Parameters

Name	Type	Description
$operator	string	Date expression operator
$db_field	string	DB field name
$field_type	string	DB field type

populateFromArray(
          array $array, string $switchVar
              =
              null, bool $addAllBeanFields
              =
              true
          )
        
        :
          void

Populate the searchFields from an array

Parameters

Name	Type	Description
$array	array	array to search through
$switchVar	string	variable to use in switch statement
$addAllBeanFields	bool	true to process at all bean fields

populateFromRequest(
          string $switchVar
              =
              null, bool $addAllBeanFields
              =
              true
          )
        
        :
          void

Populate the searchFields from $_REQUEST

Parameters

Name	Type	Description
$switchVar	string	variable to use in switch statement
$addAllBeanFields	bool	true to process at all bean fields

process(
          
          )
        
        :
          void

inherited

Processes / setups the template assigns all things to the template like mod_srings and app_strings

Inherited from: \EditView::process()

retrieveSearchDefs(
           $module
          )
        
        :
          void

static

Return the search defs for a particular module.

Parameters

Name	Type	Description
$module

Details

Static

setOptions(
          array $options
              =
              null
          )
        
        :
          \SearchForm2

Set options

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\SearchForm2

setup(
           $searchdefs,  $searchFields
              =
              array(),  $tpl,  $displayView
              =
              'basic_search',  $listViewDefs
              =
              array()
          )
        
        :
          void

Parameters

Name	Type	Description
$searchdefs
$searchFields
$tpl
$displayView
$listViewDefs

include/SearchForm/SearchForm2.php

\SearchFormjump to top

Properties

Methods

\SearchForm
jump to top