phpPeanuts  2.2.0
phpPeanuts framework
 All Data Structures Namespaces Files Functions Variables
Public Member Functions | Data Fields
PntFilterFormPart Class Reference

Inherits PntPagePart.

Inherited by FilterFormPart, and PntMtoNFilterFormPart.

Public Member Functions

 getName ()
 
 getNadvancedFilters ()
 
 getNSorts ()
 
 getFilterId ($num=1)
 
 getFilterCmp ($num=1)
 
 getFilterCombinators ()
 
 getFilterCombinator ($num)
 
 getFilterValue1 ($num=1)
 
 getFilterValue2 ($num=1)
 
 getFilter1Id ()
 
 getFilter1Cmp ()
 
 getFilter1Value1 ()
 
 getFilter1Value2 ()
 
 getAllItemsSize ()
 
 getPageItemOffset ()
 
 getSortIsSpecific ()
 
 getSortId ($num=1)
 
 getSortDirection ($num=1)
 
 printSearchButtonLabel ()
 
 getCombinatorOptions ()
 
 printCancelButtonLabel ()
 
 printDivDisplayStyle ($divId)
 
 printExtraFormParameters ()
 
 getExtraFormParameterKeys ()
 
 printFilterSelectWidget ($num=1)
 
 printComparatorSelectWidget ($num=1)
 
 getComparators ()
 
 printCombinatorSelectWidget ($num)
 
 getRequestedObject ()
 
 printAdvancedFilterDescriptions ()
 
 printAdvancedFilterDescription ($filter)
 
 printAdvancedFilterDivs ()
 
 printAdvancedFilterDiv ($num)
 
 showAdvancedFilterDiv ($num)
 
 printSortParams ()
 
 getFormName ()
 
 getFilter ()
 
 getCombinedAdvancedFilters ()
 
 advancedFilterCombine ($currentFilter, $nextFilter, $combinator, $id)
 
 advancedFilterOr ($currentFilter, $nextFilter, $id)
 
 getInitializedAdvancedFilters ()
 
 getFilters ()
 
 getNewCombiFilter ($id)
 
 getAllStringfieldsFilter ()
 
 getErrorInfo ()
 
 findFilter ($filter, $path)
 
 initFilter ($filter, $addWildcards=false, $num=1)
 
 convertFilterValue ($conv, $filter, $value)
 
 getFilterValue1ForInit ($filter, $num=1)
 
 addWildcards ($filterValue)
 
 getSort ($filter)
 
 getSortSpecified ()
 
 getSortDefault ($filter)
 
 getCombinedFilter ()
 
 getFilterResult ($rowCount=20)
 
 runQhStoreAllItemsSize_getItemsLimitedTo ($qh, $rowCount)
 
 getImplicitCombiFilter ()
 
 getImplicitCombiFilterDefault ()
 
 setImplicitCombiFilter ($combiFilter)
 
 printSortDialogScripts ()
 
 getOwnFormParameterKeys ()
 
 _runQhStoreAllItemsSize_getItemsLimitedTo ($qh, $rowCount)
 
- Public Member Functions inherited from PntPagePart
 printBody ()
 
 ajaxPrintUpdates ($preFix='')
 
 getThisPntHandlerName ()
 
 getType ()
 
 getRequestedObject ()
 
 getFormTexts ()
 
 getOwnFormTexts ()
 
 getFootprintId ()
 
 getExcludedMultiValuePropButtonKeys ()
 
