Source for file enabled.php

Documentation is available at enabled.php

  1. <?php
  2. /**
  3.  * @package     FrameworkOnFramework
  4.  * @subpackage  model
  5.  * @copyright   Copyright (C) 2010 - 2012 Akeeba Ltd. All rights reserved.
  6.  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  7.  */
  8. // Protect from unauthorized access
  9. defined('_JEXEC') or die;
  10.  
  11. /**
  12.  * FrameworkOnFramework model behavior class to filter front-end access to items
  13.  * that are enabled.
  14.  *
  15.  * @package  FrameworkOnFramework
  16.  * @since    2.1
  17.  */
  18. class FOFModelBehaviorEnabled extends FOFModelBehavior
  19. {
  20.     /**
  21.      * This event runs after we have built the query used to fetch a record
  22.      * list in a model. It is used to apply automatic query filters.
  23.      *
  24.      * @param   FOFModel        &$model  The model which calls this event
  25.      * @param   JDatabaseQuery  &$query  The model which calls this event
  26.      *
  27.      * @return  void 
  28.      */
  29.     public function onAfterBuildQuery(&$model, &$query)
  30.     {
  31.         // This behavior only applies to the front-end.
  32.         if (!FOFPlatform::getInstance()->isFrontend())
  33.         {
  34.             return;
  35.         }
  36.  
  37.         // Get the name of the enabled field
  38.         $table = $model->getTable();
  39.         $enabledField = $table->getColumnAlias('enabled');
  40.  
  41.         // Make sure the field actually exists
  42.         if (!in_array($enabledField, $table->getKnownFields()))
  43.         {
  44.             return;
  45.         }
  46.  
  47.         // Filter by enabled fields only
  48.         $db = JFactory::getDbo();
  49.         $query->where($db->qn($enabledField) . ' = ' . $db->q(1));
  50.     }
  51.  
  52.     /**
  53.      * The event runs after FOFModel has called FOFTable and retrieved a single
  54.      * item from the database. It is used to apply automatic filters.
  55.      *
  56.      * @param   FOFModel  &$model   The model which was called
  57.      * @param   FOFTable  &$record  The record loaded from the databae
  58.      *
  59.      * @return  void 
  60.      */
  61.     public function onAfterGetItem(&$model, &$record)
  62.     {
  63.         if ($record instanceof FOFTable)
  64.         {
  65.             $fieldName = $record->getColumnAlias('enabled');
  66.  
  67.             // Make sure the field actually exists
  68.             if (!in_array($fieldName, $record->getKnownFields()))
  69.             {
  70.                 return;
  71.             }
  72.  
  73.             if ($record->$fieldName != 1)
  74.             {
  75.                 $record = null;
  76.             }
  77.         }
  78.     }
  79. }

Documentation generated on Tue, 19 Nov 2013 15:02:29 +0100 by phpDocumentor 1.4.3