include/category.php

   1 <?php
   2 /***************************************************/
   3 /* this class represents a category + its children */
   4 /***************************************************/
   5
   6 /**
   7  * Category class for handling categories.
   8  */
   9 class Category {
  10     var $iCatId;
  11     var $iParentId;
  12     var $sName;
  13     var $sDescription;
  14     var $aApplicationsIds;  // an array that contains the appId of every application linked to this category
  15     var $aSubcatsIds;        // an array that contains the appId of every application linked to this category
  16
  17
  18     /**
  19      * constructor, fetches the data.
  20      */
  21     function Category($iCatId = null)
  22     {
  23         // we are working on an existing category
  24         if($iCatId=="0" || $iCatId)
  25         {
  26             /*
  27              * We fetch the data related to this vendor.
  28              */
  29             $sQuery = "SELECT *
  30                        FROM appCategory
  31                        WHERE catId = '?' ORDER BY catName;";
  32             if($hResult = query_parameters($sQuery, $iCatId))
  33             {
  34                 $oRow = query_fetch_object($hResult);
  35                 if($oRow)
  36                 {
  37                     $this->iCatId = $iCatId;
  38                     $this->iParentId = $oRow->catParent;
  39                     $this->sName = $oRow->catName;
  40                     $this->sDescription = $oRow->catDescription;
  41                 }
  42             }
  43
  44             /*
  45              * We fetch applicationsIds.
  46              */
  47             $sQuery = "SELECT appId
  48                        FROM appFamily
  49                        WHERE catId = '?'
  50                        AND state = 'accepted' ORDER BY appName";
  51             if($hResult = query_parameters($sQuery, $iCatId))
  52             {
  53                 while($oRow = query_fetch_object($hResult))
  54                 {
  55                     $this->aApplicationsIds[] = $oRow->appId;
  56                 }
  57             }
  58
  59             /*
  60              * We fetch subcatIds.
  61              */
  62             $sQuery = "SELECT catId
  63                        FROM appCategory
  64                        WHERE catParent = '?' ORDER BY catName;";
  65             if($hResult = query_parameters($sQuery, $iCatId))
  66             {
  67                 while($oRow = query_fetch_object($hResult))
  68                 {
  69                     $this->aSubcatsIds[] = $oRow->catId;
  70                 }
  71             }
  72         }
  73     }
  74
  75
  76     /**
  77      * Creates a new category.
  78      */
  79     function create()
  80     {
  81         $hResult = query_parameters("INSERT INTO appCategory (catName, catDescription, catParent) ".
  82                                     "VALUES('?', '?', '?')",
  83                                     $this->sName, $this->sDescription, $this->iParentId);
  84         if($hResult)
  85         {
  86             $this->iCatId = query_appdb_insert_id();
  87             $this->category($this->iCatId);
  88             return true;
  89         }
  90
  91         return false;
  92     }
  93
  94     /**
  95      * Update category.
  96      * Returns true on success and false on failure.
  97      */
  98     function update()
  99     {
 100         if(!query_parameters("UPDATE appCategory SET catName = '?', catDescription = '?', catParent = '?' WHERE catId = '?'",
 101                              $this->sName, $this->sDescription, $this->iParentId, $this->iCatId))
 102             return false;
 103
 104         return true;
 105     }
 106
 107
 108     /**
 109      * Deletes the category from the database.
 110      */
 111     function delete()
 112     {
 113         if(!$this->canEdit())
 114             return false;
 115
 116         if(sizeof($this->aApplicationsIds)>0)
 117             return FALSE;
 118
 119         $sQuery = "DELETE FROM appCategory
 120                     WHERE catId = '?'
 121                     LIMIT 1";
 122         query_parameters($sQuery, $this->iCatId);
 123
 124         return true;
 125     }
 126
 127     function objectGetMailOptions($sAction, $bMailSubmitter, $bParentAction)
 128     {
 129         return new mailOptions();
 130     }
 131
 132     function objectGetChildren()
 133     {
 134         /* We don't have any (or we do, sort of, but we don't use them for anything at the moment) */
 135                 return array();
 136     }
 137
 138     /* Get a category's subcategory objects.  Names are indented according
 139        to subcategory level */
 140     function getSubCatList($iLevel)
 141     {
 142         $aOut = array();
 143         $iId = $this->iCatId ? $this->iCatId : 0;
 144
 145         $sIndent = '';
 146         for($i = 0; $i < $iLevel; $i++)
 147             $sIndent .= '&nbsp; &nbsp;';
 148
 149         $hResult = query_parameters("SELECT * FROM appCategory WHERE catParent = '?'
 150                                      ORDER BY catName", $iId);
 151
 152         while($oRow = mysql_fetch_object($hResult))
 153         {
 154             $oCat = new category($oRow->catId);
 155             $oCat->sName = $sIndent.$oCat->sName;
 156             $aOut[] = $oCat;
 157             $aOut = array_merge($aOut, $oCat->getSubCatList($iLevel + 1));
 158         }
 159         return $aOut;
 160     }
 161
 162     /* Get all category objects, ordered and with category names indented
 163        according to subcategory level */
 164     static function getOrderedList()
 165     {
 166         $oCat = new category();
 167         return $oCat->getSubCatList(0);
 168     }
 169
 170     function objectGetMail($sAction, $bMailSubmitter, $bParentAction)
 171     {
 172         /* We don't send notification mails */
 173                 return array(null, null, null);
 174     }
 175
 176     /**
 177      * returns a path like:
 178      *
 179      *     { ROOT, Games, Simulation }
 180      */
 181     function getCategoryPath()
 182     {
 183         $aPath = array();
 184         $iCatId  = $this->iCatId;
 185
 186         /* loop, working up through categories until we have no parent */
 187         while($iCatId != 0)
 188         {
 189             $hResult = query_parameters("SELECT catName, catId, catParent FROM appCategory WHERE catId = '?'",
 190                                        $iCatId);
 191             if(!$hResult || query_num_rows($hResult) != 1)
 192                 break;
 193             $oCatRow = query_fetch_object($hResult);
 194             $aPath[] = array($oCatRow->catId, $oCatRow->catName);
 195             $iCatId = $oCatRow->catParent;
 196         }
 197         $aPath[] = array(0, "ROOT");
 198         return array_reverse($aPath);
 199     }
 200
 201     /* return the total number of applications in this category */
 202     function getApplicationCount($depth = null)
 203     {
 204         $MAX_DEPTH = 5;
 205
 206         if($depth)
 207             $depth++;
 208         else
 209             $depth = 0;
 210
 211         /* if we've reached our max depth, just return 0 and stop recursing */
 212         if($depth >= $MAX_DEPTH)
 213             return 0;
 214
 215         $totalApps = 0;
 216
 217         /* add on all apps in each category this category includes */
 218         if($this->aSubcatsIds)
 219         {
 220             while(list($i, $iSubcatId) = each($this->aSubcatsIds))
 221             {
 222                 $subCat = new Category($iSubcatId);
 223                 $totalApps += $subCat->getApplicationCount($depth);
 224             }
 225         }
 226
 227         $totalApps += sizeof($this->aApplicationsIds); /* add on the apps at this category level */
 228
 229         return $totalApps;
 230     }
 231
 232     /**
 233      * create the Category: line at the top of appdb pages$
 234      */
 235     function make_cat_path($path, $appId = '', $versionId = '')
 236     {
 237         $str = "";
 238         $catCount = 0;
 239         while(list($iCatIdx, list($iCatId, $name)) = each($path))
 240         {
 241             if($name == "ROOT")
 242                 $catname = "Main";
 243             else
 244                 $catname = $name;
 245
 246             if ($catCount > 0) $str .= " &gt; ";
 247             $str .= html_ahref($catname,"appbrowse.php?catId=$iCatId");
 248             $catCount++;
 249         }
 250
 251         if(!empty($appId))
 252         {
 253             $oApp = new Application($appId);
 254             if(!empty($versionId))
 255             {
 256                 $oVersion = new Version($versionId);
 257                 $str .= " &gt; ".$oApp->objectMakeLink();
 258                 $str .= " &gt; ".$oVersion->sName;
 259             } else
 260             {
 261                 $str .= " &gt; ".$oApp->sName;
 262             }
 263         }
 264
 265         return $str;
 266     }
 267
 268     function objectGetId()
 269     {
 270         return $this->iCatId;
 271     }
 272
 273     function objectGetSubmitterId()
 274     {
 275         /* We don't log that */
 276         return 0;
 277     }
 278
 279     function outputEditor()
 280     {
 281         $sQuery = "SELECT catId, catName FROM appCategory WHERE catId!='?'";
 282         $hResult = query_parameters($sQuery, $this->iCatId);
 283
 284         /* Add the virtual 'Main' category */
 285         $aCatIds = array(0);
 286         $aCatNames = array('Main');
 287
 288         /* Add the rest from the database */
 289         while($oRow = query_fetch_object($hResult))
 290         {
 291             $aCatIds[] = $oRow->catId;
 292             $aCatNames[] = $oRow->catName;
 293         }
 294
 295         echo "<table border=\"0\" width=\"100%\" cellspacing=\"0\" cellpadding=\"2\">
 296                 <tr>
 297                 <td width=\"15%\" class=\"box-label\"><b>Category name</b></td>
 298                 <td class=\"box-body\">
 299                 <input type=\"text\" size=\"50\" name=\"sName\" value=\"".$this->sName."\">
 300                 </td>
 301                 </tr>
 302                 <tr>
 303                 <td width=\"15%\" class=\"box-label\"><b>Description</b></td>
 304                 <td class=\"box-body\">
 305                 <input type=\"text\" size=\"50\" name=\"sDescription\" value=\"".$this->sDescription."\">
 306                 </td>
 307                 </tr>
 308                 <tr>
 309                 <td width=\"15%\" class=\"box-label\"><b>Parent</b></td>
 310                 <td class=\"box-body\">
 311                 ".html_select("iParentId",$aCatIds,$this->iParentId, $aCatNames)."
 312                 </td>
 313                 </tr>
 314                 </table>";
 315     }
 316
 317     function allowAnonymousSubmissions()
 318     {
 319         return FALSE;
 320     }
 321
 322     function getOutputEditorValues($aClean)
 323     {
 324         $this->sName = $aClean['sName'];
 325         $this->iParentId = $aClean['iParentId'];
 326         $this->sDescription = $aClean['sDescription'];
 327     }
 328
 329     function mustBeQueued()
 330     {
 331         return $_SESSION['current']->hasPriv('admin');
 332     }
 333
 334     function canEdit()
 335     {
 336         return $_SESSION['current']->hasPriv('admin');
 337     }
 338
 339     /**
 340      * display the full path of the Category we are looking at
 341      */
 342     function display($appId, $versionId = '')
 343     {
 344         $sCatFullPath = Category::make_cat_path($this->getCategoryPath(), $appId, $versionId);
 345         echo html_frame_start("",'98%','',2);
 346         echo "<p><b>Category: ". $sCatFullPath ."</b><br>\n";
 347         echo html_frame_end();
 348     }
 349 }
 350
 351 ?>