- Public Member Functions inherited from PntPage
 getInfoStyle ()
 
 setInfoStyle ($value)
 
 printHeader ()
 
 printFooter ()
 
 printBodyTagIeExtraPiece ()
 
 includeSkin ($name, $param=null)
 
 printSetTitle ($title=null)
 
 getButton ($caption, $script, $ghost=false, $len=null)
 
 handleRequest ()
 
 getPartId ()
 
 ajaxHandleRequest ()
 
 ajaxPrintHeaders ()
 
 ajaxPrintUpdates ($preFix='')
 
 getAjaxUpdatePartIds ()
 
 getAjaxUpdateSubPartIds ($prefix)
 
 ajaxShouldUpdate ($partId, $partName=null, $extraParam=null)
 
 ajaxPrintPartUpdate ($partName, $partId=null, $extraParam=null)
 
 isRequestAjax ()
 
 ajaxPrintPartAttributes ()
 
 getAjaxLoadingMessage ()
 
 initForHandleRequest ()
 
 checkAccess ()
 
 isLayoutReport ()
 
 printHeaders ()
 
 printHeaderXframeOptions ()
 
 getCharset ()
 
 printBody ()
 
 printMainPart ()
 
 printPart ($partName)
 
 imp_printPart ($args)
 
 getPart ($args, $cache=true)
 
 getPartIncludeTryParams ($partName)
 
 getSpecificPartPrefix ($partName=null)
 
 printPartDebugComment ($partName, $debug)
 
 printInformationPart ()
 
 getFilterPartString ()
 
 getButtonsList ()
 
 addMultiValuePropertyButtons (&$buttons)
 
 getExcludedMultiValuePropButtonKeys ()
 
 getMultiValuePropertyButtonScript ($propName, $edit=false)
 
 getThisPntContext ()
 
 getDetailsHref ($appName, $pntType)
 
 getLinkDirFromNav ($nav, $pntHandler='')
 
 getTargetAppName ($nav, $pntHandler='')
 
 getDetailsLinkPntHandler ()
 
 getNoItemsMessage ()
 
 getRequestDuration ()
 
 getConvert ($obj, $path, $kind=0, $preformatAndTab=0)
 
 getInitConverter ($prop)
 
 addContextButtonTo (&$buttons)
 
 doScouting ()
 
 getFootprintId ()
 
 printFootprintJsLiteral ($quote="'")
 
 getPropertyName ()
 
 printNextActionTicket ()
 
 getAndCreateNextActionTicket ()
 
 printExtraHeaders ()
 
 getImagesDir ()
 
- Public Member Functions inherited from PntRequestHandler
 __construct ($whole, $requestData)
 
 getDir ()
 
 getDomainDir ($type=null)
 
 getBaseUrl ()
 
 getConverter ()
 
 getDebugMode ()
 
 initForHandleRequest ()
 
 startSession ()
 
 getContextHref ($footprintId)
 
 getController ()
 
 getScout ()
 
 getGlobalFilters ()
 
 forwardRequest ($requestData, $information=null)
 
 redirectRequest ($requestData, $information=null, $dir=null)
 
 queryStringFrom ($requestData, $param=null)
 
 getRequestParam ($key)
 
 getReqParam ($key, $asHtml=false)
 
 htOut ($aString)
 
 getRequestHandler ($requestData, $dir=null)
 
 tryUseHandlerClass ($handlerClass, &$attempted)
 
 getHandlersTriedString ($attempted)
 
 __toString ()
 
 toString ()
 
 getLabel ()
 
 getName ()
 
 getThisPntHandlerName ()
 
 getInformation ()
 
 getEventualItemNotFoundMessage ()
 
 setInformation ($value)
 
 getTypeLabel ()
 
 getType ()
 
 checkAlphaNumeric ($value)
 
 getTryUseClassTryParams ($className, $dir)
 
 getIncludesDir ()
 
 tryUseClass ($className, $dir)
 
 useClass ($className, $dir)
 
 getTypeClassDescriptor ()
 
 getRequestedObject ()
 
 setRequestedObject ($value)
 
 getFormTexts ()
 
 getFormTextPaths ()
 
 setFormTexts ($value)
 
 getMarkedItemsCollector ()
 

Data Fields

 $implicitCombiFilter
 
 $allItemsSize
 
 $filters
 
 $widgetDir = 'widgets'
 
 $nAdvancedFilters = 5
 
 $minSorts = 3
 
 $extraSortParams = array()
 
 $conversionErrors = array()
 

