File cms/helper/contenthistory.php | Joomla! Framework TM

  1 <?php
  2 /**
  3  * @package     Joomla.Libraries
  4  * @subpackage  Helper
  5  *
  6  * @copyright   Copyright (C) 2005 - 2017 Open Source Matters, Inc. All rights reserved.
  7  * @license     GNU General Public License version 2 or later; see LICENSE.txt
  8  */
  9 
 10 defined('JPATH_PLATFORM') or die;
 11 
 12 /**
 13  * Versions helper class, provides methods to perform various tasks relevant
 14  * versioning of content.
 15  *
 16  * @since  3.2
 17  */
 18 class JHelperContenthistory extends JHelper
 19 {
 20     /**
 21      * Alias for storing type in versions table
 22      *
 23      * @var    string
 24      * @since  3.2
 25      */
 26     public $typeAlias = null;
 27 
 28     /**
 29      * Constructor
 30      *
 31      * @param   string  $typeAlias  The type of content to be versioned (for example, 'com_content.article').
 32      *
 33      * @since   3.2
 34      */
 35     public function __construct($typeAlias = null)
 36     {
 37         $this->typeAlias = $typeAlias;
 38     }
 39 
 40     /**
 41      * Method to delete the history for an item.
 42      *
 43      * @param   JTable  $table  JTable object being versioned
 44      *
 45      * @return  boolean  true on success, otherwise false.
 46      *
 47      * @since   3.2
 48      */
 49     public function deleteHistory($table)
 50     {
 51         $key = $table->getKeyName();
 52         $id = $table->$key;
 53         $typeTable = JTable::getInstance('Contenttype', 'JTable');
 54         $typeId = $typeTable->getTypeId($this->typeAlias);
 55         $db = JFactory::getDbo();
 56         $query = $db->getQuery(true);
 57         $query->delete($db->quoteName('#__ucm_history'))
 58             ->where($db->quoteName('ucm_item_id') . ' = ' . (int) $id)
 59             ->where($db->quoteName('ucm_type_id') . ' = ' . (int) $typeId);
 60         $db->setQuery($query);
 61 
 62         return $db->execute();
 63     }
 64 
 65     /**
 66      * Method to get a list of available versions of this item.
 67      *
 68      * @param   integer  $typeId  Type id for this component item.
 69      * @param   mixed    $id      Primary key of row to get history for.
 70      *
 71      * @return  mixed   The return value or null if the query failed.
 72      *
 73      * @since   3.2
 74      */
 75     public function getHistory($typeId, $id)
 76     {
 77         $db = JFactory::getDbo();
 78         $query = $db->getQuery(true);
 79         $query->select($db->quoteName('h.version_note') . ',' . $db->quoteName('h.save_date') . ',' . $db->quoteName('u.name'))
 80             ->from($db->quoteName('#__ucm_history') . ' AS h ')
 81             ->leftJoin($db->quoteName('#__users') . ' AS u ON ' . $db->quoteName('u.id') . ' = ' . $db->quoteName('h.editor_user_id'))
 82             ->where($db->quoteName('ucm_item_id') . ' = ' . $db->quote($id))
 83             ->where($db->quoteName('ucm_type_id') . ' = ' . (int) $typeId)
 84             ->order($db->quoteName('save_date') . ' DESC ');
 85         $db->setQuery($query);
 86 
 87         return $db->loadObjectList();
 88     }
 89 
 90     /**
 91      * Method to save a version snapshot to the content history table.
 92      *
 93      * @param   JTable  $table  JTable object being versioned
 94      *
 95      * @return  boolean  True on success, otherwise false.
 96      *
 97      * @since   3.2
 98      */
 99     public function store($table)
100     {
101         $dataObject = $this->getDataObject($table);
102         $historyTable = JTable::getInstance('Contenthistory', 'JTable');
103         $typeTable = JTable::getInstance('Contenttype', 'JTable');
104         $typeTable->load(array('type_alias' => $this->typeAlias));
105         $historyTable->set('ucm_type_id', $typeTable->type_id);
106 
107         $key = $table->getKeyName();
108         $historyTable->set('ucm_item_id', $table->$key);
109 
110         // Don't store unless we have a non-zero item id
111         if (!$historyTable->ucm_item_id)
112         {
113             return true;
114         }
115 
116         $historyTable->set('version_data', json_encode($dataObject));
117         $input = JFactory::getApplication()->input;
118         $data = $input->get('jform', array(), 'array');
119         $versionName = false;
120 
121         if (isset($data['version_note']))
122         {
123             $versionName = JFilterInput::getInstance()->clean($data['version_note'], 'string');
124             $historyTable->set('version_note', $versionName);
125         }
126 
127         // Don't save if hash already exists and same version note
128         $historyTable->set('sha1_hash', $historyTable->getSha1($dataObject, $typeTable));
129 
130         if ($historyRow = $historyTable->getHashMatch())
131         {
132             if (!$versionName || ($historyRow->version_note === $versionName))
133             {
134                 return true;
135             }
136             else
137             {
138                 // Update existing row to set version note
139                 $historyTable->set('version_id', $historyRow->version_id);
140             }
141         }
142 
143         $result = $historyTable->store();
144 
145         // Load history_limit config from extension.
146         $aliasParts = explode('.', $this->typeAlias);
147 
148         $context = isset($aliasParts[1]) ? $aliasParts[1] : '';
149 
150         $maxVersionsContext = JComponentHelper::getParams($aliasParts[0])->get('history_limit' . '_' . $context, 0);
151 
152         if ($maxVersionsContext)
153         {
154             $historyTable->deleteOldVersions($maxVersionsContext);
155         }
156         elseif ($maxVersions = JComponentHelper::getParams($aliasParts[0])->get('history_limit', 0))
157         {
158             $historyTable->deleteOldVersions($maxVersions);
159         }
160 
161         return $result;
162     }
163 }
164
Namespaces

Classes

Interfaces

Exceptions

Constants

Functions
