/administrator/components/com_contact/models/contact.php
https://bitbucket.org/eternaware/joomus · PHP · 521 lines · 290 code · 71 blank · 160 comment · 43 complexity · 4b5fad2f663c05f76da1cfdb1a27a876 MD5 · raw file
- <?php
- /**
- * @package Joomla.Administrator
- * @subpackage com_contact
- *
- * @copyright Copyright (C) 2005 - 2012 Open Source Matters, Inc. All rights reserved.
- * @license GNU General Public License version 2 or later; see LICENSE.txt
- */
- defined('_JEXEC') or die;
- /**
- * Item Model for a Contact.
- *
- * @package Joomla.Administrator
- * @subpackage com_contact
- * @since 1.6
- */
- class ContactModelContact extends JModelAdmin
- {
- /**
- * 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 (!empty($commands['assetgroup_id']))
- {
- if (!$this->batchAccess($commands['assetgroup_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 (strlen($commands['user_id']) > 0)
- {
- if (!$this->batchUser($commands['user_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 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 11.1
- */
- 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_contact.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;
- }
- /**
- * Batch change a linked user.
- *
- * @param integer $value The new value matching a User ID.
- * @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 batchUser($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->user_id = (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;
- }
- /**
- * 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->published != -2) {
- return;
- }
- $user = JFactory::getUser();
- return $user->authorise('core.delete', 'com_contact.category.'.(int) $record->catid);
- }
- }
- /**
- * Method to test whether a record can have its state edited.
- *
- * @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_contact.category.'.(int) $record->catid);
- }
- // Default to component settings if category not known.
- else {
- return parent::canEditState($record);
- }
- }
- /**
- * Returns a Table object, always creating it
- *
- * @param type $type The table type to instantiate
- * @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 = 'Contact', $prefix = 'ContactTable', $config = array())
- {
- return JTable::getInstance($type, $prefix, $config);
- }
- /**
- * Method to get the row form.
- *
- * @param array $data Data for the form.
- * @param boolean $loadData True if the form is to load its own data (default case), false if not.
- *
- * @return mixed A JForm object on success, false on failure
- * @since 1.6
- */
- public function getForm($data = array(), $loadData = true)
- {
- JForm::addFieldPath('JPATH_ADMINISTRATOR/components/com_users/models/fields');
- // Get the form.
- $form = $this->loadForm('com_contact.contact', 'contact', array('control' => 'jform', 'load_data' => $loadData));
- if (empty($form)) {
- return false;
- }
- // Modify the form based on access controls.
- if (!$this->canEditState((object) $data)) {
- // Disable fields for display.
- $form->setFieldAttribute('featured', 'disabled', 'true');
- $form->setFieldAttribute('ordering', 'disabled', 'true');
- $form->setFieldAttribute('published', 'disabled', 'true');
- // Disable fields while saving.
- // The controller has already verified this is a record you can edit.
- $form->setFieldAttribute('featured', 'filter', 'unset');
- $form->setFieldAttribute('ordering', 'filter', 'unset');
- $form->setFieldAttribute('published', 'filter', 'unset');
- }
- return $form;
- }
- /**
- * Method to get a single record.
- *
- * @param integer $pk The id of the primary key.
- *
- * @return mixed Object on success, false on failure.
- * @since 1.6
- */
- public function getItem($pk = null)
- {
- if ($item = parent::getItem($pk)) {
- // Convert the params field to an array.
- $registry = new JRegistry;
- $registry->loadString($item->metadata);
- $item->metadata = $registry->toArray();
- }
- return $item;
- }
- /**
- * 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.
- $data = JFactory::getApplication()->getUserState('com_contact.edit.contact.data', array());
- if (empty($data)) {
- $data = $this->getItem();
- // Prime some default values.
- if ($this->getState('contact.id') == 0) {
- $app = JFactory::getApplication();
- $data->set('catid', $app->input->get('catid', $app->getUserState('com_contact.contacts.filter.category_id'), 'int'));
- }
- }
- return $data;
- }
- /**
- * Prepare and sanitise the table prior to saving.
- *
- * @param JTable $table
- *
- * @return void
- * @since 1.6
- */
- protected function prepareTable($table)
- {
- $date = JFactory::getDate();
- $user = JFactory::getUser();
- $table->name = htmlspecialchars_decode($table->name, ENT_QUOTES);
- $table->alias = JApplication::stringURLSafe($table->alias);
- if (empty($table->alias)) {
- $table->alias = JApplication::stringURLSafe($table->name);
- }
- 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 #__contact_details');
- $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++;
- }
- /**
- * 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;
- return $condition;
- }
- /**
- * Method to toggle the featured setting of contacts.
- *
- * @param array $pks The ids of the items to toggle.
- * @param int $value The value to toggle to.
- *
- * @return boolean True on success.
- * @since 1.6
- */
- public function featured($pks, $value = 0)
- {
- // Sanitize the ids.
- $pks = (array) $pks;
- JArrayHelper::toInteger($pks);
- if (empty($pks)) {
- $this->setError(JText::_('COM_CONTACT_NO_ITEM_SELECTED'));
- return false;
- }
- $table = $this->getTable();
- try
- {
- $db = $this->getDbo();
- $db->setQuery(
- 'UPDATE #__contact_details' .
- ' SET featured = '.(int) $value.
- ' WHERE id IN ('.implode(',', $pks).')'
- );
- $db->execute();
- }
- catch (Exception $e)
- {
- $this->setError($e->getMessage());
- return false;
- }
- $table->reorder();
- // Clean component's cache
- $this->cleanCache();
- return true;
- }
- }