Added additional comments to search code

Committed by: Paul Barrett

Added additional comments to search code
Committed by: Paul Barrett
Paul Barrett
1 parent ce58047a
Showing 9 changed files with 32 additions and 40 deletions
search2.php
search2/search/expr.inc.php
search2/search/fields/AnyMetadataField.inc.php
search2/search/fields/DiscussionTextField.inc.php
search2/search/fields/DocumentIdField.inc.php
search2/search/fields/FilenameField.inc.php
search2/search/fields/FullPathField.inc.php
search2/search/fields/GeneralTextField.inc.php
search2/search/fields/TitleField.inc.php
@@ -776,7 +776,6 @@ class SearchDispatcher extends KTStandardDispatcher {
 	}
 }
-
 $oDispatcher = new SearchDispatcher();
 $oDispatcher->dispatch();
@@ -49,8 +49,6 @@ require_once(&#39;search/fieldRegistry.inc.php&#39;);
 require_once('search/exprConstants.inc.php');
 /**
- * 
- *
  * This class handles the ranking of search results
  *
  * @author KnowledgeTree Team
@@ -794,7 +792,6 @@ class ValueListExpr extends Expr
     	$this->values[] = $value;
     }
-
     public function getValue($param=null)
     {
     	if (!empty($param))
@@ -950,6 +947,7 @@ interface QueryBuilder
 /**
  * This class builds queries for text content searches
+ * which are run through the Lucene service
  *
  * @author KnowledgeTree Team
  * @package Search
@@ -1111,8 +1109,7 @@ class SQLQueryBuilder implements QueryBuilder
 	}
     /**
-     * Sets the value which determines whether archived/deleted documents
-     * are to be included in search results
+     * Sets the value which determines whether status must be 1 to return results
      *
      * @author KnowledgeTree Team
      * @access public
@@ -39,46 +39,21 @@
 class AnyMetadataField extends DBFieldExpr
 {
+    // declare as part of GeneralText search
 	public $general_op = ExprOp::CONTAINS;
-//    public $references = 0;
     public function __construct()
     {
-//        parent::__construct('value', 'document_fields_link', _kt('Any Metadata'));
+        /*
+         * Constructing the object like this allows for easy multiple joins
+         * on the same column in the same table
+         */
         parent::__construct('id', 'document_metadata_version', _kt('Any Metadata'));
         $this->setAlias('Metadata');
         $this->joinTo('document_fields_link', 'metadata_version_id');
 		$this->matchField('value');
     }
-    /*
-     * Overridden function to adjust table alias in cases of
-     * the document_fields_link table being included more than once
-     *
-     * NOTE this only works in conjunction with code in expr.inc.php which adds the left joins to the db query.
-     *      I don't like this and think we should look for a way to make the table joining more generic
-     *      such that it can be controlled via these classes and thereby contained as a unit.
-     */
-//    public function modifyName($name)
-//    {
-//        if ($this->references > 0)
-//        {
-//            static $count = 0;
-//            if ($count >= $this->references)
-//            {
-//                $count = 0;
-//            }
-//
-//            if ((($pos = strpos($name, '.')) !== false) && ($count != 0))
-//            {
-//                $name = substr($name, 0, $pos) . $count . substr($name, $pos);
-//            }
-//            ++$count;
-//        }
-//
-//    	return $name;
-//    }
-
     public function getInputRequirements()
     {
         return array('value'=>array('type'=>FieldInputType::TEXT));
@@ -39,6 +39,7 @@
 class DiscussionTextField extends SearchableText
 {
+    // declare as part of GeneralText search
 	public $general_op = ExprOp::CONTAINS;
     public function __construct()
@@ -39,6 +39,7 @@
 class DocumentIdField extends DBFieldExpr
 {
+    // declare as part of GeneralText search
 	public $general_op = ExprOp::IS;
     public function __construct()
@@ -39,9 +39,9 @@
 class FilenameField extends DBFieldExpr
 {
+    // declare as part of GeneralText search
 	public $general_op = ExprOp::CONTAINS;
-
     public function __construct()
     {
         parent::__construct('filename', 'document_content_version', _kt('Filename'));
@@ -39,6 +39,7 @@
 class FullPathField extends DBFieldExpr
 {
+    // declare as part of GeneralText search
 	public $general_op = ExprOp::CONTAINS;
     public function __construct()
@@ -37,6 +37,26 @@
  *
  */
+/**
+ * Class to combine multiple search fields under the heading of GeneralText search
+ *
+ * Fields are added to the GeneralText search by declaring and initialising the
+ * ${fieldclass}->general_op variable within the field class you would like to
+ * include in the GeneralText search.  To do this, add the following class variable
+ * declaration:
+ * 
+ * public $general_op = ExprOp::CONTAINS;
+ *
+ * At the time of writing (2009/05/15) the following field classes are included:
+ * 
+ * AnyMetadataField
+ * DiscussionTextField
+ * DocumentIdField
+ * FilenameField
+ * FullPathField
+ * TitleField
+ * 
+ */
 class GeneralTextField extends SearchableText
 {
     public function __construct()
@@ -83,10 +103,7 @@ class GeneralTextField extends SearchableText
 				$right = new OpExpr($right, ExprOp::OP_OR, $newexpr);
     		}
     	}
-
     }
-
-
 }
 ?>
@@ -39,6 +39,7 @@
 class TitleField extends DBFieldExpr
 {
+    // declare as part of GeneralText search
     public $general_op = ExprOp::CONTAINS;
     public function __construct()