- md5
- 8709ee760b869c80e71400db522c2205
- sha1
- 61a751c94a83524c86e6e8e76a895dd6b0ec8c60
- sha256
- 53cfa79f3b23120111f3a20ca63470d4ce2998e32bf11a95ee3d9ca80edf41ad
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255
<?php
/**
* @package Joomla.Cms
* @subpackage View
*
* @copyright (C) 2005 Open Source Matters, Inc. <https://www.joomla.org>
* @license GNU General Public License version 2 or later; see LICENSE
*/
namespace Joomla\CMS\MVC\View;
\defined('JPATH_PLATFORM') or die;
use Joomla\CMS\Component\ComponentHelper;
use Joomla\CMS\Factory;
use Joomla\CMS\Language\Text;
use Joomla\CMS\Object\CMSObject;
use Joomla\CMS\Toolbar\ToolbarHelper;
/**
* Base class for a Joomla Form View
*
* Class holding methods for displaying presentation data.
*
* @since 2.5.5
*/
class FormView extends HtmlView
{
/**
* The \JForm object
*
* @var \Joomla\CMS\Form\Form
*/
protected $form;
/**
* The active item
*
* @var object
*/
protected $item;
/**
* The model state
*
* @var object
*/
protected $state;
/**
* The actions the user is authorised to perform
*
* @var CMSObject
*/
protected $canDo;
/**
* The toolbar title
*
* @var string
*/
protected $toolbarTitle;
/**
* The toolbar icon
*
* @var string
*/
protected $toolbarIcon;
/**
* The preview link
*
* @var string
*/
protected $previewLink;
/**
* The help link
*
* @var string
*/
protected $helpLink;
/**
* Constructor
*
* @param array $config An optional associative array of configuration settings.
*/
public function __construct(array $config)
{
parent::__construct($config);
if (isset($config['help_link']))
{
$this->helpLink = $config['help_link'];
}
if (isset($config['toolbar_icon']))
{
$this->toolbarIcon = $config['toolbar_icon'];
}
else
{
$this->toolbarIcon = 'pencil-2 ' . $this->getName() . '-add';
}
// Set default value for $canDo to avoid fatal error if child class doesn't set value for this property
$this->canDo = new CMSObject;
}
/**
* Execute and display a template script.
*
* @param string $tpl The name of the template file to parse; automatically searches through the template paths.
*
* @return void
*
* @throws \Exception
*/
public function display($tpl = null)
{
// Prepare view data
$this->initializeView();
// Check for errors.
if (\count($errors = $this->get('Errors')))
{
throw new GenericDataException(implode("\n", $errors), 500);
}
// Build toolbar
$this->addToolbar();
parent::display($tpl);
}
/**
* Prepare view data
*
* @return void
*/
protected function initializeView()
{
$this->form = $this->get('Form');
$this->item = $this->get('Item');
$this->state = $this->get('State');
// Set default toolbar title
if ($this->item->id)
{
$this->toolbarTitle = Text::_(strtoupper($this->option . '_MANAGER_' . $this->getName() . '_EDIT'));
}
else
{
$this->toolbarTitle = Text::_(strtoupper($this->option . '_MANAGER_' . $this->getName() . '_NEW'));
}
}
/**
* Add the page title and toolbar.
*
* @return void
*
* @since 1.6
*/
protected function addToolbar()
{
Factory::getApplication()->input->set('hidemainmenu', true);
$user = Factory::getUser();
$userId = $user->id;
$isNew = ($this->item->id == 0);
$viewName = $this->getName();
$checkedOut = $this->getModel()->isCheckedOut($this->item);
$canDo = $this->canDo;
ToolbarHelper::title(
$this->toolbarTitle,
$this->toolbarIcon
);
// For new records, check the create permission.
if ($isNew && $canDo->get('core.create'))
{
ToolbarHelper::saveGroup(
[
['apply', $viewName . '.apply'],
['save', $viewName . '.save'],
['save2new', $viewName . '.save2new']
],
'btn-success'
);
ToolbarHelper::cancel($viewName . '.cancel');
}
else
{
// Since it's an existing record, check the edit permission, or fall back to edit own if the owner.
if (property_exists($this->item, 'created_by'))
{
$itemEditable = $canDo->get('core.edit') || ($canDo->get('core.edit.own') && $this->item->created_by == $userId);
}
else
{
$itemEditable = $canDo->get('core.edit');
}
$toolbarButtons = [];
// Can't save the record if it's checked out and editable
if (!$checkedOut && $itemEditable)
{
$toolbarButtons[] = ['apply', $viewName . '.apply'];
$toolbarButtons[] = ['save', $viewName . '.save'];
// We can save this record, but check the create permission to see if we can return to make a new one.
if ($canDo->get('core.create'))
{
$toolbarButtons[] = ['save2new', $viewName . '.save2new'];
}
}
// If checked out, we can still save
if ($canDo->get('core.create'))
{
$toolbarButtons[] = ['save2copy', $viewName . '.save2copy'];
}
ToolbarHelper::saveGroup(
$toolbarButtons,
'btn-success'
);
if (ComponentHelper::isEnabled('com_contenthistory') && $this->state->params->get('save_history', 0) && $itemEditable)
{
ToolbarHelper::versions($this->option . '.' . $viewName, $this->item->id);
}
if (!$isNew && $this->previewLink)
{
ToolbarHelper::preview($this->previewLink, Text::_('JGLOBAL_PREVIEW'), 'eye', 80, 90);
}
ToolbarHelper::cancel($viewName . '.cancel', 'JTOOLBAR_CLOSE');
}
ToolbarHelper::divider();
if ($this->helpLink)
{
ToolbarHelper::help($this->helpLink);
}
}
}
The same content is in 7 releases, Joomla 4.0.0-rc1 to 4.0.0. See them all, or every version of this file.