Additional Inherited Members

- Static Public Member Functions inherited from PntPage
static getInfoStyleOk ()
 
static getInfoStyleError ()
 
static getInfoStyleWarning ()
 

Member Function Documentation

_runQhStoreAllItemsSize_getItemsLimitedTo (   $qh,
  $rowCount 
)
addWildcards (   $filterValue)
advancedFilterCombine (   $currentFilter,
  $nextFilter,
  $combinator,
  $id 
)
advancedFilterOr (   $currentFilter,
  $nextFilter,
  $id 
)
convertFilterValue (   $conv,
  $filter,
  $value 
)
findFilter (   $filter,
  $path 
)

Recursive search through CombiFilter tree

Parameters
PntSqlFilter$filterThe filter to search through
string$paththe path of the filter searched for
Returns
PntSqlFilter the filter, or null if not found
getAllItemsSize ( )
getAllStringfieldsFilter ( )
getCombinatorOptions ( )
Returns
array with HTML strings
getCombinedAdvancedFilters ( )
Returns
PntSqlFilter
getCombinedFilter ( )

Returns the filter from getRequestedObject combined with the implicitCombiFilter. Assumed to be called only once!

getComparators ( )
getErrorInfo ( )
Returns
HTML info about the sringconversion and validation errors
getExtraFormParameterKeys ( )
getFilter ( )
getFilter1Cmp ( )
getFilter1Id ( )
getFilter1Value1 ( )
getFilter1Value2 ( )
getFilterCmp (   $num = 1)

Returns filter comparator (unsanitized)

getFilterCombinator (   $num)
getFilterCombinators ( )
getFilterId (   $num = 1)
getFilterResult (   $rowCount = 20)
Exceptions
PntError
getFilters ( )
getFilterValue1 (   $num = 1)
getFilterValue1ForInit (   $filter,
  $num = 1 
)
getFilterValue2 (   $num = 1)
getFormName ( )
getImplicitCombiFilter ( )
getImplicitCombiFilterDefault ( )
getInitializedAdvancedFilters ( )
Returns
array of PntSqlFilter
Exceptions
PntValidationExceptionif filter not found Enter description here ...
getNadvancedFilters ( )
getName ( )
getNewCombiFilter (   $id)
getNSorts ( )
getOwnFormParameterKeys ( )
getPageItemOffset ( )
getRequestedObject ( )
getSort (   $filter)
getSortDefault (   $filter)

Default is to sort ascentding by the filter path, undersorted by the type labelSort. If the filter can not be used as a sortSpec, The labelSort is used

getSortDirection (   $num = 1)
getSortId (   $num = 1)
getSortIsSpecific ( )

Wheather the sort is specific. If False the default sort is to be used When first sortId is set empty by the SortDialog, return false

Returns
boolean
getSortSpecified ( )
initFilter (   $filter,
  $addWildcards = false,
  $num = 1 
)
printAdvancedFilterDescription (   $filter)
printAdvancedFilterDescriptions ( )
printAdvancedFilterDiv (   $num)
printAdvancedFilterDivs ( )
printCancelButtonLabel ( )
printCombinatorSelectWidget (   $num)
printComparatorSelectWidget (   $num = 1)
printDivDisplayStyle (   $divId)
printExtraFormParameters ( )
printFilterSelectWidget (   $num = 1)
printSearchButtonLabel ( )
printSortDialogScripts ( )
printSortParams ( )
runQhStoreAllItemsSize_getItemsLimitedTo (   $qh,
  $rowCount 
)
Exceptions
PntError
setImplicitCombiFilter (   $combiFilter)
showAdvancedFilterDiv (   $num)

Field Documentation

$allItemsSize
$conversionErrors = array()
$extraSortParams = array()
$filters
$implicitCombiFilter
$minSorts = 3
$nAdvancedFilters = 5
$widgetDir = 'widgets'

The documentation for this class was generated from the following file: