forked from joomla/Component-Builder
1353 lines
35 KiB
PHP
1353 lines
35 KiB
PHP
<?php
|
|
/**
|
|
* @package Joomla.Component.Builder
|
|
*
|
|
* @created 30th April, 2015
|
|
* @author Llewellyn van der Merwe <http://www.joomlacomponentbuilder.com>
|
|
* @gitea Joomla Component Builder <https://git.vdm.dev/joomla/Component-Builder>
|
|
* @github Joomla Component Builder <https://github.com/vdm-io/Joomla-Component-Builder>
|
|
* @copyright Copyright (C) 2015 Vast Development Method. All rights reserved.
|
|
* @license GNU General Public License version 2 or later; see LICENSE.txt
|
|
*/
|
|
|
|
// No direct access to this file
|
|
defined('_JEXEC') or die('Restricted access');
|
|
|
|
use Joomla\Registry\Registry;
|
|
use Joomla\String\StringHelper;
|
|
use Joomla\Utilities\ArrayHelper;
|
|
|
|
/**
|
|
* Componentbuilder Fieldtype Model
|
|
*/
|
|
class ComponentbuilderModelFieldtype extends JModelAdmin
|
|
{
|
|
/**
|
|
* The tab layout fields array.
|
|
*
|
|
* @var array
|
|
*/
|
|
protected $tabLayoutFields = array(
|
|
'details' => array(
|
|
'left' => array(
|
|
'catid',
|
|
'short_description'
|
|
),
|
|
'right' => array(
|
|
'description'
|
|
),
|
|
'fullwidth' => array(
|
|
'note_on_fields',
|
|
'properties',
|
|
'not_required'
|
|
),
|
|
'above' => array(
|
|
'name'
|
|
)
|
|
),
|
|
'database_defaults' => array(
|
|
'left' => array(
|
|
'has_defaults',
|
|
'datatype',
|
|
'datalenght',
|
|
'datalenght_other',
|
|
'datadefault',
|
|
'datadefault_other'
|
|
),
|
|
'right' => array(
|
|
'indexes',
|
|
'null_switch',
|
|
'store',
|
|
'note_whmcs_encryption'
|
|
)
|
|
)
|
|
);
|
|
|
|
/**
|
|
* @var string The prefix to use with controller messages.
|
|
* @since 1.6
|
|
*/
|
|
protected $text_prefix = 'COM_COMPONENTBUILDER';
|
|
|
|
/**
|
|
* The type alias for this content type.
|
|
*
|
|
* @var string
|
|
* @since 3.2
|
|
*/
|
|
public $typeAlias = 'com_componentbuilder.fieldtype';
|
|
|
|
/**
|
|
* 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 = 'fieldtype', $prefix = 'ComponentbuilderTable', $config = array())
|
|
{
|
|
// add table path for when model gets used from other component
|
|
$this->addTablePath(JPATH_ADMINISTRATOR . '/components/com_componentbuilder/tables');
|
|
// get instance of the table
|
|
return JTable::getInstance($type, $prefix, $config);
|
|
}
|
|
|
|
|
|
/**
|
|
* get VDM internal session key
|
|
*
|
|
* @return string the session key
|
|
*
|
|
*/
|
|
public function getVDM()
|
|
{
|
|
if (!isset($this->vastDevMod))
|
|
{
|
|
$_id = 0; // new item probably (since it was not set in the getItem method)
|
|
|
|
if (empty($_id))
|
|
{
|
|
$id = 0;
|
|
}
|
|
else
|
|
{
|
|
$id = $_id;
|
|
}
|
|
// set the id and view name to session
|
|
if ($vdm = ComponentbuilderHelper::get('fieldtype__'.$id))
|
|
{
|
|
$this->vastDevMod = $vdm;
|
|
}
|
|
else
|
|
{
|
|
// set the vast development method key
|
|
$this->vastDevMod = ComponentbuilderHelper::randomkey(50);
|
|
ComponentbuilderHelper::set($this->vastDevMod, 'fieldtype__'.$id);
|
|
ComponentbuilderHelper::set('fieldtype__'.$id, $this->vastDevMod);
|
|
// set a return value if found
|
|
$jinput = JFactory::getApplication()->input;
|
|
$return = $jinput->get('return', null, 'base64');
|
|
ComponentbuilderHelper::set($this->vastDevMod . '__return', $return);
|
|
// set a GUID value if found
|
|
if (isset($item) && ComponentbuilderHelper::checkObject($item) && isset($item->guid)
|
|
&& method_exists('ComponentbuilderHelper', 'validGUID')
|
|
&& ComponentbuilderHelper::validGUID($item->guid))
|
|
{
|
|
ComponentbuilderHelper::set($this->vastDevMod . '__guid', $item->guid);
|
|
}
|
|
}
|
|
}
|
|
return $this->vastDevMod;
|
|
}
|
|
|
|
|
|
/**
|
|
* 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))
|
|
{
|
|
if (!empty($item->params) && !is_array($item->params))
|
|
{
|
|
// Convert the params field to an array.
|
|
$registry = new Registry;
|
|
$registry->loadString($item->params);
|
|
$item->params = $registry->toArray();
|
|
}
|
|
|
|
if (!empty($item->metadata))
|
|
{
|
|
// Convert the metadata field to an array.
|
|
$registry = new Registry;
|
|
$registry->loadString($item->metadata);
|
|
$item->metadata = $registry->toArray();
|
|
}
|
|
|
|
if (!empty($item->properties))
|
|
{
|
|
// Convert the properties field to an array.
|
|
$properties = new Registry;
|
|
$properties->loadString($item->properties);
|
|
$item->properties = $properties->toArray();
|
|
}
|
|
|
|
|
|
if (empty($item->id))
|
|
{
|
|
$id = 0;
|
|
}
|
|
else
|
|
{
|
|
$id = $item->id;
|
|
}
|
|
// set the id and view name to session
|
|
if ($vdm = ComponentbuilderHelper::get('fieldtype__'.$id))
|
|
{
|
|
$this->vastDevMod = $vdm;
|
|
}
|
|
else
|
|
{
|
|
// set the vast development method key
|
|
$this->vastDevMod = ComponentbuilderHelper::randomkey(50);
|
|
ComponentbuilderHelper::set($this->vastDevMod, 'fieldtype__'.$id);
|
|
ComponentbuilderHelper::set('fieldtype__'.$id, $this->vastDevMod);
|
|
// set a return value if found
|
|
$jinput = JFactory::getApplication()->input;
|
|
$return = $jinput->get('return', null, 'base64');
|
|
ComponentbuilderHelper::set($this->vastDevMod . '__return', $return);
|
|
// set a GUID value if found
|
|
if (isset($item) && ComponentbuilderHelper::checkObject($item) && isset($item->guid)
|
|
&& method_exists('ComponentbuilderHelper', 'validGUID')
|
|
&& ComponentbuilderHelper::validGUID($item->guid))
|
|
{
|
|
ComponentbuilderHelper::set($this->vastDevMod . '__guid', $item->guid);
|
|
}
|
|
}
|
|
// check what type of properties array we have here (should be subform... but just incase)
|
|
// This could happen due to huge data sets
|
|
if (isset($item->properties) && isset($item->properties['name']))
|
|
{
|
|
$bucket = array();
|
|
foreach($item->properties as $option => $values)
|
|
{
|
|
foreach($values as $nr => $value)
|
|
{
|
|
$bucket['addfields'.$nr][$option] = $value;
|
|
}
|
|
}
|
|
$item->properties = $bucket;
|
|
// be sure to update the value in the db
|
|
$objectUpdate = new stdClass();
|
|
$objectUpdate->id = (int) $item->id;
|
|
$objectUpdate->properties = json_encode($bucket);
|
|
$this->db->updateObject('#__componentbuilder_fieldtype', $objectUpdate, 'id');
|
|
}
|
|
}
|
|
$this->fieldtypevvvv = $item->id;
|
|
|
|
return $item;
|
|
}
|
|
|
|
/**
|
|
* Method to get list data.
|
|
*
|
|
* @return mixed An array of data items on success, false on failure.
|
|
*/
|
|
public function getVycfields()
|
|
{
|
|
// Get the user object.
|
|
$user = JFactory::getUser();
|
|
// Create a new query object.
|
|
$db = JFactory::getDBO();
|
|
$query = $db->getQuery(true);
|
|
|
|
// Select some fields
|
|
$query->select('a.*');
|
|
$query->select($db->quoteName('c.title','category_title'));
|
|
|
|
// From the componentbuilder_field table
|
|
$query->from($db->quoteName('#__componentbuilder_field', 'a'));
|
|
$query->join('LEFT', $db->quoteName('#__categories', 'c') . ' ON (' . $db->quoteName('a.catid') . ' = ' . $db->quoteName('c.id') . ')');
|
|
|
|
// do not use these filters in the export method
|
|
if (!isset($_export) || !$_export)
|
|
{
|
|
// Filtering "extension"
|
|
$filter_extension = $this->state->get("filter.extension");
|
|
$field_ids = array();
|
|
$get_ids = true;
|
|
if ($get_ids && $filter_extension !== null && !empty($filter_extension))
|
|
{
|
|
// column name, and id
|
|
$type_extension = explode('__', $filter_extension);
|
|
if (($ids = ComponentbuilderHelper::getAreaLinkedIDs($type_extension[1], $type_extension[0])) !== false)
|
|
{
|
|
$field_ids = $ids;
|
|
}
|
|
else
|
|
{
|
|
// there is none
|
|
$query->where($db->quoteName('a.id') . ' = ' . 0);
|
|
$get_ids = false;
|
|
}
|
|
}
|
|
|
|
// Filtering "admin_view"
|
|
$filter_admin_view = $this->state->get("filter.admin_view");
|
|
if ($get_ids && $filter_admin_view !== null && !empty($filter_admin_view))
|
|
{
|
|
if (($ids = ComponentbuilderHelper::getAreaLinkedIDs($filter_admin_view, 'admin_view')) !== false)
|
|
{
|
|
// view will return less fields, so we ignore the component
|
|
$field_ids = $ids;
|
|
}
|
|
else
|
|
{
|
|
// there is none
|
|
$query->where($db->quoteName('a.id') . ' = ' . 0);
|
|
$get_ids = false;
|
|
}
|
|
}
|
|
// now check if we have IDs
|
|
if ($get_ids && ComponentbuilderHelper::checkArray($field_ids))
|
|
{
|
|
$query->where($db->quoteName('a.id') . ' IN (' . implode(',', $field_ids) . ')');
|
|
}
|
|
}
|
|
|
|
// From the componentbuilder_fieldtype table.
|
|
$query->select($db->quoteName('g.name','fieldtype_name'));
|
|
$query->join('LEFT', $db->quoteName('#__componentbuilder_fieldtype', 'g') . ' ON (' . $db->quoteName('a.fieldtype') . ' = ' . $db->quoteName('g.id') . ')');
|
|
|
|
// Filter by fieldtypevvvv global.
|
|
$fieldtypevvvv = $this->fieldtypevvvv;
|
|
if (is_numeric($fieldtypevvvv ))
|
|
{
|
|
$query->where('a.fieldtype = ' . (int) $fieldtypevvvv );
|
|
}
|
|
elseif (is_string($fieldtypevvvv))
|
|
{
|
|
$query->where('a.fieldtype = ' . $db->quote($fieldtypevvvv));
|
|
}
|
|
else
|
|
{
|
|
$query->where('a.fieldtype = -5');
|
|
}
|
|
|
|
// Join over the asset groups.
|
|
$query->select('ag.title AS access_level');
|
|
$query->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
|
|
// Filter by access level.
|
|
$_access = $this->getState('filter.access');
|
|
if ($_access && is_numeric($_access))
|
|
{
|
|
$query->where('a.access = ' . (int) $_access);
|
|
}
|
|
elseif (ComponentbuilderHelper::checkArray($_access))
|
|
{
|
|
// Secure the array for the query
|
|
$_access = ArrayHelper::toInteger($_access);
|
|
// Filter by the Access Array.
|
|
$query->where('a.access IN (' . implode(',', $_access) . ')');
|
|
}
|
|
// Implement View Level Access
|
|
if (!$user->authorise('core.options', 'com_componentbuilder'))
|
|
{
|
|
$groups = implode(',', $user->getAuthorisedViewLevels());
|
|
$query->where('a.access IN (' . $groups . ')');
|
|
}
|
|
|
|
// Order the results by ordering
|
|
$query->order('a.published ASC');
|
|
$query->order('a.ordering ASC');
|
|
|
|
// Load the items
|
|
$db->setQuery($query);
|
|
$db->execute();
|
|
if ($db->getNumRows())
|
|
{
|
|
$items = $db->loadObjectList();
|
|
|
|
// Set values to display correctly.
|
|
if (ComponentbuilderHelper::checkArray($items))
|
|
{
|
|
// Get the user object if not set.
|
|
if (!isset($user) || !ComponentbuilderHelper::checkObject($user))
|
|
{
|
|
$user = JFactory::getUser();
|
|
}
|
|
foreach ($items as $nr => &$item)
|
|
{
|
|
// Remove items the user can't access.
|
|
$access = ($user->authorise('field.access', 'com_componentbuilder.field.' . (int) $item->id) && $user->authorise('field.access', 'com_componentbuilder'));
|
|
if (!$access)
|
|
{
|
|
unset($items[$nr]);
|
|
continue;
|
|
}
|
|
|
|
}
|
|
}
|
|
|
|
// set selection value to a translatable value
|
|
if (ComponentbuilderHelper::checkArray($items))
|
|
{
|
|
foreach ($items as $nr => &$item)
|
|
{
|
|
// convert datatype
|
|
$item->datatype = $this->selectionTranslationVycfields($item->datatype, 'datatype');
|
|
// convert indexes
|
|
$item->indexes = $this->selectionTranslationVycfields($item->indexes, 'indexes');
|
|
// convert null_switch
|
|
$item->null_switch = $this->selectionTranslationVycfields($item->null_switch, 'null_switch');
|
|
// convert store
|
|
$item->store = $this->selectionTranslationVycfields($item->store, 'store');
|
|
}
|
|
}
|
|
|
|
return $items;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to convert selection values to translatable string.
|
|
*
|
|
* @return translatable string
|
|
*/
|
|
public function selectionTranslationVycfields($value,$name)
|
|
{
|
|
// Array of datatype language strings
|
|
if ($name === 'datatype')
|
|
{
|
|
$datatypeArray = array(
|
|
0 => 'COM_COMPONENTBUILDER_FIELD_SELECT_AN_OPTION',
|
|
'CHAR' => 'COM_COMPONENTBUILDER_FIELD_CHAR',
|
|
'VARCHAR' => 'COM_COMPONENTBUILDER_FIELD_VARCHAR',
|
|
'TEXT' => 'COM_COMPONENTBUILDER_FIELD_TEXT',
|
|
'MEDIUMTEXT' => 'COM_COMPONENTBUILDER_FIELD_MEDIUMTEXT',
|
|
'LONGTEXT' => 'COM_COMPONENTBUILDER_FIELD_LONGTEXT',
|
|
'BLOB' => 'COM_COMPONENTBUILDER_FIELD_BLOB',
|
|
'TINYBLOB' => 'COM_COMPONENTBUILDER_FIELD_TINYBLOB',
|
|
'MEDIUMBLOB' => 'COM_COMPONENTBUILDER_FIELD_MEDIUMBLOB',
|
|
'LONGBLOB' => 'COM_COMPONENTBUILDER_FIELD_LONGBLOB',
|
|
'DATETIME' => 'COM_COMPONENTBUILDER_FIELD_DATETIME',
|
|
'DATE' => 'COM_COMPONENTBUILDER_FIELD_DATE',
|
|
'TIME' => 'COM_COMPONENTBUILDER_FIELD_TIME',
|
|
'INT' => 'COM_COMPONENTBUILDER_FIELD_INT',
|
|
'TINYINT' => 'COM_COMPONENTBUILDER_FIELD_TINYINT',
|
|
'BIGINT' => 'COM_COMPONENTBUILDER_FIELD_BIGINT',
|
|
'FLOAT' => 'COM_COMPONENTBUILDER_FIELD_FLOAT',
|
|
'DECIMAL' => 'COM_COMPONENTBUILDER_FIELD_DECIMAL',
|
|
'DOUBLE' => 'COM_COMPONENTBUILDER_FIELD_DOUBLE'
|
|
);
|
|
// Now check if value is found in this array
|
|
if (isset($datatypeArray[$value]) && ComponentbuilderHelper::checkString($datatypeArray[$value]))
|
|
{
|
|
return $datatypeArray[$value];
|
|
}
|
|
}
|
|
// Array of indexes language strings
|
|
if ($name === 'indexes')
|
|
{
|
|
$indexesArray = array(
|
|
1 => 'COM_COMPONENTBUILDER_FIELD_UNIQUE_KEY',
|
|
2 => 'COM_COMPONENTBUILDER_FIELD_KEY',
|
|
0 => 'COM_COMPONENTBUILDER_FIELD_NONE'
|
|
);
|
|
// Now check if value is found in this array
|
|
if (isset($indexesArray[$value]) && ComponentbuilderHelper::checkString($indexesArray[$value]))
|
|
{
|
|
return $indexesArray[$value];
|
|
}
|
|
}
|
|
// Array of null_switch language strings
|
|
if ($name === 'null_switch')
|
|
{
|
|
$null_switchArray = array(
|
|
'NULL' => 'COM_COMPONENTBUILDER_FIELD_NULL',
|
|
'NOT NULL' => 'COM_COMPONENTBUILDER_FIELD_NOT_NULL'
|
|
);
|
|
// Now check if value is found in this array
|
|
if (isset($null_switchArray[$value]) && ComponentbuilderHelper::checkString($null_switchArray[$value]))
|
|
{
|
|
return $null_switchArray[$value];
|
|
}
|
|
}
|
|
// Array of store language strings
|
|
if ($name === 'store')
|
|
{
|
|
$storeArray = array(
|
|
0 => 'COM_COMPONENTBUILDER_FIELD_DEFAULT',
|
|
1 => 'COM_COMPONENTBUILDER_FIELD_JSON',
|
|
2 => 'COM_COMPONENTBUILDER_FIELD_BASE64',
|
|
3 => 'COM_COMPONENTBUILDER_FIELD_BASIC_ENCRYPTION_LOCALDBKEY',
|
|
5 => 'COM_COMPONENTBUILDER_FIELD_MEDIUM_ENCRYPTION_LOCALFILEKEY',
|
|
4 => 'COM_COMPONENTBUILDER_FIELD_WHMCSKEY_ENCRYPTION',
|
|
6 => 'COM_COMPONENTBUILDER_FIELD_EXPERT_MODE_CUSTOM'
|
|
);
|
|
// Now check if value is found in this array
|
|
if (isset($storeArray[$value]) && ComponentbuilderHelper::checkString($storeArray[$value]))
|
|
{
|
|
return $storeArray[$value];
|
|
}
|
|
}
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Method to get the record 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.
|
|
* @param array $options Optional array of options for the form creation.
|
|
*
|
|
* @return mixed A JForm object on success, false on failure
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function getForm($data = array(), $loadData = true, $options = array('control' => 'jform'))
|
|
{
|
|
// set load data option
|
|
$options['load_data'] = $loadData;
|
|
// check if xpath was set in options
|
|
$xpath = false;
|
|
if (isset($options['xpath']))
|
|
{
|
|
$xpath = $options['xpath'];
|
|
unset($options['xpath']);
|
|
}
|
|
// check if clear form was set in options
|
|
$clear = false;
|
|
if (isset($options['clear']))
|
|
{
|
|
$clear = $options['clear'];
|
|
unset($options['clear']);
|
|
}
|
|
|
|
// Get the form.
|
|
$form = $this->loadForm('com_componentbuilder.fieldtype', 'fieldtype', $options, $clear, $xpath);
|
|
|
|
if (empty($form))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
$jinput = JFactory::getApplication()->input;
|
|
|
|
// The front end calls this model and uses a_id to avoid id clashes so we need to check for that first.
|
|
if ($jinput->get('a_id'))
|
|
{
|
|
$id = $jinput->get('a_id', 0, 'INT');
|
|
}
|
|
// The back end uses id so we use that the rest of the time and set it to 0 by default.
|
|
else
|
|
{
|
|
$id = $jinput->get('id', 0, 'INT');
|
|
}
|
|
|
|
$user = JFactory::getUser();
|
|
|
|
// Check for existing item.
|
|
// Modify the form based on Edit State access controls.
|
|
if ($id != 0 && (!$user->authorise('fieldtype.edit.state', 'com_componentbuilder.fieldtype.' . (int) $id))
|
|
|| ($id == 0 && !$user->authorise('fieldtype.edit.state', 'com_componentbuilder')))
|
|
{
|
|
// Disable fields for display.
|
|
$form->setFieldAttribute('ordering', 'disabled', 'true');
|
|
$form->setFieldAttribute('published', 'disabled', 'true');
|
|
// Disable fields while saving.
|
|
$form->setFieldAttribute('ordering', 'filter', 'unset');
|
|
$form->setFieldAttribute('published', 'filter', 'unset');
|
|
}
|
|
// If this is a new item insure the greated by is set.
|
|
if (0 == $id)
|
|
{
|
|
// Set the created_by to this user
|
|
$form->setValue('created_by', null, $user->id);
|
|
}
|
|
// Modify the form based on Edit Creaded By access controls.
|
|
if (!$user->authorise('core.edit.created_by', 'com_componentbuilder'))
|
|
{
|
|
// Disable fields for display.
|
|
$form->setFieldAttribute('created_by', 'disabled', 'true');
|
|
// Disable fields for display.
|
|
$form->setFieldAttribute('created_by', 'readonly', 'true');
|
|
// Disable fields while saving.
|
|
$form->setFieldAttribute('created_by', 'filter', 'unset');
|
|
}
|
|
// Modify the form based on Edit Creaded Date access controls.
|
|
if (!$user->authorise('core.edit.created', 'com_componentbuilder'))
|
|
{
|
|
// Disable fields for display.
|
|
$form->setFieldAttribute('created', 'disabled', 'true');
|
|
// Disable fields while saving.
|
|
$form->setFieldAttribute('created', 'filter', 'unset');
|
|
}
|
|
// Only load these values if no id is found
|
|
if (0 == $id)
|
|
{
|
|
// Set redirected view name
|
|
$redirectedView = $jinput->get('ref', null, 'STRING');
|
|
// Set field name (or fall back to view name)
|
|
$redirectedField = $jinput->get('field', $redirectedView, 'STRING');
|
|
// Set redirected view id
|
|
$redirectedId = $jinput->get('refid', 0, 'INT');
|
|
// Set field id (or fall back to redirected view id)
|
|
$redirectedValue = $jinput->get('field_id', $redirectedId, 'INT');
|
|
if (0 != $redirectedValue && $redirectedField)
|
|
{
|
|
// Now set the local-redirected field default value
|
|
$form->setValue($redirectedField, null, $redirectedValue);
|
|
}
|
|
}
|
|
|
|
// update the properties (sub form) layout
|
|
$form->setFieldAttribute('properties', 'layout', ComponentbuilderHelper::getSubformLayout('fieldtype', 'properties'));
|
|
|
|
// Only load the GUID if new item (or empty)
|
|
if (0 == $id || !($val = $form->getValue('guid')))
|
|
{
|
|
$form->setValue('guid', null, ComponentbuilderHelper::GUID());
|
|
}
|
|
|
|
return $form;
|
|
}
|
|
|
|
/**
|
|
* Method to get the script that have to be included on the form
|
|
*
|
|
* @return string script files
|
|
*/
|
|
public function getScript()
|
|
{
|
|
return 'media/com_componentbuilder/js/fieldtype.js';
|
|
}
|
|
|
|
/**
|
|
* 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();
|
|
// The record has been set. Check the record permissions.
|
|
return $user->authorise('fieldtype.delete', 'com_componentbuilder.fieldtype.' . (int) $record->id);
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* 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();
|
|
$recordId = (!empty($record->id)) ? $record->id : 0;
|
|
|
|
if ($recordId)
|
|
{
|
|
// The record has been set. Check the record permissions.
|
|
$permission = $user->authorise('fieldtype.edit.state', 'com_componentbuilder.fieldtype.' . (int) $recordId);
|
|
if (!$permission && !is_null($permission))
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
// In the absense of better information, revert to the component permissions.
|
|
return $user->authorise('fieldtype.edit.state', 'com_componentbuilder');
|
|
}
|
|
|
|
/**
|
|
* Method override to check if you can edit an existing record.
|
|
*
|
|
* @param array $data An array of input data.
|
|
* @param string $key The name of the key for the primary key.
|
|
*
|
|
* @return boolean
|
|
* @since 2.5
|
|
*/
|
|
protected function allowEdit($data = array(), $key = 'id')
|
|
{
|
|
// Check specific edit permission then general edit permission.
|
|
$user = JFactory::getUser();
|
|
|
|
return $user->authorise('fieldtype.edit', 'com_componentbuilder.fieldtype.'. ((int) isset($data[$key]) ? $data[$key] : 0)) or $user->authorise('fieldtype.edit', 'com_componentbuilder');
|
|
}
|
|
|
|
/**
|
|
* Prepare and sanitise the table data prior to saving.
|
|
*
|
|
* @param JTable $table A JTable object.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function prepareTable($table)
|
|
{
|
|
$date = JFactory::getDate();
|
|
$user = JFactory::getUser();
|
|
|
|
if (isset($table->name))
|
|
{
|
|
$table->name = htmlspecialchars_decode($table->name, ENT_QUOTES);
|
|
}
|
|
|
|
if (isset($table->alias) && empty($table->alias))
|
|
{
|
|
$table->generateAlias();
|
|
}
|
|
|
|
if (empty($table->id))
|
|
{
|
|
$table->created = $date->toSql();
|
|
// set the user
|
|
if ($table->created_by == 0 || empty($table->created_by))
|
|
{
|
|
$table->created_by = $user->id;
|
|
}
|
|
// Set ordering to the last item if not set
|
|
if (empty($table->ordering))
|
|
{
|
|
$db = JFactory::getDbo();
|
|
$query = $db->getQuery(true)
|
|
->select('MAX(ordering)')
|
|
->from($db->quoteName('#__componentbuilder_fieldtype'));
|
|
$db->setQuery($query);
|
|
$max = $db->loadResult();
|
|
|
|
$table->ordering = $max + 1;
|
|
}
|
|
}
|
|
else
|
|
{
|
|
$table->modified = $date->toSql();
|
|
$table->modified_by = $user->id;
|
|
}
|
|
|
|
if (!empty($table->id))
|
|
{
|
|
// Increment the items version number.
|
|
$table->version++;
|
|
}
|
|
}
|
|
|
|
/**
|
|
* 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_componentbuilder.edit.fieldtype.data', array());
|
|
|
|
if (empty($data))
|
|
{
|
|
$data = $this->getItem();
|
|
// run the perprocess of the data
|
|
$this->preprocessData('com_componentbuilder.fieldtype', $data);
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Method to validate the form data.
|
|
*
|
|
* @param JForm $form The form to validate against.
|
|
* @param array $data The data to validate.
|
|
* @param string $group The name of the field group to validate.
|
|
*
|
|
* @return mixed Array of filtered data if valid, false otherwise.
|
|
*
|
|
* @see JFormRule
|
|
* @see JFilterInput
|
|
* @since 12.2
|
|
*/
|
|
public function validate($form, $data, $group = null)
|
|
{
|
|
// check if the not_required field is set
|
|
if (isset($data['not_required']) && ComponentbuilderHelper::checkString($data['not_required']))
|
|
{
|
|
$requiredFields = (array) explode(',',(string) $data['not_required']);
|
|
$requiredFields = array_unique($requiredFields);
|
|
// now change the required field attributes value
|
|
foreach ($requiredFields as $requiredField)
|
|
{
|
|
// make sure there is a string value
|
|
if (ComponentbuilderHelper::checkString($requiredField))
|
|
{
|
|
// change to false
|
|
$form->setFieldAttribute($requiredField, 'required', 'false');
|
|
// also clear the data set
|
|
$data[$requiredField] = '';
|
|
}
|
|
}
|
|
}
|
|
return parent::validate($form, $data, $group);
|
|
}
|
|
|
|
/**
|
|
* Method to get the unique fields of this table.
|
|
*
|
|
* @return mixed An array of field names, boolean false if none is set.
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
protected function getUniqueFields()
|
|
{
|
|
return array('guid');
|
|
}
|
|
|
|
/**
|
|
* Method to delete one or more records.
|
|
*
|
|
* @param array &$pks An array of record primary keys.
|
|
*
|
|
* @return boolean True if successful, false if an error occurs.
|
|
*
|
|
* @since 12.2
|
|
*/
|
|
public function delete(&$pks)
|
|
{
|
|
if (!parent::delete($pks))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to change the published state of one or more records.
|
|
*
|
|
* @param array &$pks A list of the primary keys to change.
|
|
* @param integer $value The value of the published state.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 12.2
|
|
*/
|
|
public function publish(&$pks, $value = 1)
|
|
{
|
|
if (!parent::publish($pks, $value))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* 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 12.2
|
|
*/
|
|
public function batch($commands, $pks, $contexts)
|
|
{
|
|
// Sanitize ids.
|
|
$pks = array_unique($pks);
|
|
ArrayHelper::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;
|
|
|
|
// Set some needed variables.
|
|
$this->user = JFactory::getUser();
|
|
$this->table = $this->getTable();
|
|
$this->tableClassName = get_class($this->table);
|
|
$this->contentType = new JUcmType;
|
|
$this->type = $this->contentType->getTypeByTable($this->tableClassName);
|
|
$this->canDo = ComponentbuilderHelper::getActions('fieldtype');
|
|
$this->batchSet = true;
|
|
|
|
if (!$this->canDo->get('core.batch'))
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_INSUFFICIENT_BATCH_INFORMATION'));
|
|
return false;
|
|
}
|
|
|
|
if ($this->type == false)
|
|
{
|
|
$type = new JUcmType;
|
|
$this->type = $type->getTypeByAlias($this->typeAlias);
|
|
}
|
|
|
|
$this->tagsObserver = $this->table->getObserverOfClass('JTableObserverTags');
|
|
|
|
if (!empty($commands['move_copy']))
|
|
{
|
|
$cmd = ArrayHelper::getValue($commands, 'move_copy', 'c');
|
|
|
|
if ($cmd == 'c')
|
|
{
|
|
$result = $this->batchCopy($commands, $pks, $contexts);
|
|
|
|
if (is_array($result))
|
|
{
|
|
foreach ($result as $old => $new)
|
|
{
|
|
$contexts[$new] = $contexts[$old];
|
|
}
|
|
$pks = array_values($result);
|
|
}
|
|
else
|
|
{
|
|
return false;
|
|
}
|
|
}
|
|
elseif ($cmd == 'm' && !$this->batchMove($commands, $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 $values The new values.
|
|
* @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 12.2
|
|
*/
|
|
protected function batchCopy($values, $pks, $contexts)
|
|
{
|
|
if (empty($this->batchSet))
|
|
{
|
|
// Set some needed variables.
|
|
$this->user = JFactory::getUser();
|
|
$this->table = $this->getTable();
|
|
$this->tableClassName = get_class($this->table);
|
|
$this->canDo = ComponentbuilderHelper::getActions('fieldtype');
|
|
}
|
|
|
|
if (!$this->canDo->get('fieldtype.create') && !$this->canDo->get('fieldtype.batch'))
|
|
{
|
|
return false;
|
|
}
|
|
|
|
// get list of unique fields
|
|
$uniqueFields = $this->getUniqueFields();
|
|
// remove move_copy from array
|
|
unset($values['move_copy']);
|
|
|
|
// make sure published is set
|
|
if (!isset($values['published']))
|
|
{
|
|
$values['published'] = 0;
|
|
}
|
|
elseif (isset($values['published']) && !$this->canDo->get('fieldtype.edit.state'))
|
|
{
|
|
$values['published'] = 0;
|
|
}
|
|
|
|
if (isset($values['category']) && (int) $values['category'] > 0 && !static::checkCategoryId($values['category']))
|
|
{
|
|
return false;
|
|
}
|
|
elseif (isset($values['category']) && (int) $values['category'] > 0)
|
|
{
|
|
// move the category value to correct field name
|
|
$values['catid'] = $values['category'];
|
|
unset($values['category']);
|
|
}
|
|
elseif (isset($values['category']))
|
|
{
|
|
unset($values['category']);
|
|
}
|
|
|
|
$newIds = array();
|
|
// Parent exists so let's proceed
|
|
while (!empty($pks))
|
|
{
|
|
// Pop the first ID off the stack
|
|
$pk = array_shift($pks);
|
|
|
|
$this->table->reset();
|
|
|
|
// only allow copy if user may edit this item.
|
|
if (!$this->user->authorise('fieldtype.edit', $contexts[$pk]))
|
|
{
|
|
// Not fatal error
|
|
$this->setError(JText::sprintf('JLIB_APPLICATION_ERROR_BATCH_MOVE_ROW_NOT_FOUND', $pk));
|
|
continue;
|
|
}
|
|
|
|
// Check that the row actually exists
|
|
if (!$this->table->load($pk))
|
|
{
|
|
if ($error = $this->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;
|
|
}
|
|
}
|
|
|
|
// insert all set values
|
|
if (ComponentbuilderHelper::checkArray($values))
|
|
{
|
|
foreach ($values as $key => $value)
|
|
{
|
|
if (strlen($value) > 0 && isset($this->table->$key))
|
|
{
|
|
$this->table->$key = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
// update all unique fields
|
|
if (ComponentbuilderHelper::checkArray($uniqueFields))
|
|
{
|
|
foreach ($uniqueFields as $uniqueField)
|
|
{
|
|
$this->table->$uniqueField = $this->generateUnique($uniqueField,$this->table->$uniqueField);
|
|
}
|
|
}
|
|
|
|
// Reset the ID because we are making a copy
|
|
$this->table->id = 0;
|
|
|
|
// TODO: Deal with ordering?
|
|
// $this->table->ordering = 1;
|
|
|
|
// Check the row.
|
|
if (!$this->table->check())
|
|
{
|
|
$this->setError($this->table->getError());
|
|
|
|
return false;
|
|
}
|
|
|
|
if (!empty($this->type))
|
|
{
|
|
$this->createTagsHelper($this->tagsObserver, $this->type, $pk, $this->typeAlias, $this->table);
|
|
}
|
|
|
|
// Store the row.
|
|
if (!$this->table->store())
|
|
{
|
|
$this->setError($this->table->getError());
|
|
|
|
return false;
|
|
}
|
|
|
|
// Get the new item ID
|
|
$newId = $this->table->get('id');
|
|
|
|
// Add the new ID to the array
|
|
$newIds[$pk] = $newId;
|
|
}
|
|
|
|
// Clean the cache
|
|
$this->cleanCache();
|
|
|
|
return $newIds;
|
|
}
|
|
|
|
/**
|
|
* Batch move items to a new category
|
|
*
|
|
* @param integer $value The new category 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 12.2
|
|
*/
|
|
protected function batchMove($values, $pks, $contexts)
|
|
{
|
|
if (empty($this->batchSet))
|
|
{
|
|
// Set some needed variables.
|
|
$this->user = JFactory::getUser();
|
|
$this->table = $this->getTable();
|
|
$this->tableClassName = get_class($this->table);
|
|
$this->canDo = ComponentbuilderHelper::getActions('fieldtype');
|
|
}
|
|
|
|
if (!$this->canDo->get('fieldtype.edit') && !$this->canDo->get('fieldtype.batch'))
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT'));
|
|
return false;
|
|
}
|
|
|
|
// make sure published only updates if user has the permission.
|
|
if (isset($values['published']) && !$this->canDo->get('fieldtype.edit.state'))
|
|
{
|
|
unset($values['published']);
|
|
}
|
|
// remove move_copy from array
|
|
unset($values['move_copy']);
|
|
|
|
if (isset($values['category']) && (int) $values['category'] > 0 && !static::checkCategoryId($values['category']))
|
|
{
|
|
return false;
|
|
}
|
|
elseif (isset($values['category']) && (int) $values['category'] > 0)
|
|
{
|
|
// move the category value to correct field name
|
|
$values['catid'] = $values['category'];
|
|
unset($values['category']);
|
|
}
|
|
elseif (isset($values['category']))
|
|
{
|
|
unset($values['category']);
|
|
}
|
|
|
|
|
|
// Parent exists so we proceed
|
|
foreach ($pks as $pk)
|
|
{
|
|
if (!$this->user->authorise('fieldtype.edit', $contexts[$pk]))
|
|
{
|
|
$this->setError(JText::_('JLIB_APPLICATION_ERROR_BATCH_CANNOT_EDIT'));
|
|
return false;
|
|
}
|
|
|
|
// Check that the row actually exists
|
|
if (!$this->table->load($pk))
|
|
{
|
|
if ($error = $this->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;
|
|
}
|
|
}
|
|
|
|
// insert all set values.
|
|
if (ComponentbuilderHelper::checkArray($values))
|
|
{
|
|
foreach ($values as $key => $value)
|
|
{
|
|
// Do special action for access.
|
|
if ('access' === $key && strlen($value) > 0)
|
|
{
|
|
$this->table->$key = $value;
|
|
}
|
|
elseif (strlen($value) > 0 && isset($this->table->$key))
|
|
{
|
|
$this->table->$key = $value;
|
|
}
|
|
}
|
|
}
|
|
|
|
|
|
// Check the row.
|
|
if (!$this->table->check())
|
|
{
|
|
$this->setError($this->table->getError());
|
|
|
|
return false;
|
|
}
|
|
|
|
if (!empty($this->type))
|
|
{
|
|
$this->createTagsHelper($this->tagsObserver, $this->type, $pk, $this->typeAlias, $this->table);
|
|
}
|
|
|
|
// Store the row.
|
|
if (!$this->table->store())
|
|
{
|
|
$this->setError($this->table->getError());
|
|
|
|
return false;
|
|
}
|
|
}
|
|
|
|
// Clean the cache
|
|
$this->cleanCache();
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Method to save the form data.
|
|
*
|
|
* @param array $data The form data.
|
|
*
|
|
* @return boolean True on success.
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function save($data)
|
|
{
|
|
$input = JFactory::getApplication()->input;
|
|
$filter = JFilterInput::getInstance();
|
|
|
|
// set the metadata to the Item Data
|
|
if (isset($data['metadata']) && isset($data['metadata']['author']))
|
|
{
|
|
$data['metadata']['author'] = $filter->clean($data['metadata']['author'], 'TRIM');
|
|
|
|
$metadata = new JRegistry;
|
|
$metadata->loadArray($data['metadata']);
|
|
$data['metadata'] = (string) $metadata;
|
|
}
|
|
|
|
|
|
// Set the GUID if empty or not valid
|
|
if (empty($data['guid']) && $data['id'] > 0)
|
|
{
|
|
// get the existing one
|
|
$data['guid'] = (string) ComponentbuilderHelper::getVar('fieldtype', $data['id'], 'id', 'guid');
|
|
}
|
|
// Set the GUID if empty or not valid
|
|
while (!ComponentbuilderHelper::validGUID($data['guid'], "fieldtype", $data['id']))
|
|
{
|
|
// must always be set
|
|
$data['guid'] = (string) ComponentbuilderHelper::GUID();
|
|
}
|
|
|
|
|
|
// Set the properties items to data.
|
|
if (isset($data['properties']) && is_array($data['properties']))
|
|
{
|
|
$properties = new JRegistry;
|
|
$properties->loadArray($data['properties']);
|
|
$data['properties'] = (string) $properties;
|
|
}
|
|
elseif (!isset($data['properties']))
|
|
{
|
|
// Set the empty properties to data
|
|
$data['properties'] = '';
|
|
}
|
|
|
|
// Set the Params Items to data
|
|
if (isset($data['params']) && is_array($data['params']))
|
|
{
|
|
$params = new JRegistry;
|
|
$params->loadArray($data['params']);
|
|
$data['params'] = (string) $params;
|
|
}
|
|
|
|
// Alter the unique field for save as copy
|
|
if ($input->get('task') === 'save2copy')
|
|
{
|
|
// Automatic handling of other unique fields
|
|
$uniqueFields = $this->getUniqueFields();
|
|
if (ComponentbuilderHelper::checkArray($uniqueFields))
|
|
{
|
|
foreach ($uniqueFields as $uniqueField)
|
|
{
|
|
$data[$uniqueField] = $this->generateUnique($uniqueField,$data[$uniqueField]);
|
|
}
|
|
}
|
|
}
|
|
|
|
if (parent::save($data))
|
|
{
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to generate a unique value.
|
|
*
|
|
* @param string $field name.
|
|
* @param string $value data.
|
|
*
|
|
* @return string New value.
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
protected function generateUnique($field,$value)
|
|
{
|
|
|
|
// set field value unique
|
|
$table = $this->getTable();
|
|
|
|
while ($table->load(array($field => $value)))
|
|
{
|
|
$value = StringHelper::increment($value);
|
|
}
|
|
|
|
return $value;
|
|
}
|
|
|
|
/**
|
|
* Method to change the title
|
|
*
|
|
* @param string $title The title.
|
|
*
|
|
* @return array Contains the modified title and alias.
|
|
*
|
|
*/
|
|
protected function _generateNewTitle($title)
|
|
{
|
|
|
|
// Alter the title
|
|
$table = $this->getTable();
|
|
|
|
while ($table->load(array('title' => $title)))
|
|
{
|
|
$title = StringHelper::increment($title);
|
|
}
|
|
|
|
return $title;
|
|
}
|
|
}
|