From KnowledgeTree Document Management Made Simple

Contents 1 Introduction 1.1 Methods 1.1.1 __construct() or ClassName() 1.1.2 documentDisplay ($oDocument) 1.1.3 searchSQL ($aRequest) 1.1.4 searchJoinSQL () 1.2 Class Variables 1.2.1 $bString 1.2.2 $bContains 1.2.3 $bHandleNot 1.2.4 $sDocumentField 1.2.5 $sSortField 1.2.6 $sNamespace 1.2.7 $sSearchTable 1.2.8 $iID 1.2.9 $aLookup 1.2.10 $bFolderCriterion 1.2.11 $aOptions 1.2.12 $bVisible 2 Example

Introduction

Methods

Your class needs to implement the following methods:

__construct() or ClassName()

This constructor would do any specific initialisation for the class.

It might set $this->sDisplay it's default.

documentDisplay ($oDocument)

This is what will appear in the Advanced Search criteria list.

searchSQL ($aRequest)

This returns the part of the SQL that is part of the WHERE clause in the query.

searchJoinSQL ()

This returns the part of the SQL that is part of the JOIN clauses in the query.

Class Variables

$bString

TODO

$bContains

This is a boolean value - true or false.

In the Advanced Search, it is evident as to the implication:

• true - the matching criteria becomes 'contains' or 'does not contain'

• false - the matching criteria becomes 'equals' or 'not equal'

$bHandleNot

This is a boolean value - true or false.

The value of this impacts on $bContains.

If $bHandleNot is false, then $bContains does not have to cater for the 'not' condition

$sDocumentField

This is the field that will be referenced from the $sSearchTable.

$sSortField

The results will be sorted according to this field.

$sNamespace

Each criteria option should have its own unique namespace.

$sSearchTable

This is a reference to the table or alias on which the fields are referenced.

$iID

TODO

$aLookup

TODO

$bFolderCriterion

TODO

$aOptions

TODO

$bVisible

TODO

Example

TODO