| Current File : /home/pacjaorg/www/kmm/administrator/components/com_fields/src/Model/FieldsModel.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\Model;
use Joomla\CMS\Categories\CategoryServiceInterface;
use Joomla\CMS\Categories\SectionNotFoundException;
use Joomla\CMS\Factory;
use Joomla\CMS\MVC\Factory\MVCFactoryInterface;
use Joomla\CMS\MVC\Model\ListModel;
use Joomla\Component\Fields\Administrator\Helper\FieldsHelper;
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
/**
* Fields Model
*
* @since 3.7.0
*/
class FieldsModel extends ListModel
{
/**
* Constructor
*
* @param array $config An array of configuration options (name, state, dbo, table_path, ignore_request).
* @param MVCFactoryInterface $factory The factory.
*
* @since 3.7.0
* @throws \Exception
*/
public function __construct($config = [], MVCFactoryInterface $factory = null)
{
if (empty($config['filter_fields'])) {
$config['filter_fields'] = [
'id', 'a.id',
'title', 'a.title',
'type', 'a.type',
'name', 'a.name',
'state', 'a.state',
'access', 'a.access',
'access_level',
'only_use_in_subform',
'language', 'a.language',
'ordering', 'a.ordering',
'checked_out', 'a.checked_out',
'checked_out_time', 'a.checked_out_time',
'created_time', 'a.created_time',
'created_user_id', 'a.created_user_id',
'group_title', 'g.title',
'category_id', 'a.category_id',
'group_id', 'a.group_id',
'assigned_cat_ids',
];
}
parent::__construct($config, $factory);
}
/**
* Method to auto-populate the model state.
*
* This method should only be called once per instantiation and is designed
* to be called on the first call to the getState() method unless the model
* configuration flag to ignore the request is set.
*
* Note. Calling getState in this method will result in recursion.
*
* @param string $ordering An optional ordering field.
* @param string $direction An optional direction (asc|desc).
*
* @return void
*
* @since 3.7.0
*/
protected function populateState($ordering = null, $direction = null)
{
// List state information.
parent::populateState('a.ordering', 'asc');
$context = $this->getUserStateFromRequest($this->context . '.context', 'context', 'com_content.article', 'CMD');
$this->setState('filter.context', $context);
// Split context into component and optional section
$parts = FieldsHelper::extract($context);
if ($parts) {
$this->setState('filter.component', $parts[0]);
$this->setState('filter.section', $parts[1]);
}
}
/**
* Method to get a store id based on the model configuration state.
*
* This is necessary because the model is used by the component and
* different modules that might need different sets of data or different
* ordering requirements.
*
* @param string $id An identifier string to generate the store id.
*
* @return string A store id.
*
* @since 3.7.0
*/
protected function getStoreId($id = '')
{
// Compile the store id.
$id .= ':' . $this->getState('filter.search');
$id .= ':' . $this->getState('filter.context');
$id .= ':' . serialize($this->getState('filter.assigned_cat_ids'));
$id .= ':' . $this->getState('filter.state');
$id .= ':' . $this->getState('filter.group_id');
$id .= ':' . serialize($this->getState('filter.language'));
$id .= ':' . $this->getState('filter.only_use_in_subform');
return parent::getStoreId($id);
}
/**
* Method to get a DatabaseQuery object for retrieving the data set from a database.
*
* @return \Joomla\Database\DatabaseQuery A DatabaseQuery object to retrieve the data set.
*
* @since 3.7.0
*/
protected function getListQuery()
{
// Create a new query object.
$db = $this->getDatabase();
$query = $db->getQuery(true);
$user = $this->getCurrentUser();
$app = Factory::getApplication();
// Select the required fields from the table.
$query->select(
$this->getState(
'list.select',
'DISTINCT a.id, a.title, a.name, a.checked_out, a.checked_out_time, a.note' .
', a.state, a.access, a.created_time, a.created_user_id, a.ordering, a.language' .
', a.fieldparams, a.params, a.type, a.default_value, a.context, a.group_id' .
', a.label, a.description, a.required, a.only_use_in_subform'
)
);
$query->from('#__fields AS a');
// Join over the language
$query->select('l.title AS language_title, l.image AS language_image')
->join('LEFT', $db->quoteName('#__languages') . ' AS l ON l.lang_code = a.language');
// Join over the users for the checked out user.
$query->select('uc.name AS editor')->join('LEFT', '#__users AS uc ON uc.id=a.checked_out');
// Join over the asset groups.
$query->select('ag.title AS access_level')->join('LEFT', '#__viewlevels AS ag ON ag.id = a.access');
// Join over the users for the author.
$query->select('ua.name AS author_name')->join('LEFT', '#__users AS ua ON ua.id = a.created_user_id');
// Join over the field groups.
$query->select('g.title AS group_title, g.access as group_access, g.state AS group_state, g.note as group_note');
$query->join('LEFT', '#__fields_groups AS g ON g.id = a.group_id');
// Filter by context
if ($context = $this->getState('filter.context')) {
$query->where($db->quoteName('a.context') . ' = :context')
->bind(':context', $context);
}
// Filter by access level.
if ($access = $this->getState('filter.access')) {
if (is_array($access)) {
$access = ArrayHelper::toInteger($access);
$query->whereIn($db->quoteName('a.access'), $access);
} else {
$access = (int) $access;
$query->where($db->quoteName('a.access') . ' = :access')
->bind(':access', $access, ParameterType::INTEGER);
}
}
if (($categories = $this->getState('filter.assigned_cat_ids')) && $context) {
$categories = (array) $categories;
$categories = ArrayHelper::toInteger($categories);
$parts = FieldsHelper::extract($context);
if ($parts) {
// Get the categories for this component (and optionally this section, if available)
$cat = (
function () use ($parts) {
// Get the CategoryService for this component
$componentObject = $this->bootComponent($parts[0]);
if (!$componentObject instanceof CategoryServiceInterface) {
// No CategoryService -> no categories
return null;
}
$cat = null;
// Try to get the categories for this component and section
try {
$cat = $componentObject->getCategory([], $parts[1] ?: '');
} catch (SectionNotFoundException $e) {
// Not found for component and section -> Now try once more without the section, so only component
try {
$cat = $componentObject->getCategory();
} catch (SectionNotFoundException $e) {
// If we haven't found it now, return (no categories available for this component)
return null;
}
}
// So we found categories for at least the component, return them
return $cat;
}
)();
if ($cat) {
foreach ($categories as $assignedCatIds) {
// Check if we have the actual category
$parent = $cat->get($assignedCatIds);
if ($parent) {
$categories[] = (int) $parent->id;
// Traverse the tree up to get all the fields which are attached to a parent
while ($parent->getParent() && $parent->getParent()->id != 'root') {
$parent = $parent->getParent();
$categories[] = (int) $parent->id;
}
}
}
}
}
$categories = array_unique($categories);
// Join over the assigned categories
$query->join('LEFT', $db->quoteName('#__fields_categories') . ' AS fc ON fc.field_id = a.id');
if (in_array('0', $categories)) {
$query->where(
'(' .
$db->quoteName('fc.category_id') . ' IS NULL OR ' .
$db->quoteName('fc.category_id') . ' IN (' . implode(',', $query->bindArray(array_values($categories), ParameterType::INTEGER)) . ')' .
')'
);
} else {
$query->whereIn($db->quoteName('fc.category_id'), $categories);
}
}
// Implement View Level Access
if (!$app->isClient('administrator') || !$user->authorise('core.admin')) {
$groups = $user->getAuthorisedViewLevels();
$query->whereIn($db->quoteName('a.access'), $groups);
$query->extendWhere(
'AND',
[
$db->quoteName('a.group_id') . ' = 0',
$db->quoteName('g.access') . ' IN (' . implode(',', $query->bindArray($groups, ParameterType::INTEGER)) . ')',
],
'OR'
);
}
// Filter by state
$state = $this->getState('filter.state');
// Include group state only when not on on back end list
$includeGroupState = !$app->isClient('administrator') ||
$app->getInput()->get('option') != 'com_fields' ||
$app->getInput()->get('view') != 'fields';
if (is_numeric($state)) {
$state = (int) $state;
$query->where($db->quoteName('a.state') . ' = :state')
->bind(':state', $state, ParameterType::INTEGER);
if ($includeGroupState) {
$query->extendWhere(
'AND',
[
$db->quoteName('a.group_id') . ' = 0',
$db->quoteName('g.state') . ' = :gstate',
],
'OR'
)
->bind(':gstate', $state, ParameterType::INTEGER);
}
} elseif (!$state) {
$query->whereIn($db->quoteName('a.state'), [0, 1]);
if ($includeGroupState) {
$query->extendWhere(
'AND',
[
$db->quoteName('a.group_id') . ' = 0',
$db->quoteName('g.state') . ' IN (' . implode(',', $query->bindArray([0, 1], ParameterType::INTEGER)) . ')',
],
'OR'
);
}
}
$groupId = $this->getState('filter.group_id');
if (is_numeric($groupId)) {
$groupId = (int) $groupId;
$query->where($db->quoteName('a.group_id') . ' = :groupid')
->bind(':groupid', $groupId, ParameterType::INTEGER);
}
$onlyUseInSubForm = $this->getState('filter.only_use_in_subform');
if (is_numeric($onlyUseInSubForm)) {
$onlyUseInSubForm = (int) $onlyUseInSubForm;
$query->where($db->quoteName('a.only_use_in_subform') . ' = :only_use_in_subform')
->bind(':only_use_in_subform', $onlyUseInSubForm, ParameterType::INTEGER);
}
// Filter by search in title
$search = $this->getState('filter.search');
if (!empty($search)) {
if (stripos($search, 'id:') === 0) {
$search = (int) substr($search, 3);
$query->where($db->quoteName('a.id') . ' = :id')
->bind(':id', $search, ParameterType::INTEGER);
} elseif (stripos($search, 'author:') === 0) {
$search = '%' . substr($search, 7) . '%';
$query->where(
'(' .
$db->quoteName('ua.name') . ' LIKE :name OR ' .
$db->quoteName('ua.username') . ' LIKE :username' .
')'
)
->bind(':name', $search)
->bind(':username', $search);
} else {
$search = '%' . str_replace(' ', '%', trim($search)) . '%';
$query->where(
'(' .
$db->quoteName('a.title') . ' LIKE :title OR ' .
$db->quoteName('a.name') . ' LIKE :sname OR ' .
$db->quoteName('a.note') . ' LIKE :note' .
')'
)
->bind(':title', $search)
->bind(':sname', $search)
->bind(':note', $search);
}
}
// Filter on the language.
if ($language = $this->getState('filter.language')) {
$language = (array) $language;
$query->whereIn($db->quoteName('a.language'), $language, ParameterType::STRING);
}
// Add the list ordering clause
$listOrdering = $this->state->get('list.ordering', 'a.ordering');
$orderDirn = $this->state->get('list.direction', 'ASC');
$query->order($db->escape($listOrdering) . ' ' . $db->escape($orderDirn));
return $query;
}
/**
* Gets an array of objects from the results of database query.
*
* @param string $query The query.
* @param integer $limitstart Offset.
* @param integer $limit The number of records.
*
* @return array An array of results.
*
* @since 3.7.0
* @throws \RuntimeException
*/
protected function _getList($query, $limitstart = 0, $limit = 0)
{
$result = parent::_getList($query, $limitstart, $limit);
if (is_array($result)) {
foreach ($result as $field) {
$field->fieldparams = new Registry($field->fieldparams);
$field->params = new Registry($field->params);
}
}
return $result;
}
/**
* Get the filter form
*
* @param array $data data
* @param boolean $loadData load current data
*
* @return \Joomla\CMS\Form\Form|bool the Form object or false
*
* @since 3.7.0
*/
public function getFilterForm($data = [], $loadData = true)
{
$form = parent::getFilterForm($data, $loadData);
if ($form) {
$form->setValue('context', null, $this->getState('filter.context'));
$form->setFieldAttribute('group_id', 'context', $this->getState('filter.context'), 'filter');
$form->setFieldAttribute('assigned_cat_ids', 'extension', $this->state->get('filter.component'), 'filter');
}
return $form;
}
/**
* Get the groups for the batch method
*
* @return array An array of groups
*
* @since 3.7.0
*/
public function getGroups()
{
$user = $this->getCurrentUser();
$viewlevels = ArrayHelper::toInteger($user->getAuthorisedViewLevels());
$context = $this->state->get('filter.context');
$db = $this->getDatabase();
$query = $db->getQuery(true);
$query->select(
[
$db->quoteName('title', 'text'),
$db->quoteName('id', 'value'),
$db->quoteName('state'),
]
);
$query->from($db->quoteName('#__fields_groups'));
$query->whereIn($db->quoteName('state'), [0, 1]);
$query->where($db->quoteName('context') . ' = :context');
$query->whereIn($db->quoteName('access'), $viewlevels);
$query->bind(':context', $context);
$db->setQuery($query);
return $db->loadObjectList();
}
}