include/SearchForm/SearchForm2.php

Show:

inherited

Classes
- \SearchForm

Table of Contents

\SearchForm
jump to top

Package:

New 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


                 $focus= ''

inheritedInherited from: \EditView::$$focus

Details

Type: n/a
Inherited_from: \EditView::$$focus


                 $footerTpl= ''

inheritedInherited from: \EditView::$$footerTpl

Details

Type: n/a
Inherited_from: \EditView::$$footerTpl


                 $formData= ''

Details

Type: n/a


                 $formName= ''''

inheritedInherited from: \EditView::$$formName

Default value''Details

Type: n/a
Inherited_from: \EditView::$$formName


                 $formatFields= 'true'

inheritedInherited from: \EditView::$$formatFields

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$formatFields


                 $headerTpl= ''

inheritedInherited from: \EditView::$$headerTpl

Details

Type: n/a
Inherited_from: \EditView::$$headerTpl


                 $id= ''

inheritedInherited from: \EditView::$$id

Details

Type: n/a
Inherited_from: \EditView::$$id


                 $isDuplicate= ''

inheritedInherited from: \EditView::$$isDuplicate

Details

Type: n/a
Inherited_from: \EditView::$$isDuplicate


                 $listViewDefs= 'array()'

Default valuearray()Details

Type: n/a


                 $lv= ''

Details

Type: n/a


                 $metadataFile= ''

inheritedInherited from: \EditView::$$metadataFile

Details

Type: n/a
Inherited_from: \EditView::$$metadataFile


                 $module= ''''

Default value''Details

Type: n/a


                 $moduleTitleKey= ''

inheritedInherited from: \EditView::$$moduleTitleKey

Details

Type: n/a
Inherited_from: \EditView::$$moduleTitleKey


                 $nbTabs= '0'

Default value0Details

Type: n/a


                 $notes= ''

inheritedInherited from: \EditView::$$notes

Details

Type: n/a
Inherited_from: \EditView::$$notes


                 $offset= '0'

inheritedInherited from: \EditView::$$offset

Default value0Details

Type: n/a
Inherited_from: \EditView::$$offset

array
                 $options= ''

Details

Type: array


                 $parsedView= ''basic''

Default value'basic'Details

Type: n/a


                 $populateBean= 'true'

inheritedInherited from: \EditView::$$populateBean

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$populateBean


                 $quickSearchCode= ''

inheritedInherited from: \EditView::$$quickSearchCode

Details

Type: n/a
Inherited_from: \EditView::$$quickSearchCode


                 $returnAction= ''

inheritedInherited from: \EditView::$$returnAction

Details

Type: n/a
Inherited_from: \EditView::$$returnAction


                 $returnId= ''

inheritedInherited from: \EditView::$$returnId

Details

Type: n/a
Inherited_from: \EditView::$$returnId


                 $returnModule= ''

inheritedInherited from: \EditView::$$returnModule

Details

Type: n/a
Inherited_from: \EditView::$$returnModule


                 $searchFields= ''

Details

Type: n/a


                 $searchdefs= 'array()'

Default valuearray()Details

Type: n/a


                 $sectionPanels= ''

inheritedInherited from: \EditView::$$sectionPanels

Details

Type: n/a
Inherited_from: \EditView::$$sectionPanels


                 $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


                 $showDetailData= 'true'

inheritedInherited from: \EditView::$$showDetailData

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showDetailData


                 $showSavedSearchesOptions= 'true'

Default valuetrueDetails

Type: n/a


                 $showSectionPanelsTitles= 'true'

inheritedInherited from: \EditView::$$showSectionPanelsTitles

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showSectionPanelsTitles


                 $showVCRControl= 'true'

inheritedInherited from: \EditView::$$showVCRControl

Default valuetrueDetails

Type: n/a
Inherited_from: \EditView::$$showVCRControl


                 $ss= ''

inheritedInherited from: \EditView::$$ss

Details

Type: n/a
Inherited_from: \EditView::$$ss


                 $tabs= ''

Details

Type: n/a


                 $th= ''

Details

Type: n/a


                 $tpl= ''

Details

Type: n/a


                 $view= ''SearchForm''

Default value'SearchForm'Details

Type: n/a


                 $viewObject= 'null'

inheritedInherited from: \EditView::$$viewObject

Default valuenullDetails

Type: n/a
Inherited_from: \EditView::$$viewObject

Methods

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

callFunction(
           $vardef
          )
        
        :
          void

inherited

Inherited from: \EditView::callFunction()

Parameters

Name	Type	Description
$vardef

createFocus(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::createFocus()

display(
           $header
              =
              true
          )
        
        :
          \HTML

display This method makes the Smarty variable assignments and then displays the generated view.

Parameters

Name	Type	Description
$header

Returns

Type	Description
\HTML	display for view as String

displaySavedSearch(
          
          )
        
        :
          void

displaySavedSearchSelect(
          
          )
        
        :
          void

enableFormatting(
          \$format $format
              =
              true
          )
        
        :
          void

inherited

enableFormatting This method is used to manually turn on/off the field formatting

Inherited from: \EditView::enableFormatting()

Parameters

Name	Type	Description
$format	\$format	boolean value to turn on/off field formatting

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

getPanelWithFillers(
          array $panel
          )
        
        :
          array

inherited

Adds fillers to each row if required

Inherited from: \EditView::getPanelWithFillers()

Panel alignment will be off if the panel doesn't have a row with the max column It will not be aligned to the other panels so we fill out the columns in the last row

Parameters

Name	Type	Description
$panel	array

Returns

Type	Description
array

getTemplateHandler(
          
          )
        
        :
          \TemplateHandler

inherited

Get template handler object

Inherited from: \EditView::getTemplateHandler()

Returns

Type	Description
\TemplateHandler

getValueFromRequest(
          \request $request, \name $name
          )
        
        :
          String

inherited

getValueFromRequest This is a helper method to extract a value from the request Array. We do some special processing for fields that start with 'date_' by checking to see if they also include time and meridiem values

Inherited from: \EditView::getValueFromRequest()

Parameters

Name	Type	Description
$request	\request	The request Array
$name	\name	The field name to extract value for

Returns

Type	Description
String	value for given name

insertJavascript(
           $javascript
          )
        
        :
          void

inherited

Inherited from: \EditView::insertJavascript()

Parameters

Name	Type	Description
$javascript

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

populateBean(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::populateBean()

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(
           $checkFormName
              =
              false,  $formName
              =
              ''
          )
        
        :
          void

inherited

Inherited from: \EditView::process()

Parameters

Name	Type	Description
$checkFormName
$formName

render(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::render()

requiredFirst(
          
          )
        
        :
          void

inherited

Enter description here ...

Inherited from: \EditView::requiredFirst()

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(), \$metadataFile $tpl,  $displayView
              =
              'basic_search',  $listViewDefs
              =
              array()
          )
        
        :
          void

EditView constructor This is the EditView constructor responsible for processing the new Meta-Data framework

Parameters

Name	Type	Description
$searchdefs
$searchFields
$tpl	\$metadataFile	String value of file location to use in overriding default metadata file
$displayView
$listViewDefs

showTitle(
           $showTitle
              =
              false
          )
        
        :
          void

inherited

Allow Subviews to overwrite this method to show custom titles.

Inherited from: \EditView::showTitle()

Examples: Projects & Project Templates. params: $showTitle: boolean for backwards compatibility.

Parameters

Name	Type	Description
$showTitle

include/SearchForm/SearchForm2.php

\SearchFormjump to top

Properties

Methods

\SearchForm
jump to top