Added $Id$ keywords, cleaned up comment tags
[Packages/TYPO3.CMS.git] / t3lib / class.t3lib_fullsearch.php
index 261d1dd..3b413b2 100755 (executable)
@@ -2,7 +2,7 @@
 /***************************************************************
 *  Copyright notice
 *  
-*  (c) 1999-2003 Kasper Skårhøj (kasper@typo3.com)
+*  (c) 1999-2003 Kasper Skaarhoj (kasper@typo3.com)
 *  All rights reserved
 *
 *  This script is part of the TYPO3 project. The TYPO3 project is 
  * Class used in module tools/dbint (advanced search) and which may hold code specific for that module
  * However the class has a general principle in it which may be used in the web/export module.
  *
- * @author     Kasper Skårhøj <kasper@typo3.com>
- * @package TYPO3
- * @subpackage t3lib
+ * $Id$
+ *
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ */
+/**
+ * [CLASS/FUNCTION INDEX of SCRIPT]
+ *
+ *
+ *
+ *   83: class t3lib_fullsearch 
+ *   98:     function form()   
+ *  112:     function makeStoreControl()       
+ *  151:     function initStoreArray() 
+ *  171:     function cleanStoreQueryConfigs($storeQueryConfigs,$storeArray)   
+ *  188:     function addToStoreQueryConfigs($storeQueryConfigs,$index)        
+ *  204:     function saveQueryInAction($uid)  
+ *  254:     function loadStoreQueryConfigs($storeQueryConfigs,$storeIndex,$writeArray)        
+ *  270:     function procesStoreControl()     
+ *  343:     function queryMaker()     
+ *  407:     function getQueryResultCode($mQ,$res,$table)      
+ *  514:     function csvValues($row,$delim=",",$quote='"')    
+ *  524:     function tableWrap($str)  
+ *  533:     function search() 
+ *  591:     function resultRowDisplay($row,$conf,$table)      
+ *  614:     function resultRowTitles($row,$conf,$table)       
+ *
+ * TOTAL FUNCTIONS: 15
+ * (This index is automatically created/updated by the extension "extdeveval")
+ *
  */
 
  
