forked from joomla/Component-Builder
450 lines
12 KiB
PHP
450 lines
12 KiB
PHP
<?php
|
|
/*--------------------------------------------------------------------------------------------------------| www.vdm.io |------/
|
|
__ __ _ _____ _ _ __ __ _ _ _
|
|
\ \ / / | | | __ \ | | | | | \/ | | | | | | |
|
|
\ \ / /_ _ ___| |_ | | | | _____ _____| | ___ _ __ _ __ ___ ___ _ __ | |_ | \ / | ___| |_| |__ ___ __| |
|
|
\ \/ / _` / __| __| | | | |/ _ \ \ / / _ \ |/ _ \| '_ \| '_ ` _ \ / _ \ '_ \| __| | |\/| |/ _ \ __| '_ \ / _ \ / _` |
|
|
\ / (_| \__ \ |_ | |__| | __/\ V / __/ | (_) | |_) | | | | | | __/ | | | |_ | | | | __/ |_| | | | (_) | (_| |
|
|
\/ \__,_|___/\__| |_____/ \___| \_/ \___|_|\___/| .__/|_| |_| |_|\___|_| |_|\__| |_| |_|\___|\__|_| |_|\___/ \__,_|
|
|
| |
|
|
|_|
|
|
/-------------------------------------------------------------------------------------------------------------------------------/
|
|
|
|
@package Component Builder
|
|
@subpackage componentbuilder.php
|
|
@author Llewellyn van der Merwe <https://www.vdm.io/joomla-component-builder>
|
|
@my wife Roline van der Merwe <http://www.vdm.io/>
|
|
@copyright Copyright (C) 2015. All Rights Reserved
|
|
@license GNU/GPL Version 2 or later - http://www.gnu.org/licenses/gpl-2.0.html
|
|
|
|
Builds Complex Joomla Components
|
|
|
|
/-----------------------------------------------------------------------------------------------------------------------------*/
|
|
|
|
// No direct access to this file
|
|
defined('_JEXEC') or die('Restricted access');
|
|
?>
|
|
###BOM###
|
|
|
|
// No direct access to this file
|
|
defined('_JEXEC') or die('Restricted access');
|
|
|
|
use Joomla\Registry\Registry;
|
|
|
|
/**
|
|
* ###Component### ###View### Model
|
|
*/
|
|
class ###Component###Model###View### extends JModelAdmin
|
|
{
|
|
/**
|
|
* @var string The prefix to use with controller messages.
|
|
* @since 1.6
|
|
*/
|
|
protected $text_prefix = 'COM_###COMPONENT###';
|
|
|
|
/**
|
|
* The type alias for this content type.
|
|
*
|
|
* @var string
|
|
* @since 3.2
|
|
*/
|
|
public $typeAlias = 'com_###component###.###view###';
|
|
|
|
/**
|
|
* 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 = '###view###', $prefix = '###Component###Table', $config = array())
|
|
{
|
|
// add table path for when model gets used from other component
|
|
$this->addTablePath(JPATH_ADMINISTRATOR . '/components/com_###component###/tables');
|
|
// get instance of the table
|
|
return JTable::getInstance($type, $prefix, $config);
|
|
}###ADMIN_CUSTOM_BUTTONS_METHOD###
|
|
|
|
/**
|
|
* 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)
|
|
{###LICENSE_LOCKED_CHECK###
|
|
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();
|
|
}###METHOD_GET_ITEM###
|
|
|
|
if (!empty($item->id))
|
|
{
|
|
$item->tags = new JHelperTags;
|
|
$item->tags->getTagIds($item->id, 'com_###component###.###view###');
|
|
}
|
|
}###LINKEDVIEWGLOBAL###
|
|
|
|
return $item;
|
|
}###LINKEDVIEWMETHODS### ###LICENSE_LOCKED_SET_BOOL###
|
|
|
|
/**
|
|
* 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.
|
|
*
|
|
* @return mixed A JForm object on success, false on failure
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
public function getForm($data = array(), $loadData = true)
|
|
{###JMODELADMIN_GETFORM###
|
|
}
|
|
|
|
/**
|
|
* Method to get the script that have to be included on the form
|
|
*
|
|
* @return string script files
|
|
*/
|
|
public function getScript()
|
|
{
|
|
return 'administrator/components/com_###component###/models/forms/###view###.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)
|
|
{###JMODELADMIN_CANDELETE###
|
|
}
|
|
|
|
/**
|
|
* 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)
|
|
{###JMODELADMIN_CANEDITSTATE###
|
|
}
|
|
|
|
/**
|
|
* 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')
|
|
{###JMODELADMIN_ALLOWEDIT###
|
|
}
|
|
|
|
/**
|
|
* Prepare and sanitise the table data prior to saving.
|
|
*
|
|
* @param JTable $table A JTable object.
|
|
*
|
|
* @return void
|
|
*
|
|
* @since 1.6
|
|
*/
|
|
protected function prepareTable($table)
|
|
{###LICENSE_TABLE_LOCKED_CHECK###
|
|
$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('#__###component###_###view###'));
|
|
$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_###component###.edit.###view###.data', array());
|
|
|
|
if (empty($data))
|
|
{
|
|
$data = $this->getItem();
|
|
}
|
|
|
|
return $data;
|
|
}###VALIDATIONFIX### ###UNIQUEFIELDS###
|
|
|
|
/**
|
|
* 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)
|
|
{###JMODELADMIN_BEFORE_DELETE###
|
|
if (!parent::delete($pks))
|
|
{
|
|
return false;
|
|
}###JMODELADMIN_AFTER_DELETE###
|
|
|
|
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)
|
|
{###JMODELADMIN_BEFORE_PUBLISH###
|
|
if (!parent::publish($pks, $value))
|
|
{
|
|
return false;
|
|
}###JMODELADMIN_AFTER_PUBLISH###
|
|
|
|
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);
|
|
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;
|
|
|
|
// 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 = ###Component###Helper::getActions('###view###');
|
|
$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 = JArrayHelper::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;
|
|
}###MODEL_BATCH_COPY### ###MODEL_BATCH_MOVE###
|
|
|
|
/**
|
|
* 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;
|
|
}###CHECKBOX_SAVE### ###METHOD_ITEM_SAVE###
|
|
|
|
// 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;
|
|
}###TITLEALIASFIX###
|
|
|
|
if (parent::save($data))
|
|
{
|
|
return true;
|
|
}
|
|
return false;
|
|
}
|
|
|
|
/**
|
|
* Method to generate a uniqe value.
|
|
*
|
|
* @param string $field name.
|
|
* @param string $value data.
|
|
*
|
|
* @return string New value.
|
|
*
|
|
* @since 3.0
|
|
*/
|
|
protected function generateUniqe($field,$value)
|
|
{
|
|
|
|
// set field value uniqe
|
|
$table = $this->getTable();
|
|
|
|
while ($table->load(array($field => $value)))
|
|
{
|
|
$value = JString::increment($value);
|
|
}
|
|
|
|
return $value;
|
|
}###GENERATENEWTITLE###
|
|
}
|