550 lines
12 KiB
PHP
550 lines
12 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Administrator
|
|
* @subpackage com_banners
|
|
*
|
|
* @copyright Copyright (C) 2005 - 2013 Open Source Matters, Inc. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
defined('_JEXEC') or die;
|
|
|
|
/**
|
|
* Banner model.
|
|
*
|
|
* @package Joomla.Administrator
|
|
* @subpackage com_banners
|
|
* @since 1.6
|
|
*/
|
|
class BannersModelBanner extends JModelAdmin
|
|
{
|
|
/**
|
|
* @var string The prefix to use with controller messages.
|
|
* @since 1.6
|
|
*/
|
|
protected $text_prefix = 'COM_BANNERS_BANNER';
|
|
|
|
/**
|
|
* Method to perform batch operations on an item or a set of items.
|
|
*
|
|
* @param array $commands An array of commands to perform.
|
|
* @param array $pks An array of item ids.
|
|
* @param array $contexts An array of item contexts.
|
|
*
|
|
* @return boolean Returns true on success, false on failure.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
public function batch($commands, $pks, $contexts)
|
|
{
|
|
// Sanitize user ids.
|
|
$pks = array_unique($pks);
|
|
JArrayHelper::toInteger($pks);
|
|
|
|
// Remove any values of zero.
|
|
if (array_search(0, $pks, true))
|
|
{
|
|
unset($pks[array_search(0, $pks, true)]);
|
|
}
|
|
|
|
if (empty($pks))
|
|
{
|
|
$this->setError(JText::_('JGLOBAL_NO_ITEM_SELECTED'));
|
|
return false;
|
|
}
|
|
|
|
$done = false;
|
|
|
|
if (!empty($commands['category_id']))
|
|
{
|
|
$cmd = JArrayHelper::getValue($commands, 'move_copy', 'c');
|
|
|
|
if ($cmd == 'c')
|
|
{
|
|
$result = $this->batchCopy($commands['category_id'], $pks, $contexts);
|
|
if (is_array($result))
|
|
{
|
|
$pks = $result;
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
elseif ($cmd == 'm' && !$this->batchMove($commands['category_id'], $pks, $contexts))
|
|
{
|
|
return false;
|
|
}
|
|
$done = true;
|
|
}
|
|
|
|
if (strlen($commands['client_id']) > 0)
|
|
{
|
|
if (!$this->batchClient($commands['client_id'], $pks, $contexts))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
$done = true;
|
|
}
|
|
|
|
if (!empty($commands['language_id']))
|
|
{
|
|
if (!$this->batchLanguage($commands['language_id'], $pks, $contexts))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
$done = true;
|
|
}
|
|
|
|
if (!$done)
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION'));
|
|
return false;
|
|
}
|
|
|
|
// Clear the cache
|
|
$this->cleanCache();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Batch client changes for a group of banners.
|
|
*
|
|
* @param string $value The new value matching a client.
|
|
* @param array $pks An array of row IDs.
|
|
* @param array $contexts An array of item contexts.
|
|
*
|
|
* @return boolean True if successful, false otherwise and internal error is set.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
protected function batchClient($value, $pks, $contexts)
|
|
{
|
|
// Set the variables
|
|
$user = JFactory::getUser();
|
|
$table = $this->getTable();
|
|
|
|
foreach ($pks as $pk)
|
|
{
|
|
if ($user->authorise('core.edit', $contexts[$pk]))
|
|
{
|
|
$table->reset();
|
|
$table->load($pk);
|
|
$table->cid = (int) $value;
|
|
|
|
if (!$table->store())
|
|
{
|
|
$this->setError($table->getError());
|
|
return false;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT'));
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Clean the cache
|
|
$this->cleanCache();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Batch copy items to a new category or current.
|
|
*
|
|
* @param integer $value The new category.
|
|
* @param array $pks An array of row IDs.
|
|
* @param array $contexts An array of item contexts.
|
|
*
|
|
* @return mixed An array of new IDs on success, boolean false on failure.
|
|
*
|
|
* @since 2.5
|
|
*/
|
|
protected function batchCopy($value, $pks, $contexts)
|
|
{
|
|
$categoryId = (int) $value;
|
|
|
|
$table = $this->getTable();
|
|
$i = 0;
|
|
|
|
// Check that the category exists
|
|
if ($categoryId)
|
|
{
|
|
$categoryTable = JTable::getInstance('Category');
|
|
if (!$categoryTable->load($categoryId))
|
|
{
|
|
if ($error = $categoryTable->getError())
|
|
{
|
|
// Fatal error
|
|
$this->setError($error);
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_MOVE_CATEGORY_NOT_FOUND'));
|
|
return false;
|
|
}
|
|
}
|
|
}
|
|
|
|
if (empty($categoryId))
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_MOVE_CATEGORY_NOT_FOUND'));
|
|
return false;
|
|
}
|
|
|
|
// Check that the user has create permission for the component
|
|
$user = JFactory::getUser();
|
|
if (!$user->authorise('core.create', 'com_banners.category.' . $categoryId))
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_CREATE'));
|
|
return false;
|
|
}
|
|
|
|
// Parent exists so we let's proceed
|
|
while (!empty($pks))
|
|
{
|
|
// Pop the first ID off the stack
|
|
$pk = array_shift($pks);
|
|
|
|
$table->reset();
|
|
|
|
// Check that the row actually exists
|
|
if (!$table->load($pk))
|
|
{
|
|
if ($error = $table->getError())
|
|
{
|
|
// Fatal error
|
|
$this->setError($error);
|
|
return false;
|
|
}
|
|
else
|
|
{
|
|
// Not fatal error
|
|
$this->setError(JText::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk));
|
|
continue;
|
|
}
|
|
}
|
|
|
|
// Alter the title & alias
|
|
$data = $this->generateNewTitle($categoryId, $table->alias, $table->name);
|
|
$table->name = $data['0'];
|
|
$table->alias = $data['1'];
|
|
|
|
// Reset the ID because we are making a copy
|
|
$table->id = 0;
|
|
|
|
// New category ID
|
|
$table->catid = $categoryId;
|
|
|
|
// TODO: Deal with ordering?
|
|
//$table->ordering = 1;
|
|
|
|
// Check the row.
|
|
if (!$table->check())
|
|
{
|
|
$this->setError($table->getError());
|
|
return false;
|
|
}
|
|
|
|
// Store the row.
|
|
if (!$table->store())
|
|
{
|
|
$this->setError($table->getError());
|
|
return false;
|
|
}
|
|
|
|
// Get the new item ID
|
|
$newId = $table->get('id');
|
|
|
|
// Add the new ID to the array
|
|
$newIds[$i] = $newId;
|
|
$i++;
|
|
}
|
|
|
|
// Clean the cache
|
|
$this->cleanCache();
|
|
|
|
return $newIds;
|
|
}
|
|
|
|
/**
|
|
* Method to test whether a record can be deleted.
|
|
*
|
|
* @param object $record A record object.
|
|
*
|
|
* @return boolean True if allowed to delete the record. Defaults to the permission set in the component.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function canDelete($record)
|
|
{
|
|
if (!empty($record->id))
|
|
{
|
|
if ($record->state != -2)
|
|
{
|
|
return;
|
|
}
|
|
$user = JFactory::getUser();
|
|
|
|
if (!empty($record->catid))
|
|
{
|
|
return $user->authorise('core.delete', 'com_banners.category.' . (int) $record->catid);
|
|
}
|
|
else
|
|
{
|
|
return parent::canDelete($record);
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Method to test whether a record can have its state changed.
|
|
*
|
|
* @param object $record A record object.
|
|
*
|
|
* @return boolean True if allowed to change the state of the record. Defaults to the permission set in the component.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function canEditState($record)
|
|
{
|
|
$user = JFactory::getUser();
|
|
|
|
// Check against the category.
|
|
if (!empty($record->catid))
|
|
{
|
|
return $user->authorise('core.edit.state', 'com_banners.category.' . (int) $record->catid);
|
|
}
|
|
// Default to component settings if category not known.
|
|
else
|
|
{
|
|
return parent::canEditState($record);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Returns a JTable object, always creating it.
|
|
*
|
|
* @param string $type The table type to instantiate. [optional]
|
|
* @param string $prefix A prefix for the table class name. [optional]
|
|
* @param array $config Configuration array for model. [optional]
|
|
*
|
|
* @return JTable A database object
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function getTable($type = 'Banner', $prefix = 'BannersTable', $config = array())
|
|
{
|
|
return JTable::getInstance($type, $prefix, $config);
|
|
}
|
|
|
|
/**
|
|
* Method to get the record form.
|
|
*
|
|
* @param array $data Data for the form. [optional]
|
|
* @param boolean $loadData True if the form is to load its own data (default case), false if not. [optional]
|
|
*
|
|
* @return mixed A JForm object on success, false on failure
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function getForm($data = array(), $loadData = true)
|
|
{
|
|
// Get the form.
|
|
$form = $this->loadForm('com_banners.banner', 'banner', array('control' => 'jform', 'load_data' => $loadData));
|
|
if (empty($form))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// Determine correct permissions to check.
|
|
if ($this->getState('banner.id'))
|
|
{
|
|
// Existing record. Can only edit in selected categories.
|
|
$form->setFieldAttribute('catid', 'action', 'core.edit');
|
|
}
|
|
else
|
|
{
|
|
// New record. Can only create in selected categories.
|
|
$form->setFieldAttribute('catid', 'action', 'core.create');
|
|
}
|
|
|
|
// Modify the form based on access controls.
|
|
if (!$this->canEditState((object) $data))
|
|
{
|
|
// Disable fields for display.
|
|
$form->setFieldAttribute('ordering', 'disabled', 'true');
|
|
$form->setFieldAttribute('publish_up', 'disabled', 'true');
|
|
$form->setFieldAttribute('publish_down', 'disabled', 'true');
|
|
$form->setFieldAttribute('state', 'disabled', 'true');
|
|
$form->setFieldAttribute('sticky', 'disabled', 'true');
|
|
|
|
// Disable fields while saving.
|
|
// The controller has already verified this is a record you can edit.
|
|
$form->setFieldAttribute('ordering', 'filter', 'unset');
|
|
$form->setFieldAttribute('publish_up', 'filter', 'unset');
|
|
$form->setFieldAttribute('publish_down', 'filter', 'unset');
|
|
$form->setFieldAttribute('state', 'filter', 'unset');
|
|
$form->setFieldAttribute('sticky', 'filter', 'unset');
|
|
}
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Method to get the data that should be injected in the form.
|
|
*
|
|
* @return mixed The data for the form.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function loadFormData()
|
|
{
|
|
// Check the session for previously entered form data.
|
|
$app = JFactory::getApplication();
|
|
$data = $app->getUserState('com_banners.edit.banner.data', array());
|
|
|
|
if (empty($data))
|
|
{
|
|
$data = $this->getItem();
|
|
|
|
// Prime some default values.
|
|
if ($this->getState('banner.id') == 0)
|
|
{
|
|
$data->set('catid', $app->input->getInt('catid', $app->getUserState('com_banners.banners.filter.category_id')));
|
|
}
|
|
}
|
|
|
|
$this->preprocessData('com_banners.banner', $data);
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Method to stick records.
|
|
*
|
|
* @param array &$pks The ids of the items to publish.
|
|
* @param integer $value The value of the published state
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function stick(&$pks, $value = 1)
|
|
{
|
|
$user = JFactory::getUser();
|
|
$table = $this->getTable();
|
|
$pks = (array) $pks;
|
|
|
|
// Access checks.
|
|
foreach ($pks as $i => $pk)
|
|
{
|
|
if ($table->load($pk))
|
|
{
|
|
if (!$this->canEditState($table))
|
|
{
|
|
// Prune items that you can't change.
|
|
unset($pks[$i]);
|
|
JError::raiseWarning(403, JText::_('JLIB_APPLICATION_ERROR_EDITSTATE_NOT_PERMITTED'));
|
|
}
|
|
}
|
|
}
|
|
|
|
// Attempt to change the state of the records.
|
|
if (!$table->stick($pks, $value, $user->get('id')))
|
|
{
|
|
$this->setError($table->getError());
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* A protected method to get a set of ordering conditions.
|
|
*
|
|
* @param JTable $table A record object.
|
|
*
|
|
* @return array An array of conditions to add to add to ordering queries.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function getReorderConditions($table)
|
|
{
|
|
$condition = array();
|
|
$condition[] = 'catid = '. (int) $table->catid;
|
|
$condition[] = 'state >= 0';
|
|
return $condition;
|
|
}
|
|
|
|
/**
|
|
* @since 3.0
|
|
*/
|
|
protected function prepareTable($table)
|
|
{
|
|
$date = JFactory::getDate();
|
|
$user = JFactory::getUser();
|
|
|
|
if (empty($table->id))
|
|
{
|
|
// Set the values
|
|
$table->created = $date->toSql();
|
|
|
|
// Set ordering to the last item if not set
|
|
if (empty($table->ordering))
|
|
{
|
|
$db = JFactory::getDbo();
|
|
$db->setQuery('SELECT MAX(ordering) FROM #__banners');
|
|
$max = $db->loadResult();
|
|
|
|
$table->ordering = $max + 1;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
// Set the values
|
|
$table->modified = $date->toSql();
|
|
$table->modified_by = $user->get('id');
|
|
}
|
|
// Increment the content version number.
|
|
$table->version++;
|
|
}
|
|
|
|
/**
|
|
* Method to save the form data.
|
|
*
|
|
* @param array The form data.
|
|
*
|
|
* @return boolean True on success.
|
|
* @since 1.6
|
|
*/
|
|
|
|
public function save($data)
|
|
{
|
|
$app = JFactory::getApplication();
|
|
|
|
// Alter the name for save as copy
|
|
if ($app->input->get('task') == 'save2copy')
|
|
{
|
|
list($name, $alias) = $this->generateNewTitle($data['catid'], $data['alias'], $data['name']);
|
|
$data['name'] = $name;
|
|
$data['alias'] = $alias;
|
|
$data['state'] = 0;
|
|
}
|
|
|
|
if (parent::save($data))
|
|
{
|
|
return true;
|
|
}
|
|
|
|
return false;
|
|
}
|
|
|
|
}
|