Source for file checkin.php

Documentation is available at checkin.php

  1. <?php
  2. /**
  3.  * @package     Joomla.Administrator
  4.  * @subpackage  com_checkin
  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.  * Checkin Model
  14.  *
  15.  * @package     Joomla.Administrator
  16.  * @subpackage  com_checkin
  17.  * @since       1.6
  18.  */
  19. class CheckinModelCheckin extends JModelList
  20. {
  21.     protected $total;
  22.  
  23.     protected $tables;
  24.  
  25.     /**
  26.      * Method to auto-populate the model state.
  27.      *
  28.      * @Note. Calling getState in this method will result in recursion.
  29.      * @param   string  $ordering   An optional ordering field.
  30.      * @param   string  $direction  An optional direction (asc|desc).
  31.      *
  32.      * @return  void 
  33.      *
  34.      * @since   1.6
  35.      */
  36.     protected function populateState($ordering = null, $direction = null)
  37.     {
  38.         $search = $this->getUserStateFromRequest($this->context . '.filter.search', 'filter_search');
  39.         $this->setState('filter.search', $search);
  40.  
  41.         // List state information.
  42.         parent::populateState('table', 'asc');
  43.     }
  44.  
  45.     /**
  46.      * Checks in requested tables
  47.      *
  48.      * @param   array    $ids  An array of table names. Optional.
  49.      *
  50.      * @return  integer  Checked in item count
  51.      *
  52.      * @since   1.6
  53.      */
  54.     public function checkin($ids = array())
  55.     {
  56.         $app = JFactory::getApplication();
  57.         $db = $this->_db;
  58.         $nullDate = $db->getNullDate();
  59.  
  60.         if (!is_array($ids))
  61.         {
  62.             return;
  63.         }
  64.  
  65.         // this int will hold the checked item count
  66.         $results = 0;
  67.  
  68.         foreach ($ids as $tn)
  69.         {
  70.             // make sure we get the right tables based on prefix
  71.             if (stripos($tn, $app->getCfg('dbprefix')) !== 0)
  72.             {
  73.                 continue;
  74.             }
  75.  
  76.             $fields = $db->getTableColumns($tn);
  77.  
  78.             if (!(isset($fields['checked_out']) && isset($fields['checked_out_time'])))
  79.             {
  80.                 continue;
  81.             }
  82.  
  83.             $query = $db->getQuery(true)
  84.                 ->update($db->quoteName($tn))
  85.                 ->set('checked_out = 0')
  86.                 ->set('checked_out_time = ' . $db->quote($nullDate))
  87.                 ->where('checked_out > 0');
  88.  
  89.             $db->setQuery($query);
  90.             if ($db->execute())
  91.             {
  92.                 $results = $results + $db->getAffectedRows();
  93.             }
  94.         }
  95.         return $results;
  96.     }
  97.  
  98.     /**
  99.      * Get total of tables
  100.      *
  101.      * @return  int    Total to check-in tables
  102.      *
  103.      * @since   1.6
  104.      */
  105.     public function getTotal()
  106.     {
  107.         if (!isset($this->total))
  108.         {
  109.             $this->getItems();
  110.         }
  111.         return $this->total;
  112.     }
  113.  
  114.     /**
  115.      * Get tables
  116.      *
  117.      * @return  array  Checked in table names as keys and checked in item count as values
  118.      *
  119.      * @since   1.6
  120.      */
  121.     public function getItems()
  122.     {
  123.         if (!isset($this->items))
  124.         {
  125.             $app = JFactory::getApplication();
  126.             $db = $this->_db;
  127.             $tables = $db->getTableList();
  128.  
  129.             // this array will hold table name as key and checked in item count as value
  130.             $results = array();
  131.  
  132.             foreach ($tables as $i => $tn)
  133.             {
  134.                 // make sure we get the right tables based on prefix
  135.                 if (stripos($tn, $app->getCfg('dbprefix')) !== 0)
  136.                 {
  137.                     unset($tables[$i]);
  138.                     continue;
  139.                 }
  140.  
  141.                 if ($this->getState('filter.search') && stripos($tn, $this->getState('filter.search')) === false)
  142.                 {
  143.                     unset($tables[$i]);
  144.                     continue;
  145.                 }
  146.  
  147.                 $fields = $db->getTableColumns($tn);
  148.  
  149.                 if (!(isset($fields['checked_out']) && isset($fields['checked_out_time'])))
  150.                 {
  151.                     unset($tables[$i]);
  152.                     continue;
  153.                 }
  154.             }
  155.             foreach ($tables as $tn)
  156.             {
  157.                 $query = $db->getQuery(true)
  158.                     ->select('COUNT(*)')
  159.                     ->from($db->quoteName($tn))
  160.                     ->where('checked_out > 0');
  161.  
  162.                 $db->setQuery($query);
  163.                 if ($db->execute())
  164.                 {
  165.                     $results[$tn] = $db->loadResult();
  166.                 }
  167.                 else
  168.                 {
  169.                     continue;
  170.                 }
  171.             }
  172.             $this->total = count($results);
  173.             if ($this->getState('list.ordering') == 'table')
  174.             {
  175.                 if ($this->getState('list.direction') == 'asc')
  176.                 {
  177.                     ksort($results);
  178.                 }
  179.                 else
  180.                 {
  181.                     krsort($results);
  182.                 }
  183.             }
  184.             else
  185.             {
  186.                 if ($this->getState('list.direction') == 'asc')
  187.                 {
  188.                     asort($results);
  189.                 }
  190.                 else
  191.                 {
  192.                     arsort($results);
  193.                 }
  194.             }
  195.             $results = array_slice($results, $this->getState('list.start'), $this->getState('list.limit') ? $this->getState('list.limit') : null);
  196.             $this->items = $results;
  197.         }
  198.         return $this->items;
  199.     }
  200. }

Documentation generated on Tue, 19 Nov 2013 14:55:42 +0100 by phpDocumentor 1.4.3