+
+
+
+
+
+
+
+
+
+
+
+
+/**
+ * Class used in module tools/dbint (advanced search) and which may hold code specific for that module
+ * However the class has a general principle in it which may be used in the web/export module.
+ * 
+ * @author     Kasper Skaarhoj <kasper@typo3.com>
+ * @package TYPO3
+ * @subpackage t3lib
+ */
 class t3lib_fullsearch {
        var $storeList = "search_query_smallparts,queryConfig,queryTable,queryFields,queryLimit,queryOrder,queryOrderDesc,queryOrder2,queryOrder2Desc,queryGroup,search_query_makeQuery";
        var $downloadScript = "index.php";
        var $formW=48;
        var $noDownloadB=0;
        
+
+
+
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function form() {
                $out='
                Search Word:<BR>
@@ -48,6 +103,12 @@ class t3lib_fullsearch {
                
                return $out;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function makeStoreControl()     {
                        // Load/Save
                $storeArray = $this->initStoreArray();
@@ -81,6 +142,12 @@ class t3lib_fullsearch {
                ';
                return $tmpCode;        
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function initStoreArray()       {
                $storeArray=array(
                        "0" => "[New]"
@@ -93,6 +160,14 @@ class t3lib_fullsearch {
                }
                return $storeArray;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $storeQueryConfigs: ...
+        * @param       [type]          $storeArray: ...
+        * @return      [type]          ...
+        */
        function cleanStoreQueryConfigs($storeQueryConfigs,$storeArray) {
                if (is_array($storeQueryConfigs))       {
                        reset($storeQueryConfigs);
@@ -102,6 +177,14 @@ class t3lib_fullsearch {
                }
                return $storeQueryConfigs;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $storeQueryConfigs: ...
+        * @param       [type]          $index: ...
+        * @return      [type]          ...
+        */
        function addToStoreQueryConfigs($storeQueryConfigs,$index)      {
                $keyArr = explode(",",$this->storeList);
                reset($keyArr);
@@ -111,6 +194,13 @@ class t3lib_fullsearch {
                }
                return $storeQueryConfigs;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $uid: ...
+        * @return      [type]          ...
+        */
        function saveQueryInAction($uid)        {
                if (t3lib_extMgm::isLoaded("sys_action"))       {
                        $keyArr = explode(",",$this->storeList);
@@ -152,6 +242,15 @@ class t3lib_fullsearch {
                        return $qOK;
                }
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $storeQueryConfigs: ...
+        * @param       [type]          $storeIndex: ...
+        * @param       [type]          $writeArray: ...
+        * @return      [type]          ...
+        */
        function loadStoreQueryConfigs($storeQueryConfigs,$storeIndex,$writeArray)      {
                if ($storeQueryConfigs[$storeIndex])    {
                        $keyArr = explode(",",$this->storeList);
@@ -162,6 +261,12 @@ class t3lib_fullsearch {
                }
                return $writeArray;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function procesStoreControl()   {
                $storeArray = $this->initStoreArray();
                $storeQueryConfigs = unserialize($GLOBALS["SOBE"]->MOD_SETTINGS["storeQueryConfigs"]);
@@ -229,6 +334,12 @@ class t3lib_fullsearch {
                }
                return $msg;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function queryMaker()   {
                global $TCA;
 
@@ -284,6 +395,15 @@ class t3lib_fullsearch {
                }               
                return $output;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $mQ: ...
+        * @param       [type]          $res: ...
+        * @param       [type]          $table: ...
+        * @return      [type]          ...
+        */
        function getQueryResultCode($mQ,$res,$table)    {
                global $TCA;
                $output="";
@@ -382,12 +502,34 @@ class t3lib_fullsearch {
                }
                return $cPR;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $row: ...
+        * @param       [type]          $delim: ...
+        * @param       [type]          $quote: ...
+        * @return      [type]          ...
+        */
        function csvValues($row,$delim=",",$quote='"')  {
                return t3lib_div::csvValues($row,$delim,$quote);
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $str: ...
+        * @return      [type]          ...
+        */
        function tableWrap($str)        {
                return '<table border=0 cellpadding=10 cellspacing=0 bgcolor="'.$GLOBALS["TBE_TEMPLATE"]->bgColor4.'"><tr><td nowrap><pre>'.$str.'</pre></td></tr></table>';
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @return      [type]          ...
+        */
        function search()       {
                global $TCA;
                $SET = t3lib_div::GPvar("SET");
@@ -437,7 +579,15 @@ class t3lib_fullsearch {
                }
                return $out;
        }
-       
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $row: ...
+        * @param       [type]          $conf: ...
+        * @param       [type]          $table: ...
+        * @return      [type]          ...
+        */
        function resultRowDisplay($row,$conf,$table)    {
                $out='<tr bgcolor="'.$GLOBALS["SOBE"]->doc->bgColor4.'">';
                reset($row);
@@ -452,6 +602,15 @@ class t3lib_fullsearch {
                ';
                return $out;
        }
+
+       /**
+        * [Describe function...]
+        * 
+        * @param       [type]          $row: ...
+        * @param       [type]          $conf: ...
+        * @param       [type]          $table: ...
+        * @return      [type]          ...
+        */
        function resultRowTitles($row,$conf,$table)     {
                $out='<tr bgcolor="'.$GLOBALS["SOBE"]->doc->bgColor5.'">';
                reset($row);
@@ -466,9 +625,7 @@ class t3lib_fullsearch {
        }
 }
 
-
 if (defined("TYPO3_MODE") && $TYPO3_CONF_VARS[TYPO3_MODE]["XCLASS"]["t3lib/class.t3lib_fullsearch.php"])       {
        include_once($TYPO3_CONF_VARS[TYPO3_MODE]["XCLASS"]["t3lib/class.t3lib_fullsearch.php"]);
 }
-
 ?>
\ No newline at end of file