Absolut Engine PHP Cross Reference Web Portal Systems

Source: /docs/directory-coreclass.php.html - 81 lines - 7984 bytes - Text - Print

   1  <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN"
   2      "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd">
   3  <html xmlns="http://www.w3.org/1999/xhtml" xml:lang="en" lang="en">
   4  
   5  <head>
   6  <meta http-equiv="content-type" content="text/html; charset=iso-8859-1" />
   7  <meta name="licence" content="GNU General Public Licence" />
   8  <meta name="robots" content="all" />
   9  <title>Documentation: class CDirectory extends CEngine
  10  </title>
  11  <style type="text/css">@import "styles.css";</style>
  12  </head>
  13  
  14  <body><h1>class CDirectory extends CEngine
  15  </h1><a href="index.html">^ INDEX</a><br /><a name="TOC-MAIN"></a><h1>Table of contents</h1><a href="#CDirectory">CDirectory</a><br /><a href="#GetArchive">GetArchive</a><br /><a href="#GetDirectoryCategory">GetDirectoryCategory</a><br /><a href="#GetDirectoryCategoryDepth">GetDirectoryCategoryDepth</a><br /><a href="#GetDirectoryCategoryFilename">GetDirectoryCategoryFilename</a><br /><a href="#GetDirectoryCategoryID">GetDirectoryCategoryID</a><br /><a href="#GetDirectoryCategoryName">GetDirectoryCategoryName</a><br /><a href="#GetDirectoryCategoryPriority">GetDirectoryCategoryPriority</a><br /><a href="#GetDirectoryCategorylinkID">GetDirectoryCategorylinkID</a><br /><a href="#GetDirectoryLinkCategories">GetDirectoryLinkCategories</a><br /><a href="#GetDirectoryLinkDescription">GetDirectoryLinkDescription</a><br /><a href="#GetDirectoryLinkEmail">GetDirectoryLinkEmail</a><br /><a href="#GetDirectoryLinkFilename">GetDirectoryLinkFilename</a><br /><a href="#GetDirectoryLinkID">GetDirectoryLinkID</a><br /><a href="#GetDirectoryLinkPriority">GetDirectoryLinkPriority</a><br /><a href="#GetDirectoryLinkStatus">GetDirectoryLinkStatus</a><br /><a href="#GetDirectoryLinkThumbnail">GetDirectoryLinkThumbnail</a><br /><a href="#GetDirectoryLinkTitle">GetDirectoryLinkTitle</a><br /><a href="#GetDirectoryLinkURL">GetDirectoryLinkURL</a><br /><a href="#GetDirectoryParentCategory">GetDirectoryParentCategory</a><br /><a href="#GetDirectoryParentCategoryID">GetDirectoryParentCategoryID</a><br /><a href="#GetDirectoryTopCategory">GetDirectoryTopCategory</a><br /><a href="#LoopThroughDirectoryCategoryList">LoopThroughDirectoryCategoryList</a><br /><p class="text"></p><p><a href="#TOC-MAIN">^ Top</a></p><a name="CDirectory"></a><h2>   CDirectory()
  16  </h2><h3>absolutengine
  17  </h3><p class="text">Directory class for handling all directory-related functions</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetArchive"></a><h2>   GetArchive($settings)
  18  </h2><p class="text">Retrieve links from database<br />
  19  "linknumber"=>int number of links to list<br />
  20  "offset"=>int offset to show links from<br />
  21  "categoryID"=>string links in category ID (comma delimited list for multiple values)<br />
  22  "priority"=>boolean 0,1<br />
  23  "status"=>boolean 0,1<br />
  24  "linkID"=>int ID of link to be displayed<br />
  25  "order"=>string use MySQL format ("priority DESC" etc.)<br />
  26  EXCLUSION: !X = !4 - will exclude category with ID 4 if used in categoryID<br />
  27  <br />
  28  This will list latest 10 links with priority 1<br />
  29  <code><br />
  30  <?<br />
  31  $settings=array(<br />
  32  "linknumber"=>10,<br />
  33  "priority"=>1<br />
  34  );<br />
  35  $aepublic->GetArchive($settings);<br />
  36  .<br />
  37  .<br />
  38  .<br />
  39  ?><br />
  40  </code><br />
  41  This will list 10 links starting from 5th result in category 5 and 14<br />
  42  <code><br />
  43  <?<br />
  44  $settings=array(<br />
  45  "linknumber"=>10,<br />
  46  "offset"=>5,<br />
  47  "categoryID"=>"5,14"<br />
  48  );<br />
  49  $aepublic->GetArchive($settings);<br />
  50  .<br />
  51  .<br />
  52  .<br />
  53  ?><br />
  54  </code></p><p class="param">array $settings array of parameters, see below:</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategory"></a><h2>   GetDirectoryCategory($categoryID)
  55  </h2><p class="text">Retrieves category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategoryDepth"></a><h2>   GetDirectoryCategoryDepth($categoryID)
  56  </h2><p class="text">Get depth level of the category</p><p class="param">int $categoryID ID of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategoryFilename"></a><h2>   GetDirectoryCategoryFilename()
  57  </h2><p class="text">Return filename of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategoryID"></a><h2>   GetDirectoryCategoryID()
  58  </h2><p class="text">Return category ID</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategoryName"></a><h2>   GetDirectoryCategoryName()
  59  </h2><p class="text">Get category name</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategoryPriority"></a><h2>   GetDirectoryCategoryPriority()
  60  </h2><p class="text">Return priority of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryCategorylinkID"></a><h2>   GetDirectoryCategorylinkID()
  61  </h2><p class="text">Return linkID describing category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkCategories"></a><h2>   GetDirectoryLinkCategories($linkID=0)
  62  </h2><p class="text">Retrieve categories for the link</p><p class="param">int $linkID ID of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkDescription"></a><h2>   GetDirectoryLinkDescription()
  63  </h2><p class="text">Get description of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkEmail"></a><h2>   GetDirectoryLinkEmail()
  64  </h2><p class="text">Get email of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkFilename"></a><h2>   GetDirectoryLinkFilename()
  65  </h2><p class="text">Get filename of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkID"></a><h2>   GetDirectoryLinkID()
  66  </h2><p class="text">Get ID of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkPriority"></a><h2>   GetDirectoryLinkPriority()
  67  </h2><p class="text">Get priority of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkStatus"></a><h2>   GetDirectoryLinkStatus()
  68  </h2><p class="text">Get status of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkThumbnail"></a><h2>   GetDirectoryLinkThumbnail()
  69  </h2><p class="text">Get thumbnail image for the website (link) from thumbshots.org</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkTitle"></a><h2>   GetDirectoryLinkTitle()
  70  </h2><p class="text">Get title of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryLinkURL"></a><h2>   GetDirectoryLinkURL()
  71  </h2><p class="text">Get URL of link</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryParentCategory"></a><h2>   GetDirectoryParentCategory($categoryID=0)
  72  </h2><p class="text">Retrieve parent category for the category</p><p class="param">int $categoryID ID of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryParentCategoryID"></a><h2>   GetDirectoryParentCategoryID()
  73  </h2><p class="text">Return parent categoryID of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="GetDirectoryTopCategory"></a><h2>   GetDirectoryTopCategory($categoryID=0)
  74  </h2><p class="text">Get top category for the category</p><p class="param">int $categoryID ID of category</p><p><a href="#TOC-MAIN">^ Top</a></p><a name="LoopThroughDirectoryCategoryList"></a><h2>   LoopThroughDirectoryCategoryList($settings)
  75  </h2><p class="text">Loop through the categories and generate a category list</p><p class="param">array $settings settings to specify how the category list should be displayed, see below:<br />
  76  int $settings["parentcategoryID"] - ID of parent category to start from<br />
  77  int $settings["type"] type of category list to be displayed - 0 public list, 1 links using UL, 2 dropdown menu using &nbsp, 3 checkboxes below each other;<br />
  78  boolean $settings["order"] - MySQL ORDER BY query part e.g. "priority DESC", "category"<br />
  79  boolean $settings["override"] - override current category filtering - 0 do nothing, 1 override and show as selected in dropdown<br />
  80  int $settings["depth"] - how deep the list should go from the parent category</p><p><a href="#TOC-MAIN">^ Top</a></p></body>
  81  </html>

title

Description

title

Description

title

Description

title

title

Body