modules/Reports/SearchFormReports.php

Show:

inherited

Classes
- \SearchFormReports

Table of Contents

\SearchFormReports
jump to top

Package:

Old 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


                 $formData= ''

inheritedInherited from: \SearchForm::$$formData

Details

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


                 $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

string
                 $module= ''''

inherited

Module to use

Inherited from: \SearchForm::$$module

Default value''Details

Type: string
Inherited_from: \SearchForm::$$module


                 $nbTabs= '0'

inheritedInherited from: \SearchForm::$$nbTabs

Default value0Details

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

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


                 $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


                 $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


                 $showSavedSearchesOptions= 'true'

inheritedInherited from: \SearchForm::$$showSavedSearchesOptions

Default valuetrueDetails

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

object
                 $ss= ''

inherited

smarty object

Inherited from: \EditView::$$ss \SearchForm::$$ss

Details

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


                 $tabs= ''

inheritedInherited from: \SearchForm::$$tabs

Details

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

string
                 $template= ''

inherited

location of template to use

Inherited from: \EditView::$$template \SearchForm::$$template

Details

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


                 $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

Methods

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

inherited

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

inherited

Inherited from: \SearchForm::SearchForm()

Parameters

Name	Type	Description
$seed
$module
$action
$options

_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

display(
           $header
              =
              true
          )
        
        :
          string

inherited

Displays the template

Inherited from: \SearchForm::display()

Parameters

Name	Type	Description
$header

Returns

Type	Description
string	HTML of parsed template

displayAdvanced(
           $header
              =
              true,  $return
              =
              false,  $listViewDefs
              =
              '',  $lv
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$header
$return
$listViewDefs
$lv

displayHeader(
           $view
          )
        
        :
          void

Parameters

Name	Type	Description
$view

Details

See: \SearchForm::displayHeader()

displaySavedSearch(
          
          )
        
        :
          void

inherited

Inherited from: \SearchForm::displaySavedSearch()

displaySavedSearchSelect(
          
          )
        
        :
          void

inherited

Inherited from: \SearchForm::displaySavedSearchSelect()

displayWithHeaders(
           $view,  $basic_search_text
              =
              '',  $advanced_search_text
              =
              '',  $saved_views_text
              =
              ''
          )
        
        :
          void

Parameters

Name	Type	Description
$view
$basic_search_text
$advanced_search_text
$saved_views_text

Details

See: \SearchForm::displayWithHeaders()

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

inherited

generateSearchWhere

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

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

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(
          
          )
        
        :
          void

inherited

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

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

retrieveReportsSearchDefs(
          
          )
        
        :
          void

static

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

Details

See: \SearchForm::setup()

modules/Reports/SearchFormReports.php

\SearchFormReportsjump to top

Properties

Methods

\SearchFormReports
jump to top