Source for file class.modrewriteurlstack.php

Documentation is available at class.modrewriteurlstack.php

  1. <?php
  2. /**
  3.  * Includes mod rewrite url stack class.
  4.  *
  5.  * @author      Murat Purc <murat@purc.de>
  6.  * @copyright   © Murat Purc 2008
  7.  * @date        09.10.2008
  8.  * @package     Contenido
  9.  * @subpackage  ModRewrite
  10.  */
  11.  
  12.  
  13. defined('CON_FRAMEWORK') or die('Illegal call');
  14.  
  15.  
  16. /**
  17.  * Mod rewrite url stack class. Provides features to collect urls and to get the
  18.  * pretty path and names of categories/articles at one go.
  19.  *
  20.  * Main goal of this class is to collect urls and to get the urlpath and urlname
  21.  * of the related categories/articles at one go. This will reduce the queries
  22.  * against the database.
  23.  * Therefore the full advantage will be taken by rewriting the urls at codeoutput
  24.  * in front_content.php, where you will be able to collect all urls at once...
  25.  *
  26.  * Usage:
  27.  * <code>
  28.  * // get the instance
  29.  * $oMRUrlStack = ModRewriteUrlStack::getInstance();
  30.  *
  31.  * // add several urls to fill the stack
  32.  * $oMRUrlStack->add('front_content.php?idcat=123');
  33.  * $oMRUrlStack->add('front_content.php?idart=321');
  34.  * $oMRUrlStack->add('front_content.php?idcatart=213');
  35.  * $oMRUrlStack->add('front_content.php?idcatlang=213');
  36.  * $oMRUrlStack->add('front_content.php?idartlang=312');
  37.  *
  38.  * // now the first call will get the pretty path and names from database at one go
  39.  * $aPrettyParts = $oMRUrlStack->getPrettyUrlParts('front_content.php?idcat=123');
  40.  * echo $aPrettyParts['urlpath']; // something like 'Main-category-name/Category-name/Another-category-name/'
  41.  * echo $aPrettyParts['urlname']; // something like 'Name-of-an-article'
  42.  * </code>
  43.  *
  44.  * @author      Murat Purc <murat@purc.de>
  45.  * @copyright   © Murat Purc 2008
  46.  * @date        09.10.2008
  47.  * @package     Contenido
  48.  * @subpackage  ModRewrite
  49.  */
  50. class ModRewriteUrlStack {
  51.  
  52.     /**
  53.      * Self instance
  54.      *
  55.      * @var  ModRewriteUrlStack 
  56.      */
  57.     private static $_instance;
  58.  
  59.     /**
  60.      * Database object
  61.      *
  62.      * @var  DB_Contenido 
  63.      */
  64.     private $_oDb;
  65.  
  66.     /**
  67.      * Array for urls
  68.      *
  69.      * @var  array 
  70.      */
  71.     private $_aUrls = array();
  72.  
  73.     /**
  74.      * Url stack array
  75.      *
  76.      * @var  array 
  77.      */
  78.     private $_aStack = array();
  79.  
  80.     /**
  81.      * Contenido related parameter array
  82.      *
  83.      * @var  array 
  84.      */
  85.     private $_aConParams = array(
  86.         'idcat' => 1, 'idart' => 1, 'lang' => 1, 'idcatlang' => 1, 'idcatart' => 1, 'idartlang' => 1
  87.     );
  88.  
  89.     /**
  90.      * Database tables array
  91.      *
  92.      * @var  array 
  93.      */
  94.     private $_aTab;
  95.  
  96.     /**
  97.      * Language id
  98.      *
  99.      * @var  int 
  100.      */
  101.     private $_idLang;
  102.  
  103.  
  104.     /**
  105.      * Constructor, sets some properties.
  106.      */
  107.     private function __construct() {
  108.         $this->_oDb    = new DB_Contenido();
  109.         $this->_aTab   = mpGlobals::getInstance()->get('cfg/tab');
  110.         $this->_idLang = mpGlobals::getInstance()->get('lang');
  111.     }
  112.  
  113.  
  114.     /**
  115.      * Returns a instance of ModRewriteUrlStack (singleton implementation)
  116.      *
  117.      * @return  ModRewriteUrlStack 
  118.      */
  119.     public static function getInstance() {
  120.         if (self::$_instance == null) {
  121.             self::$_instance = new ModRewriteUrlStack();
  122.         }
  123.         return self::$_instance;
  124.     }
  125.  
  126.  
  127.     /**
  128.      * Adds an url to the stack
  129.      *
  130.      * @param  string  Url, like front_content.php?idcat=123...
  131.      */
  132.     public function add($url) {
  133.         $url  = ModRewrite::urlPreClean($url);
  134.         if (isset($this->_aUrls[$url])) {
  135.             return;
  136.         }
  137.  
  138.         $aUrl = $this->_extractUrl($url);
  139.  
  140.         // cleanup parameter
  141.         foreach ($aUrl['params'] as $p => $v) {
  142.             if (!isset($this->_aConParams[$p])) {
  143.                 unset($aUrl['params'][$p]);
  144.             }
  145.         }
  146.  
  147.         // add language id, if not available
  148.         if ((int) mr_arrayValue($aUrl['params'], 'lang') == 0) {
  149.             $aUrl['params']['lang'] = $this->_idLang;
  150.         }
  151.  
  152.         $sStackId = $this->_makeStackId($aUrl['params']);
  153.         $this->_aUrls[$url]       = $sStackId;
  154.         $this->_aStack[$sStackId] = array('params' => $aUrl['params']);
  155.     }
  156.  
  157.  
  158.     /**
  159.      * Returns the pretty urlparts (only category path an article name) of the
  160.      * desired url.
  161.      *
  162.      * @param   string  Url, like front_content.php?idcat=123...
  163.      * @return  array   Assoziative array like
  164.      *  <code>
  165.      *  $arr['urlpath']
  166.      *  $arr['urlname']
  167.      *  </code>
  168.      */
  169.     public function getPrettyUrlParts($url) {
  170.         if (!isset($this->_aUrls[$url])) {
  171.             $this->add($url);
  172.         }
  173.  
  174.         $sStackId = $this->_aUrls[$url];
  175.         if (!isset($this->_aStack[$sStackId]['urlpath'])) {
  176.             $this->_chunkSetPrettyUrlParts();
  177.         }
  178.         $aPretty = array(
  179.             'urlpath' => $this->_aStack[$sStackId]['urlpath'],
  180.             'urlname' => $this->_aStack[$sStackId]['urlname']
  181.         );
  182.         return $aPretty;
  183.     }
  184.  
  185.  
  186.     /**
  187.      * Extracts passed url using parse_urla and adds also the 'params' array to it
  188.      *
  189.      * @param   string  Url, like front_content.php?idcat=123...
  190.      * @return  array  Components containing result of parse_url with additional
  191.      *                  'params' array
  192.      */
  193.     private function _extractUrl($url) {
  194.         $aUrl = @parse_url($url);
  195.         if (isset($aUrl['query'])) {
  196.             $aUrl['query'] = str_replace('&amp;', '&', $aUrl['query']);
  197.             parse_str($aUrl['query'], $aUrl['params']);
  198.         }
  199.         if (!isset($aUrl['params']) && !is_array($aUrl['params'])) {
  200.             $aUrl['params'] = array();
  201.         }
  202.         return $aUrl;
  203.     }
  204.  
  205.  
  206.     /**
  207.      * Extracts article or category related parameter from passed params array
  208.      * and generates an identifier.
  209.      *
  210.      * @param   array   $aParams  Parameter array
  211.      * @return  string  Composed stack id
  212.      */
  213.     private function _makeStackId(array $aParams) {
  214.         # idcatart
  215.         if ((int) mr_arrayValue($aParams, 'idart') > 0) {
  216.             $sStackId = 'idart_' . $aParams['idart'] . '_lang_' . $aParams['lang'];
  217.         } elseif ((int) mr_arrayValue($aParams, 'idartlang') > 0) {
  218.             $sStackId = 'idartlang_' . $aParams['idartlang'];
  219.         } elseif ((int) mr_arrayValue($aParams, 'idcatart') > 0) {
  220.             $sStackId = 'idcatart_' . $aParams['idcatart'] . '_lang_' . $aParams['lang'];
  221.         } elseif ((int) mr_arrayValue($aParams, 'idcat') > 0) {
  222.             $sStackId = 'idcat_' . $aParams['idcat'] . '_lang_' . $aParams['lang'];
  223.         } elseif ((int) mr_arrayValue($aParams, 'idcatlang') > 0) {
  224.             $sStackId = 'idcatlang_' . $aParams['idcatlang'];
  225.         } else {
  226.             $sStackId = 'lang_' . $aParams['lang'];
  227.         }
  228.         return $sStackId;
  229.     }
  230.  
  231.  
  232.     /**
  233.      * Main function to get the urlparts of urls.
  234.      *
  235.      * Composes the query by looping thru stored but non processed urls, executes
  236.      * the query and adds the (urlpath and urlname) result to the stack.
  237.      */
  238.     private function _chunkSetPrettyUrlParts() {
  239.         // collect stack parameter to get urlpath and urlname
  240.         $aStack = array();
  241.         foreach ($this->_aStack as $stackId => $item) {
  242.             if (!isset($item['urlpath'])) {
  243.                 // pretty url is to create
  244.                 $aStack[$stackId] = $item;
  245.             }
  246.         }
  247.  
  248.         // now, it's time to compose the where clause of the query
  249.         $sWhere = '';
  250.         foreach ($aStack as $stackId => $item) {
  251.             $aP = $item['params'];
  252.             if ((int) mr_arrayValue($aP, 'idart') > 0) {
  253.                 $sWhere .= '(al.idart = ' . $aP['idart'] . ' AND al.idlang = ' . $aP['lang'] . ') OR ';
  254.             } elseif ((int) mr_arrayValue($aP, 'idartlang') > 0) {
  255.                 $sWhere .= '(al.idartlang = ' . $aP['idartlang'] . ') OR ';
  256.             } elseif ((int) mr_arrayValue($aP, 'idcat') > 0) {
  257.                 $sWhere .= '(cl.idcat = ' . $aP['idcat'] . ' AND cl.idlang = ' . $aP['lang'] . ' AND cl.startidartlang = al.idartlang) OR ';
  258.             } elseif ((int) mr_arrayValue($aP, 'idcatart') > 0) {
  259.                 $sWhere .= '(ca.idcatart = ' . $aP['idcatart'] . ' AND ca.idart = al.idart AND al.idlang = ' . $aP['lang'] . ') OR ';
  260.             } elseif ((int) mr_arrayValue($aP, 'idcatlang') > 0) {
  261.                 $sWhere .= '(cl.idcatlang = ' . $aP['idcatlang'] . ' AND cl.startidartlang = al.idartlang) OR ';
  262.             }
  263.         }
  264.         if ($sWhere == '') {
  265.             return;
  266.         }
  267.         $sWhere = substr($sWhere, 0, -4);
  268.         $sWhere = str_replace(' OR ', " OR \n", $sWhere);
  269.  
  270.         // compose query and execute it
  271.         $sql = <<<SQL
  272. SELECT
  273.         al.idartlang, al.idart, al.idlang, al.urlname, cl.idcatlang, cl.idcat,
  274.         cl.urlpath, ca.idcatart
  275. FROM
  276.         {$this->_aTab['art_lang']} AS al, {$this->_aTab['cat_lang']} AS cl, {$this->_aTab['cat_art']} AS ca
  277. WHERE
  278.         al.idart = ca.idart AND
  279.         ca.idcat = cl.idcat AND
  280.         al.idlang = cl.idlang AND
  281.         ( $sWhere )
  282. SQL;
  283.         Contenido_mpDebug::getInstance()->addDebug($sql, 'ModRewriteUrlStack->_chunkSetPrettyUrlParts() $sql');
  284.  
  285.         $aNewStack = array();
  286.  
  287.         $this->_oDb->query($sql);
  288.         while ($this->_oDb->next_record()) {
  289.             $aRS = $this->_oDb->Record;
  290.  
  291.             // check current recordset against existing entries in stack
  292.             foreach ($aStack as $stackId => $item) {
  293.                 $bFound = false;
  294.                 $aP = $item['params'];
  295.                 if (mr_arrayValue($aP, 'idart') == $aRS['idart'] && mr_arrayValue($aP, 'lang') == $aRS['idlang']) {
  296.                     $bFound = true;
  297.                 } elseif (mr_arrayValue($aP, 'idartlang') == $aRS['idartlang']) {
  298.                     $bFound = true;
  299.                 } elseif (mr_arrayValue($aP, 'idcatart') == $aRS['idcatart'] && mr_arrayValue($aP, 'lang') == $aRS['idlang']) {
  300.                     $bFound = true;
  301.                 } elseif (mr_arrayValue($aP, 'idcat') == $aRS['idcat'] && mr_arrayValue($aP, 'lang') == $aRS['idlang']) {
  302.                     $bFound = true;
  303.                 } elseif (mr_arrayValue($aP, 'idcatlang') == $aRS['idcatlang']) {
  304.                     $bFound = true;
  305.                 }
  306.  
  307.                 if ($bFound) {
  308.                     // matching entry found, add urlpath and urlname
  309.                     $aNewStack[$stackId]['urlpath'] = $aRS['urlpath'];
  310.                     $aNewStack[$stackId]['urlname'] = $aRS['urlname'];
  311.                     // remove from base stack
  312.                     unset($aStack[$stackId]);
  313.                     break;
  314.                 }
  315.  
  316.             }
  317.  
  318.         }
  319.         Contenido_mpDebug::getInstance()->addDebug($aNewStack, 'ModRewriteUrlStack->_chunkSetPrettyUrlParts() $aNewStack');
  320.  
  321.         // merge stack data
  322.         $this->_aStack = array_merge($this->_aStack, $aNewStack);
  323.     }
  324.  
  325. }

Documentation generated on Sun, 21 Dec 2008 21:42:39 +0100 by phpDocumentor 1.4.1