517 lines
15 KiB
PHP
517 lines
15 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @package Joomla.Administrator
|
|
* @subpackage com_contact
|
|
*
|
|
* @copyright (C) 2008 Open Source Matters, Inc. <https://www.joomla.org>
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace Joomla\Component\Contact\Administrator\Model;
|
|
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\Form\Form;
|
|
use Joomla\CMS\Helper\TagsHelper;
|
|
use Joomla\CMS\Language\Associations;
|
|
use Joomla\CMS\Language\LanguageHelper;
|
|
use Joomla\CMS\Language\Text;
|
|
use Joomla\CMS\MVC\Model\AdminModel;
|
|
use Joomla\CMS\String\PunycodeHelper;
|
|
use Joomla\CMS\Versioning\VersionableModelTrait;
|
|
use Joomla\Component\Categories\Administrator\Helper\CategoriesHelper;
|
|
use Joomla\Database\ParameterType;
|
|
use Joomla\Registry\Registry;
|
|
use Joomla\Utilities\ArrayHelper;
|
|
|
|
// phpcs:disable PSR1.Files.SideEffects
|
|
\defined('_JEXEC') or die;
|
|
// phpcs:enable PSR1.Files.SideEffects
|
|
|
|
/**
|
|
* Item Model for a Contact.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
class ContactModel extends AdminModel
|
|
{
|
|
use VersionableModelTrait;
|
|
|
|
/**
|
|
* The type alias for this content type.
|
|
*
|
|
* @var string
|
|
* @since 3.2
|
|
*/
|
|
public $typeAlias = 'com_contact.contact';
|
|
|
|
/**
|
|
* The context used for the associations table
|
|
*
|
|
* @var string
|
|
* @since 3.4.4
|
|
*/
|
|
protected $associationsContext = 'com_contact.item';
|
|
|
|
/**
|
|
* Batch copy/move command. If set to false, the batch copy/move command is not supported
|
|
*
|
|
* @var string
|
|
*/
|
|
protected $batch_copymove = 'category_id';
|
|
|
|
/**
|
|
* Allowed batch commands
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $batch_commands = [
|
|
'assetgroup_id' => 'batchAccess',
|
|
'language_id' => 'batchLanguage',
|
|
'tag' => 'batchTag',
|
|
'user_id' => 'batchUser',
|
|
];
|
|
|
|
/**
|
|
* Name of the form
|
|
*
|
|
* @var string
|
|
* @since 4.0.0
|
|
*/
|
|
protected $formName = 'contact';
|
|
|
|
/**
|
|
* 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)
|
|
{
|
|
foreach ($pks as $pk) {
|
|
if ($this->user->authorise('core.edit', $contexts[$pk])) {
|
|
$this->table->reset();
|
|
$this->table->load($pk);
|
|
$this->table->user_id = (int) $value;
|
|
|
|
if (!$this->table->store()) {
|
|
$this->setError($this->table->getError());
|
|
|
|
return false;
|
|
}
|
|
} else {
|
|
$this->setError(Text::_('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) || $record->published != -2) {
|
|
return false;
|
|
}
|
|
|
|
return $this->getCurrentUser()->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)
|
|
{
|
|
// Check against the category.
|
|
if (!empty($record->catid)) {
|
|
return $this->getCurrentUser()->authorise('core.edit.state', 'com_contact.category.' . (int) $record->catid);
|
|
}
|
|
|
|
// Default to component settings if category not known.
|
|
return parent::canEditState($record);
|
|
}
|
|
|
|
/**
|
|
* 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 Form|boolean A Form object on success, false on failure
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function getForm($data = [], $loadData = true)
|
|
{
|
|
Form::addFieldPath(JPATH_ADMINISTRATOR . '/components/com_users/models/fields');
|
|
|
|
// Get the form.
|
|
$form = $this->loadForm('com_contact.' . $this->formName, $this->formName, ['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');
|
|
}
|
|
|
|
// Don't allow to change the created_by user if not allowed to access com_users.
|
|
if (!$this->getCurrentUser()->authorise('core.manage', 'com_users')) {
|
|
$form->setFieldAttribute('created_by', '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 metadata field to an array.
|
|
$registry = new Registry($item->metadata);
|
|
$item->metadata = $registry->toArray();
|
|
}
|
|
|
|
// Load associated contact items
|
|
$assoc = Associations::isEnabled();
|
|
|
|
if ($assoc) {
|
|
$item->associations = [];
|
|
|
|
if ($item->id != null) {
|
|
$associations = Associations::getAssociations('com_contact', '#__contact_details', 'com_contact.item', $item->id);
|
|
|
|
foreach ($associations as $tag => $association) {
|
|
$item->associations[$tag] = $association->id;
|
|
}
|
|
}
|
|
}
|
|
|
|
// Load item tags
|
|
if (!empty($item->id)) {
|
|
$item->tags = new TagsHelper();
|
|
$item->tags->getTagIds($item->id, 'com_contact.contact');
|
|
}
|
|
|
|
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()
|
|
{
|
|
$app = Factory::getApplication();
|
|
|
|
// Check the session for previously entered form data.
|
|
$data = $app->getUserState('com_contact.edit.contact.data', []);
|
|
|
|
if (empty($data)) {
|
|
$data = $this->getItem();
|
|
|
|
// Prime some default values.
|
|
if ($this->getState('contact.id') == 0) {
|
|
$data->set('catid', $app->getInput()->get('catid', $app->getUserState('com_contact.contacts.filter.category_id'), 'int'));
|
|
}
|
|
}
|
|
|
|
$this->preprocessData('com_contact.contact', $data);
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Method to save the form data.
|
|
*
|
|
* @param array $data The form data.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
public function save($data)
|
|
{
|
|
$input = Factory::getApplication()->getInput();
|
|
|
|
// Create new category, if needed.
|
|
$createCategory = true;
|
|
|
|
// If category ID is provided, check if it's valid.
|
|
if (is_numeric($data['catid']) && $data['catid']) {
|
|
$createCategory = !CategoriesHelper::validateCategoryId($data['catid'], 'com_contact');
|
|
}
|
|
|
|
// Save New Category
|
|
if ($createCategory && $this->canCreateCategory()) {
|
|
$category = [
|
|
// Remove #new# prefix, if exists.
|
|
'title' => strpos($data['catid'], '#new#') === 0 ? substr($data['catid'], 5) : $data['catid'],
|
|
'parent_id' => 1,
|
|
'extension' => 'com_contact',
|
|
'language' => $data['language'],
|
|
'published' => 1,
|
|
];
|
|
|
|
/** @var \Joomla\Component\Categories\Administrator\Model\CategoryModel $categoryModel */
|
|
$categoryModel = Factory::getApplication()->bootComponent('com_categories')
|
|
->getMVCFactory()->createModel('Category', 'Administrator', ['ignore_request' => true]);
|
|
|
|
// Create new category.
|
|
if (!$categoryModel->save($category)) {
|
|
$this->setError($categoryModel->getError());
|
|
|
|
return false;
|
|
}
|
|
|
|
// Get the Category ID.
|
|
$data['catid'] = $categoryModel->getState('category.id');
|
|
}
|
|
|
|
// Alter the name for save as copy
|
|
if ($input->get('task') == 'save2copy') {
|
|
$origTable = clone $this->getTable();
|
|
$origTable->load($input->getInt('id'));
|
|
|
|
if ($data['name'] == $origTable->name) {
|
|
list($name, $alias) = $this->generateNewTitle($data['catid'], $data['alias'], $data['name']);
|
|
$data['name'] = $name;
|
|
$data['alias'] = $alias;
|
|
} else {
|
|
if ($data['alias'] == $origTable->alias) {
|
|
$data['alias'] = '';
|
|
}
|
|
}
|
|
|
|
$data['published'] = 0;
|
|
}
|
|
|
|
$links = ['linka', 'linkb', 'linkc', 'linkd', 'linke'];
|
|
|
|
foreach ($links as $link) {
|
|
if (!empty($data['params'][$link])) {
|
|
$data['params'][$link] = PunycodeHelper::urlToPunycode($data['params'][$link]);
|
|
}
|
|
}
|
|
|
|
return parent::save($data);
|
|
}
|
|
|
|
/**
|
|
* Prepare and sanitise the table prior to saving.
|
|
*
|
|
* @param \Joomla\CMS\Table\Table $table The Table object
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function prepareTable($table)
|
|
{
|
|
$date = Factory::getDate()->toSql();
|
|
|
|
$table->name = htmlspecialchars_decode($table->name, ENT_QUOTES);
|
|
|
|
$table->generateAlias();
|
|
|
|
if (empty($table->id)) {
|
|
// Set the values
|
|
$table->created = $date;
|
|
|
|
// Set ordering to the last item if not set
|
|
if (empty($table->ordering)) {
|
|
$db = $this->getDatabase();
|
|
$query = $db->getQuery(true)
|
|
->select('MAX(ordering)')
|
|
->from($db->quoteName('#__contact_details'));
|
|
$db->setQuery($query);
|
|
$max = $db->loadResult();
|
|
|
|
$table->ordering = $max + 1;
|
|
}
|
|
} else {
|
|
// Set the values
|
|
$table->modified = $date;
|
|
$table->modified_by = $this->getCurrentUser()->id;
|
|
}
|
|
|
|
// Increment the content version number.
|
|
$table->version++;
|
|
}
|
|
|
|
/**
|
|
* A protected method to get a set of ordering conditions.
|
|
*
|
|
* @param \Joomla\CMS\Table\Table $table A record object.
|
|
*
|
|
* @return array An array of conditions to add to ordering queries.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function getReorderConditions($table)
|
|
{
|
|
return [
|
|
$this->getDatabase()->quoteName('catid') . ' = ' . (int) $table->catid,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Preprocess the form.
|
|
*
|
|
* @param Form $form Form object.
|
|
* @param object $data Data object.
|
|
* @param string $group Group name.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 3.0.3
|
|
*/
|
|
protected function preprocessForm(Form $form, $data, $group = 'content')
|
|
{
|
|
if ($this->canCreateCategory()) {
|
|
$form->setFieldAttribute('catid', 'allowAdd', 'true');
|
|
|
|
// Add a prefix for categories created on the fly.
|
|
$form->setFieldAttribute('catid', 'customPrefix', '#new#');
|
|
}
|
|
|
|
// Association contact items
|
|
if (Associations::isEnabled()) {
|
|
$languages = LanguageHelper::getContentLanguages(false, false, null, 'ordering', 'asc');
|
|
|
|
if (\count($languages) > 1) {
|
|
$addform = new \SimpleXMLElement('<form />');
|
|
$fields = $addform->addChild('fields');
|
|
$fields->addAttribute('name', 'associations');
|
|
$fieldset = $fields->addChild('fieldset');
|
|
$fieldset->addAttribute('name', 'item_associations');
|
|
|
|
foreach ($languages as $language) {
|
|
$field = $fieldset->addChild('field');
|
|
$field->addAttribute('name', $language->lang_code);
|
|
$field->addAttribute('type', 'modal_contact');
|
|
$field->addAttribute('language', $language->lang_code);
|
|
$field->addAttribute('label', $language->title);
|
|
$field->addAttribute('translate_label', 'false');
|
|
$field->addAttribute('select', 'true');
|
|
$field->addAttribute('new', 'true');
|
|
$field->addAttribute('edit', 'true');
|
|
$field->addAttribute('clear', 'true');
|
|
$field->addAttribute('propagate', 'true');
|
|
}
|
|
|
|
$form->load($addform, false);
|
|
}
|
|
}
|
|
|
|
parent::preprocessForm($form, $data, $group);
|
|
}
|
|
|
|
/**
|
|
* Method to toggle the featured setting of contacts.
|
|
*
|
|
* @param array $pks The ids of the items to toggle.
|
|
* @param integer $value The value to toggle to.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function featured($pks, $value = 0)
|
|
{
|
|
// Sanitize the ids.
|
|
$pks = ArrayHelper::toInteger((array) $pks);
|
|
|
|
if (empty($pks)) {
|
|
$this->setError(Text::_('COM_CONTACT_NO_ITEM_SELECTED'));
|
|
|
|
return false;
|
|
}
|
|
|
|
$table = $this->getTable();
|
|
|
|
try {
|
|
$db = $this->getDatabase();
|
|
|
|
$query = $db->getQuery(true);
|
|
$query->update($db->quoteName('#__contact_details'));
|
|
$query->set($db->quoteName('featured') . ' = :featured');
|
|
$query->whereIn($db->quoteName('id'), $pks);
|
|
$query->bind(':featured', $value, ParameterType::INTEGER);
|
|
|
|
$db->setQuery($query);
|
|
|
|
$db->execute();
|
|
} catch (\Exception $e) {
|
|
$this->setError($e->getMessage());
|
|
|
|
return false;
|
|
}
|
|
|
|
$table->reorder();
|
|
|
|
// Clean component's cache
|
|
$this->cleanCache();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Is the user allowed to create an on the fly category?
|
|
*
|
|
* @return boolean
|
|
*
|
|
* @since 3.6.1
|
|
*/
|
|
private function canCreateCategory()
|
|
{
|
|
return $this->getCurrentUser()->authorise('core.create', 'com_contact');
|
|
}
|
|
}
|