318 lines
9.4 KiB
PHP
318 lines
9.4 KiB
PHP
<?php
|
|
|
|
/**
|
|
* @package Joomla.Administrator
|
|
* @subpackage com_fields
|
|
*
|
|
* @copyright (C) 2016 Open Source Matters, Inc. <https://www.joomla.org>
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
namespace Joomla\Component\Fields\Administrator\Table;
|
|
|
|
use Joomla\CMS\Access\Rules;
|
|
use Joomla\CMS\Application\ApplicationHelper;
|
|
use Joomla\CMS\Factory;
|
|
use Joomla\CMS\Language\Text;
|
|
use Joomla\CMS\Table\Table;
|
|
use Joomla\Database\DatabaseDriver;
|
|
use Joomla\Registry\Registry;
|
|
use Joomla\String\StringHelper;
|
|
|
|
// phpcs:disable PSR1.Files.SideEffects
|
|
\defined('_JEXEC') or die;
|
|
// phpcs:enable PSR1.Files.SideEffects
|
|
|
|
/**
|
|
* Fields Table
|
|
*
|
|
* @since 3.7.0
|
|
*/
|
|
class FieldTable extends Table
|
|
{
|
|
/**
|
|
* Indicates that columns fully support the NULL value in the database
|
|
*
|
|
* @var boolean
|
|
* @since 4.0.0
|
|
*/
|
|
protected $_supportNullValue = true;
|
|
|
|
/**
|
|
* Class constructor.
|
|
*
|
|
* @param DatabaseDriver $db DatabaseDriver object.
|
|
*
|
|
* @since 3.7.0
|
|
*/
|
|
public function __construct($db = null)
|
|
{
|
|
parent::__construct('#__fields', 'id', $db);
|
|
|
|
$this->setColumnAlias('published', 'state');
|
|
}
|
|
|
|
/**
|
|
* Method to bind an associative array or object to the JTable instance.This
|
|
* method only binds properties that are publicly accessible and optionally
|
|
* takes an array of properties to ignore when binding.
|
|
*
|
|
* @param mixed $src An associative array or object to bind to the JTable instance.
|
|
* @param mixed $ignore An optional array or space separated list of properties to ignore while binding.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 3.7.0
|
|
* @throws \InvalidArgumentException
|
|
*/
|
|
public function bind($src, $ignore = '')
|
|
{
|
|
if (isset($src['params']) && is_array($src['params'])) {
|
|
$registry = new Registry();
|
|
$registry->loadArray($src['params']);
|
|
$src['params'] = (string) $registry;
|
|
}
|
|
|
|
if (isset($src['fieldparams']) && is_array($src['fieldparams'])) {
|
|
// Make sure $registry->options contains no duplicates when the field type is subform
|
|
if (isset($src['type']) && $src['type'] == 'subform' && isset($src['fieldparams']['options'])) {
|
|
// Fast lookup map to check which custom field ids we have already seen
|
|
$seen_customfields = [];
|
|
|
|
// Container for the new $src['fieldparams']['options']
|
|
$options = [];
|
|
|
|
// Iterate through the old options
|
|
$i = 0;
|
|
|
|
foreach ($src['fieldparams']['options'] as $option) {
|
|
// Check whether we have not yet seen this custom field id
|
|
if (!isset($seen_customfields[$option['customfield']])) {
|
|
// We haven't, so add it to the final options
|
|
$seen_customfields[$option['customfield']] = true;
|
|
$options['option' . $i] = $option;
|
|
$i++;
|
|
}
|
|
}
|
|
|
|
// And replace the options with the deduplicated ones.
|
|
$src['fieldparams']['options'] = $options;
|
|
}
|
|
|
|
$registry = new Registry();
|
|
$registry->loadArray($src['fieldparams']);
|
|
$src['fieldparams'] = (string) $registry;
|
|
}
|
|
|
|
// Bind the rules.
|
|
if (isset($src['rules']) && is_array($src['rules'])) {
|
|
$rules = new Rules($src['rules']);
|
|
$this->setRules($rules);
|
|
}
|
|
|
|
return parent::bind($src, $ignore);
|
|
}
|
|
|
|
/**
|
|
* Method to perform sanity checks on the JTable instance properties to ensure
|
|
* they are safe to store in the database. Child classes should override this
|
|
* method to make sure the data they are storing in the database is safe and
|
|
* as expected before storage.
|
|
*
|
|
* @return boolean True if the instance is sane and able to be stored in the database.
|
|
*
|
|
* @link https://docs.joomla.org/Special:MyLanguage/JTable/check
|
|
* @since 3.7.0
|
|
*/
|
|
public function check()
|
|
{
|
|
// Check for valid name
|
|
if (trim($this->title) == '') {
|
|
$this->setError(Text::_('COM_FIELDS_MUSTCONTAIN_A_TITLE_FIELD'));
|
|
|
|
return false;
|
|
}
|
|
|
|
if (empty($this->name)) {
|
|
$this->name = $this->title;
|
|
}
|
|
|
|
$this->name = ApplicationHelper::stringURLSafe($this->name, $this->language);
|
|
|
|
if (trim(str_replace('-', '', $this->name)) == '') {
|
|
$this->name = StringHelper::increment($this->name, 'dash');
|
|
}
|
|
|
|
$this->name = str_replace(',', '-', $this->name);
|
|
|
|
// Verify that the name is unique
|
|
$table = new static($this->_db);
|
|
|
|
if ($table->load(['name' => $this->name]) && ($table->id != $this->id || $this->id == 0)) {
|
|
$this->setError(Text::_('COM_FIELDS_ERROR_UNIQUE_NAME'));
|
|
|
|
return false;
|
|
}
|
|
|
|
$this->name = str_replace(',', '-', $this->name);
|
|
|
|
if (empty($this->type)) {
|
|
$this->type = 'text';
|
|
}
|
|
|
|
if (empty($this->fieldparams)) {
|
|
$this->fieldparams = '{}';
|
|
}
|
|
|
|
$date = Factory::getDate()->toSql();
|
|
$user = Factory::getUser();
|
|
|
|
// Set created date if not set.
|
|
if (!(int) $this->created_time) {
|
|
$this->created_time = $date;
|
|
}
|
|
|
|
if ($this->id) {
|
|
// Existing item
|
|
$this->modified_time = $date;
|
|
$this->modified_by = $user->get('id');
|
|
} else {
|
|
if (!(int) $this->modified_time) {
|
|
$this->modified_time = $this->created_time;
|
|
}
|
|
|
|
if (empty($this->created_user_id)) {
|
|
$this->created_user_id = $user->get('id');
|
|
}
|
|
|
|
if (empty($this->modified_by)) {
|
|
$this->modified_by = $this->created_user_id;
|
|
}
|
|
}
|
|
|
|
if (empty($this->group_id)) {
|
|
$this->group_id = 0;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Overloaded store function
|
|
*
|
|
* @param boolean $updateNulls True to update fields even if they are null.
|
|
*
|
|
* @return mixed False on failure, positive integer on success.
|
|
*
|
|
* @see Table::store()
|
|
* @since 4.0.0
|
|
*/
|
|
public function store($updateNulls = true)
|
|
{
|
|
return parent::store($updateNulls);
|
|
}
|
|
|
|
/**
|
|
* Method to compute the default name of the asset.
|
|
* The default name is in the form table_name.id
|
|
* where id is the value of the primary key of the table.
|
|
*
|
|
* @return string
|
|
*
|
|
* @since 3.7.0
|
|
*/
|
|
protected function _getAssetName()
|
|
{
|
|
$contextArray = explode('.', $this->context);
|
|
|
|
return $contextArray[0] . '.field.' . (int) $this->id;
|
|
}
|
|
|
|
/**
|
|
* Method to return the title to use for the asset table. In
|
|
* tracking the assets a title is kept for each asset so that there is some
|
|
* context available in a unified access manager. Usually this would just
|
|
* return $this->title or $this->name or whatever is being used for the
|
|
* primary name of the row. If this method is not overridden, the asset name is used.
|
|
*
|
|
* @return string The string to use as the title in the asset table.
|
|
*
|
|
* @link https://docs.joomla.org/Special:MyLanguage/JTable/getAssetTitle
|
|
* @since 3.7.0
|
|
*/
|
|
protected function _getAssetTitle()
|
|
{
|
|
return $this->title;
|
|
}
|
|
|
|
/**
|
|
* Method to get the parent asset under which to register this one.
|
|
* By default, all assets are registered to the ROOT node with ID,
|
|
* which will default to 1 if none exists.
|
|
* The extended class can define a table and id to lookup. If the
|
|
* asset does not exist it will be created.
|
|
*
|
|
* @param Table $table A Table object for the asset parent.
|
|
* @param integer $id Id to look up
|
|
*
|
|
* @return integer
|
|
*
|
|
* @since 3.7.0
|
|
*/
|
|
protected function _getAssetParentId(Table $table = null, $id = null)
|
|
{
|
|
$contextArray = explode('.', $this->context);
|
|
$component = $contextArray[0];
|
|
|
|
if ($this->group_id) {
|
|
$assetId = $this->getAssetId($component . '.fieldgroup.' . (int) $this->group_id);
|
|
|
|
if ($assetId) {
|
|
return $assetId;
|
|
}
|
|
} else {
|
|
$assetId = $this->getAssetId($component);
|
|
|
|
if ($assetId) {
|
|
return $assetId;
|
|
}
|
|
}
|
|
|
|
return parent::_getAssetParentId($table, $id);
|
|
}
|
|
|
|
/**
|
|
* Returns an asset id for the given name or false.
|
|
*
|
|
* @param string $name The asset name
|
|
*
|
|
* @return number|boolean
|
|
*
|
|
* @since 3.7.0
|
|
*/
|
|
private function getAssetId($name)
|
|
{
|
|
$db = $this->getDbo();
|
|
$query = $db->getQuery(true)
|
|
->select($db->quoteName('id'))
|
|
->from($db->quoteName('#__assets'))
|
|
->where($db->quoteName('name') . ' = :name')
|
|
->bind(':name', $name);
|
|
|
|
// Get the asset id from the database.
|
|
$db->setQuery($query);
|
|
|
|
$assetId = null;
|
|
|
|
if ($result = $db->loadResult()) {
|
|
$assetId = (int) $result;
|
|
|
|
if ($assetId) {
|
|
return $assetId;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|