modules/Employees/EmployeesSearchForm.php

Show:

inherited

Classes
- \EmployeesSearchForm

Table of Contents

\EmployeesSearchForm
jump to top

Package:

New EditView

Parent(s): \SearchForm < \EditView

Properties


                 $action= ''index''

inheritedInherited from: \SearchForm::$$action

Default value'index'Details

Type: n/a
Inherited_from: \SearchForm::$$action


                 $customFieldDefs= ''

inheritedInherited from: \SearchForm::$$customFieldDefs

Details

Type: n/a
Inherited_from: \SearchForm::$$customFieldDefs


                 $displaySavedSearch= 'true'

inheritedInherited from: \SearchForm::$$displaySavedSearch

Default valuetrueDetails

Type: n/a
Inherited_from: \SearchForm::$$displaySavedSearch


                 $displayType= ''searchView''

inheritedInherited from: \SearchForm::$$displayType

Default value'searchView'Details

Type: n/a
Inherited_from: \SearchForm::$$displayType


                 $displayView= ''basic_search''

inheritedInherited from: \SearchForm::$$displayView

Default value'basic_search'Details

Type: n/a
Inherited_from: \SearchForm::$$displayView


                 $fieldDefs= ''

inheritedInherited from: \SearchForm::$$fieldDefs

Details

Type: n/a
Inherited_from: \SearchForm::$$fieldDefs


                 $focus= ''

inheritedInherited from: \EditView::$$focus \SearchForm::$$focus

Details

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


                 $footerTpl= ''

inheritedInherited from: \EditView::$$footerTpl \SearchForm::$$footerTpl

Details

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


                 $formData= ''

inheritedInherited from: \SearchForm::$$formData

Details

Type: n/a
Inherited_from: \SearchForm::$$formData


                 $formName= ''''

inheritedInherited from: \EditView::$$formName \SearchForm::$$formName

Default value''Details

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


                 $formatFields= 'true'

inheritedInherited from: \EditView::$$formatFields \SearchForm::$$formatFields

Default valuetrueDetails

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


                 $headerTpl= ''

inheritedInherited from: \EditView::$$headerTpl \SearchForm::$$headerTpl

Details

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


                 $id= ''

inheritedInherited from: \EditView::$$id \SearchForm::$$id

Details

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


                 $isDuplicate= ''

inheritedInherited from: \EditView::$$isDuplicate \SearchForm::$$isDuplicate

Details

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


                 $listViewDefs= 'array()'

inheritedInherited from: \SearchForm::$$listViewDefs

Default valuearray()Details

Type: n/a
Inherited_from: \SearchForm::$$listViewDefs


                 $lv= ''

inheritedInherited from: \SearchForm::$$lv

Details

Type: n/a
Inherited_from: \SearchForm::$$lv


                 $metadataFile= ''

inheritedInherited from: \EditView::$$metadataFile \SearchForm::$$metadataFile

Details

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


                 $module= ''''

inheritedInherited from: \SearchForm::$$module

Default value''Details

Type: n/a
Inherited_from: \SearchForm::$$module


                 $moduleTitleKey= ''

inheritedInherited from: \EditView::$$moduleTitleKey \SearchForm::$$moduleTitleKey

Details

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


                 $nbTabs= '0'

inheritedInherited from: \SearchForm::$$nbTabs

Default value0Details

Type: n/a
Inherited_from: \SearchForm::$$nbTabs


                 $notes= ''

inheritedInherited from: \EditView::$$notes \SearchForm::$$notes

Details

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


                 $offset= '0'

inheritedInherited from: \EditView::$$offset \SearchForm::$$offset

Default value0Details

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

array
                 $options= ''

inherited

Inherited from: \SearchForm::$$options

Details

Type: array
Inherited_from: \SearchForm::$$options


                 $parsedView= ''basic''

inheritedInherited from: \SearchForm::$$parsedView

Default value'basic'Details

Type: n/a
Inherited_from: \SearchForm::$$parsedView


                 $populateBean= 'true'

inheritedInherited from: \EditView::$$populateBean \SearchForm::$$populateBean

Default valuetrueDetails

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


                 $quickSearchCode= ''

inheritedInherited from: \EditView::$$quickSearchCode \SearchForm::$$quickSearchCode

Details

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


                 $returnAction= ''

inheritedInherited from: \EditView::$$returnAction \SearchForm::$$returnAction

Details

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


                 $returnId= ''

inheritedInherited from: \EditView::$$returnId \SearchForm::$$returnId

Details

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


                 $returnModule= ''

inheritedInherited from: \EditView::$$returnModule \SearchForm::$$returnModule

Details

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


                 $searchFields= ''

inheritedInherited from: \SearchForm::$$searchFields

Details

Type: n/a
Inherited_from: \SearchForm::$$searchFields


                 $searchdefs= 'array()'

inheritedInherited from: \SearchForm::$$searchdefs

Default valuearray()Details

Type: n/a
Inherited_from: \SearchForm::$$searchdefs


                 $sectionPanels= ''

inheritedInherited from: \EditView::$$sectionPanels \SearchForm::$$sectionPanels

Details

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


                 $seed= 'null'

inheritedInherited from: \SearchForm::$$seed

Default valuenullDetails

Type: n/a
Inherited_from: \SearchForm::$$seed


                 $showAdvanced= 'true'

inheritedInherited from: \SearchForm::$$showAdvanced

Default valuetrueDetails

