Source for file route.php

Documentation is available at route.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Site
  4.  * @subpackage  com_users
  5.  *
  6.  * @copyright   Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
  7.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8.  */
  9.  
  10. defined('_JEXEC') or die;
  11.  
  12. /**
  13.  * Users Route Helper
  14.  *
  15.  * @package     Joomla.Site
  16.  * @subpackage  com_users
  17.  * @since       1.6
  18.  */
  19. class UsersHelperRoute
  20. {
  21.     /**
  22.      * Method to get the menu items for the component.
  23.      *
  24.      * @return  array      An array of menu items.
  25.      * @since   1.6
  26.      */
  27.     public static function &getItems()
  28.     {
  29.         static $items;
  30.  
  31.         // Get the menu items for this component.
  32.         if (!isset($items))
  33.         {
  34.             $app    = JFactory::getApplication();
  35.             $menu    = $app->getMenu();
  36.             $com    = JComponentHelper::getComponent('com_users');
  37.             $items    = $menu->getItems('component_id', $com->id);
  38.  
  39.             // If no items found, set to empty array.
  40.             if (!$items)
  41.             {
  42.                 $items = array();
  43.             }
  44.         }
  45.  
  46.         return $items;
  47.     }
  48.  
  49.     /**
  50.      * Method to get a route configuration for the login view.
  51.      *
  52.      * @return  mixed      Integer menu id on success, null on failure.
  53.      * @since   1.6
  54.      * @static
  55.      */
  56.     public static function getLoginRoute()
  57.     {
  58.         // Get the items.
  59.         $items    = self::getItems();
  60.         $itemid    = null;
  61.  
  62.         // Search for a suitable menu id.
  63.         foreach ($items as $item)
  64.         {
  65.             if (isset($item->query['view']) && $item->query['view'] === 'login')
  66.             {
  67.                 $itemid = $item->id;
  68.                 break;
  69.             }
  70.         }
  71.  
  72.         return $itemid;
  73.     }
  74.  
  75.     /**
  76.      * Method to get a route configuration for the profile view.
  77.      *
  78.      * @return  mixed      Integer menu id on success, null on failure.
  79.      * @since   1.6
  80.      */
  81.     public static function getProfileRoute()
  82.     {
  83.         // Get the items.
  84.         $items    = self::getItems();
  85.         $itemid    = null;
  86.  
  87.         // Search for a suitable menu id.
  88.         //Menu link can only go to users own profile.
  89.  
  90.         foreach ($items as $item)
  91.         {
  92.             if (isset($item->query['view']) && $item->query['view'] === 'profile')
  93.             {
  94.                 $itemid = $item->id;
  95.                 break;
  96.             }
  97.  
  98.         }
  99.         return $itemid;
  100.     }
  101.  
  102.     /**
  103.      * Method to get a route configuration for the registration view.
  104.      *
  105.      * @return  mixed      Integer menu id on success, null on failure.
  106.      * @since   1.6
  107.      */
  108.     public static function getRegistrationRoute()
  109.     {
  110.         // Get the items.
  111.         $items    = self::getItems();
  112.         $itemid    = null;
  113.  
  114.         // Search for a suitable menu id.
  115.         foreach ($items as $item)
  116.         {
  117.             if (isset($item->query['view']) && $item->query['view'] === 'registration')
  118.             {
  119.                 $itemid = $item->id;
  120.                 break;
  121.             }
  122.         }
  123.  
  124.         return $itemid;
  125.     }
  126.  
  127.     /**
  128.      * Method to get a route configuration for the remind view.
  129.      *
  130.      * @return  mixed      Integer menu id on success, null on failure.
  131.      * @since   1.6
  132.      */
  133.     public static function getRemindRoute()
  134.     {
  135.         // Get the items.
  136.         $items    = self::getItems();
  137.         $itemid    = null;
  138.  
  139.         // Search for a suitable menu id.
  140.         foreach ($items as $item)
  141.         {
  142.             if (isset($item->query['view']) && $item->query['view'] === 'remind')
  143.             {
  144.                 $itemid = $item->id;
  145.                 break;
  146.             }
  147.         }
  148.  
  149.         return $itemid;
  150.     }
  151.  
  152.     /**
  153.      * Method to get a route configuration for the resend view.
  154.      *
  155.      * @return  mixed      Integer menu id on success, null on failure.
  156.      * @since   1.6
  157.      */
  158.     public static function getResendRoute()
  159.     {
  160.         // Get the items.
  161.         $items    = self::getItems();
  162.         $itemid    = null;
  163.  
  164.         // Search for a suitable menu id.
  165.         foreach ($items as $item)
  166.         {
  167.             if (isset($item->query['view']) && $item->query['view'] === 'resend')
  168.             {
  169.                 $itemid = $item->id;
  170.                 break;
  171.             }
  172.         }
  173.  
  174.         return $itemid;
  175.     }
  176.  
  177.     /**
  178.      * Method to get a route configuration for the reset view.
  179.      *
  180.      * @return  mixed      Integer menu id on success, null on failure.
  181.      * @since   1.6
  182.      */
  183.     public static function getResetRoute()
  184.     {
  185.         // Get the items.
  186.         $items    = self::getItems();
  187.         $itemid    = null;
  188.  
  189.         // Search for a suitable menu id.
  190.         foreach ($items as $item)
  191.         {
  192.             if (isset($item->query['view']) && $item->query['view'] === 'reset')
  193.             {
  194.                 $itemid = $item->id;
  195.                 break;
  196.             }
  197.         }
  198.  
  199.         return $itemid;
  200.     }
  201. }

Documentation generated on Tue, 19 Nov 2013 15:12:20 +0100 by phpDocumentor 1.4.3