Type: n/a
Inherited_from: \SearchForm::$$showAdvanced


                 $showBasic= 'true'

inheritedInherited from: \SearchForm::$$showBasic

Default valuetrueDetails

Type: n/a
Inherited_from: \SearchForm::$$showBasic


                 $showCustom= 'false'

inheritedInherited from: \SearchForm::$$showCustom

Default valuefalseDetails

Type: n/a
Inherited_from: \SearchForm::$$showCustom


                 $showDetailData= 'true'

inheritedInherited from: \EditView::$$showDetailData \SearchForm::$$showDetailData

Default valuetrueDetails

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


                 $showSavedSearchesOptions= 'true'

inheritedInherited from: \SearchForm::$$showSavedSearchesOptions

Default valuetrueDetails

Type: n/a
Inherited_from: \SearchForm::$$showSavedSearchesOptions


                 $showSectionPanelsTitles= 'true'

inheritedInherited from: \EditView::$$showSectionPanelsTitles \SearchForm::$$showSectionPanelsTitles

Default valuetrueDetails

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


                 $showVCRControl= 'true'

inheritedInherited from: \EditView::$$showVCRControl \SearchForm::$$showVCRControl

Default valuetrueDetails

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


                 $ss= ''

inheritedInherited from: \EditView::$$ss \SearchForm::$$ss

Details

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


                 $tabs= ''

inheritedInherited from: \SearchForm::$$tabs

Details

Type: n/a
Inherited_from: \SearchForm::$$tabs


                 $th= ''

inheritedInherited from: \SearchForm::$$th

Details

Type: n/a
Inherited_from: \SearchForm::$$th


                 $tpl= ''

inheritedInherited from: \SearchForm::$$tpl

Details

Type: n/a
Inherited_from: \SearchForm::$$tpl


                 $view= ''SearchForm''

inheritedInherited from: \SearchForm::$$view

Default value'SearchForm'Details

Type: n/a
Inherited_from: \SearchForm::$$view


                 $viewObject= 'null'

inheritedInherited from: \EditView::$$viewObject \SearchForm::$$viewObject

Default valuenullDetails

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

Methods

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

inherited

Inherited from: \SearchForm::SearchForm()

Parameters

Name	Type	Description
$seed
$module
$action
$options

__construct(
           $oldSearchForm
          )
        
        :
          void

This builds an EmployeesSearchForm from a classic search form.

Parameters

Name	Type	Description
$oldSearchForm

_build_field_defs(
          
          )
        
        :
          void

inherited

Inherited from: \SearchForm::_build_field_defs()

_displayTabs(
          string $currentKey
          )
        
        :
          string

inherited

displays the tabs (top of the search form)

Inherited from: \SearchForm::_displayTabs()

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()\SearchForm::callFunction()

Parameters

Name	Type	Description
$vardef

createFocus(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::createFocus()\SearchForm::createFocus()

display(
           $header
              =
              true
          )
        
        :
          \HTML

inherited

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

Inherited from: \SearchForm::display()

Parameters

Name	Type	Description
$header

Returns

Type	Description
\HTML	display for view as String

displaySavedSearch(
          
          )
        
        :
          void

inherited

Inherited from: \SearchForm::displaySavedSearch()

displaySavedSearchSelect(
          
          )
        
        :
          void

inherited

Inherited from: \SearchForm::displaySavedSearchSelect()

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

inherited

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

Inherited from: \EditView::enableFormatting()\SearchForm::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

inherited

Get Options

Inherited from: \SearchForm::getOptions()

Returns

Type	Description
array

getPanelWithFillers(
          array $panel
          )
        
        :
          array

inherited

Adds fillers to each row if required

Inherited from: \EditView::getPanelWithFillers()\SearchForm::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()\SearchForm::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()\SearchForm::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()\SearchForm::insertJavascript()

Parameters

Name	Type	Description
$javascript

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

inherited

isEmptyDropdownField

Inherited from: \SearchForm::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

inherited

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

Inherited from: \SearchForm::locateFile()

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

inherited

Parse date expression and return WHERE clause

Inherited from: \SearchForm::parseDateExpression()

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()\SearchForm::populateBean()

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

inherited

Populate the searchFields from an array

Inherited from: \SearchForm::populateFromArray()

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

inherited

Populate the searchFields from $_REQUEST

Inherited from: \SearchForm::populateFromRequest()

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()\SearchForm::process()

Parameters

Name	Type	Description
$checkFormName
$formName

render(
          
          )
        
        :
          void

inherited

Inherited from: \EditView::render()\SearchForm::render()

requiredFirst(
          
          )
        
        :
          void

inherited

Enter description here ...

Inherited from: \EditView::requiredFirst()\SearchForm::requiredFirst()

retrieveSearchDefs(
           $module
          )
        
        :
          void

staticinherited

Return the search defs for a particular module.

Inherited from: \SearchForm::retrieveSearchDefs()

Parameters

Name	Type	Description
$module

Details

Static

setOptions(
          array $options
              =
              null
          )
        
        :
          \SearchForm2

inherited

Set options

Inherited from: \SearchForm::setOptions()

Parameters

Name	Type	Description
$options	array

Returns

Type	Description
\SearchForm2

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

inherited

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

Inherited from: \SearchForm::setup()

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()\SearchForm::showTitle()

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

Parameters

Name	Type	Description
$showTitle

modules/Employees/EmployeesSearchForm.php

\EmployeesSearchFormjump to top

Properties

Methods

\EmployeesSearchForm
jump to top