Joomla Platform  13.1
Documentation des API du framework Joomla Platform
 Tout Classes Espaces de nommage Fichiers Fonctions Variables Pages
Fonctions membres publiques | Fonctions membres protégées | Attributs protégés
Référence de la classe JControllerAdmin
+ Graphe d'héritage de JControllerAdmin:
+ Graphe de collaboration de JControllerAdmin:

Liste de tous les membres

Fonctions membres publiques

 __construct ($config=array())
 delete ()
 display ($cachable=false, $urlparams=array())
 publish ()
 reorder ()
 saveorder ()
 checkin ()
 saveOrderAjax ()
- Fonctions membres publiques inherited from JControllerLegacy
 addViewPath ($path)
 authorise ($task)
 execute ($task)
 getModel ($name= '', $prefix= '', $config=array())
 getName ()
 getTask ()
 getTasks ()
 getView ($name= '', $type= '', $prefix= '', $config=array())
 redirect ()
 registerDefaultTask ($method)
 registerTask ($task, $method)
 unregisterTask ($task)
 setMessage ($text, $type= 'message')
 setRedirect ($url, $msg=null, $type=null)
- Fonctions membres publiques inherited from JObject
 __toString ()
 def ($property, $default=null)
 get ($property, $default=null)
 getProperties ($public=true)
 getError ($i=null, $toString=true)
 getErrors ()
 set ($property, $value=null)
 setProperties ($properties)
 setError ($error)

Fonctions membres protégées

 postDeleteHook (JModelLegacy $model, $id=null)
- Fonctions membres protégées inherited from JControllerLegacy
 addPath ($type, $path)
 checkEditId ($context, $id)
 createModel ($name, $prefix= '', $config=array())
 createView ($name, $prefix= '', $type= '', $config=array())
 holdEditId ($context, $id)
 releaseEditId ($context, $id)
 setPath ($type, $path)

Attributs protégés

 $option
 $text_prefix
 $view_list
- Attributs protégés inherited from JControllerLegacy
 $basePath
 $default_view
 $doTask
 $message
 $messageType
 $methods
 $name
 $model_prefix
 $paths
 $redirect
 $task
 $taskMap
 $input
- Attributs protégés inherited from JObject
 $_errors = array()

Additional Inherited Members

- Fonctions membres publiques statiques inherited from JControllerLegacy
static addModelPath ($path, $prefix= '')
static getInstance ($prefix, $config=array())
- Fonctions membres protégées statiques inherited from JControllerLegacy
static createFileName ($type, $parts=array())
- Attributs protégés statiques inherited from JControllerLegacy
static $instance

Description détaillée

Définition à la ligne 22 du fichier admin.php.

Documentation des constructeurs et destructeur

JControllerAdmin::__construct (   $config = array())

Constructor.

Paramètres:
array$configAn optional associative array of configuration settings.
Voir également:
JControllerLegacy
Depuis:
12.2
Exceptions:
Exception

Réimplémentée à partir de JControllerLegacy.

Définition à la ligne 57 du fichier admin.php.

Références JText\_().

{
parent::__construct($config);
// Define standard task mappings.
// Value = 0
$this->registerTask('unpublish', 'publish');
// Value = 2
$this->registerTask('archive', 'publish');
// Value = -2
$this->registerTask('trash', 'publish');
// Value = -3
$this->registerTask('report', 'publish');
$this->registerTask('orderup', 'reorder');
$this->registerTask('orderdown', 'reorder');
// Guess the option as com_NameOfController.
if (empty($this->option))
{
$this->option = 'com_' . strtolower($this->getName());
}
// Guess the JText message prefix. Defaults to the option.
if (empty($this->text_prefix))
{
$this->text_prefix = strtoupper($this->option);
}
// Guess the list view as the suffix, eg: OptionControllerSuffix.
if (empty($this->view_list))
{
$r = null;
if (!preg_match('/(.*)Controller(.*)/i', get_class($this), $r))
{
throw new Exception(JText::_('JLIB_APPLICATION_ERROR_CONTROLLER_GET_NAME'), 500);
}
$this->view_list = strtolower($r[2]);
}
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

JControllerAdmin::checkin ( )

Check in of one or more records.

Renvoie:
boolean True on success
Depuis:
12.2

Définition à la ligne 321 du fichier admin.php.

Références JRoute\_(), JText\_(), JSession\checkToken(), JFactory\getApplication(), jexit(), JText\plural(), et JText\sprintf().

{
// Check for request forgeries.
JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
$ids = JFactory::getApplication()->input->post->get('cid', array(), 'array');
$model = $this->getModel();
$return = $model->checkin($ids);
if ($return === false)
{
// Checkin failed.
$message = JText::sprintf('JLIB_APPLICATION_ERROR_CHECKIN_FAILED', $model->getError());
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
return false;
}
else
{
// Checkin succeeded.
$message = JText::plural($this->text_prefix . '_N_ITEMS_CHECKED_IN', count($ids));
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message);
return true;
}
}

+ Voici le graphe d'appel pour cette fonction :

JControllerAdmin::delete ( )

Removes an item.

Renvoie:
void
Depuis:
12.2

Définition à la ligne 108 du fichier admin.php.

Références JRoute\_(), JText\_(), JLog\add(), JSession\checkToken(), JFactory\getApplication(), jimport(), JText\plural(), JArrayHelper\toInteger(), et JLog\WARNING.

{
// Check for request forgeries
JSession::checkToken() or die(JText::_('JINVALID_TOKEN'));
// Get items to remove from the request.
$cid = JFactory::getApplication()->input->get('cid', array(), 'array');
if (!is_array($cid) || count($cid) < 1)
{
JLog::add(JText::_($this->text_prefix . '_NO_ITEM_SELECTED'), JLog::WARNING, 'jerror');
}
else
{
// Get the model.
$model = $this->getModel();
// Make sure the item ids are integers
jimport('joomla.utilities.arrayhelper');
JArrayHelper::toInteger($cid);
// Remove the items.
if ($model->delete($cid))
{
$this->setMessage(JText::plural($this->text_prefix . '_N_ITEMS_DELETED', count($cid)));
}
else
{
$this->setMessage($model->getError());
}
}
// Invoke the postDelete method to allow for the child class to access the model.
$this->postDeleteHook($model, $cid);
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false));
}

+ Voici le graphe d'appel pour cette fonction :

JControllerAdmin::display (   $cachable = false,
  $urlparams = array() 
)

Display is not supported by this controller.

Paramètres:
boolean$cachableIf true, the view output will be cached
array$urlparamsAn array of safe url parameters and their variable types, for valid values see JFilterInput::clean().
Renvoie:
JControllerLegacy A JControllerLegacy object to support chaining.
Depuis:
12.2

Réimplémentée à partir de JControllerLegacy.

Définition à la ligne 170 du fichier admin.php.

{
return $this;
}
JControllerAdmin::postDeleteHook ( JModelLegacy  $model,
  $id = null 
)
protected

Function that allows child controller access to model data after the item has been deleted.

Paramètres:
JModelLegacy$modelThe data model object.
integer$idThe validated data.
Renvoie:
void
Depuis:
12.2

Définition à la ligne 156 du fichier admin.php.

{
}
JControllerAdmin::publish ( )

Method to publish a list of items

Renvoie:
void
Depuis:
12.2

Définition à la ligne 182 du fichier admin.php.

Références JRoute\_(), JText\_(), JLog\add(), JSession\checkToken(), JFactory\getApplication(), JArrayHelper\getValue(), JText\plural(), JArrayHelper\toInteger(), et JLog\WARNING.

{
// Check for request forgeries
JSession::checkToken() or die(JText::_('JINVALID_TOKEN'));
// Get items to publish from the request.
$cid = JFactory::getApplication()->input->get('cid', array(), 'array');
$data = array('publish' => 1, 'unpublish' => 0, 'archive' => 2, 'trash' => -2, 'report' => -3);
$task = $this->getTask();
$value = JArrayHelper::getValue($data, $task, 0, 'int');
if (empty($cid))
{
JLog::add(JText::_($this->text_prefix . '_NO_ITEM_SELECTED'), JLog::WARNING, 'jerror');
}
else
{
// Get the model.
$model = $this->getModel();
// Make sure the item ids are integers
JArrayHelper::toInteger($cid);
// Publish the items.
try
{
$model->publish($cid, $value);
if ($value == 1)
{
$ntext = $this->text_prefix . '_N_ITEMS_PUBLISHED';
}
elseif ($value == 0)
{
$ntext = $this->text_prefix . '_N_ITEMS_UNPUBLISHED';
}
elseif ($value == 2)
{
$ntext = $this->text_prefix . '_N_ITEMS_ARCHIVED';
}
else
{
$ntext = $this->text_prefix . '_N_ITEMS_TRASHED';
}
$this->setMessage(JText::plural($ntext, count($cid)));
}
catch (Exception $e)
{
$this->setMessage(JText::_('JLIB_DATABASE_ERROR_ANCESTOR_NODES_LOWER_STATE'), 'error');
}
}
$extension = $this->input->get('extension');
$extensionURL = ($extension) ? '&extension=' . $extension : '';
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list . $extensionURL, false));
}

+ Voici le graphe d'appel pour cette fonction :

JControllerAdmin::reorder ( )

Changes the order of one or more records.

Renvoie:
boolean True on success
Depuis:
12.2

Définition à la ligne 246 du fichier admin.php.

Références JRoute\_(), JText\_(), JSession\checkToken(), JFactory\getApplication(), jexit(), et JText\sprintf().

{
// Check for request forgeries.
JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
$ids = JFactory::getApplication()->input->post->get('cid', array(), 'array');
$inc = ($this->getTask() == 'orderup') ? -1 : 1;
$model = $this->getModel();
$return = $model->reorder($ids, $inc);
if ($return === false)
{
// Reorder failed.
$message = JText::sprintf('JLIB_APPLICATION_ERROR_REORDER_FAILED', $model->getError());
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
return false;
}
else
{
// Reorder succeeded.
$message = JText::_('JLIB_APPLICATION_SUCCESS_ITEM_REORDERED');
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message);
return true;
}
}

+ Voici le graphe d'appel pour cette fonction :

JControllerAdmin::saveorder ( )

Method to save the submitted ordering values for records.

Renvoie:
boolean True on success
Depuis:
12.2

Définition à la ligne 279 du fichier admin.php.

Références JRoute\_(), JText\_(), JSession\checkToken(), jexit(), JText\sprintf(), et JArrayHelper\toInteger().

{
// Check for request forgeries.
JSession::checkToken() or jexit(JText::_('JINVALID_TOKEN'));
// Get the input
$pks = $this->input->post->get('cid', array(), 'array');
$order = $this->input->post->get('order', array(), 'array');
// Sanitize the input
JArrayHelper::toInteger($pks);
JArrayHelper::toInteger($order);
// Get the model
$model = $this->getModel();
// Save the ordering
$return = $model->saveorder($pks, $order);
if ($return === false)
{
// Reorder failed
$message = JText::sprintf('JLIB_APPLICATION_ERROR_REORDER_FAILED', $model->getError());
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false), $message, 'error');
return false;
}
else
{
// Reorder succeeded.
$this->setMessage(JText::_('JLIB_APPLICATION_SUCCESS_ORDERING_SAVED'));
$this->setRedirect(JRoute::_('index.php?option=' . $this->option . '&view=' . $this->view_list, false));
return true;
}
}

+ Voici le graphe d'appel pour cette fonction :

JControllerAdmin::saveOrderAjax ( )

Method to save the submitted ordering values for records via AJAX.

Renvoie:
void
Depuis:
3.0

Définition à la ligne 353 du fichier admin.php.

Références JFactory\getApplication(), et JArrayHelper\toInteger().

{
// Get the input
$pks = $this->input->post->get('cid', array(), 'array');
$order = $this->input->post->get('order', array(), 'array');
// Sanitize the input
JArrayHelper::toInteger($pks);
JArrayHelper::toInteger($order);
// Get the model
$model = $this->getModel();
// Save the ordering
$return = $model->saveorder($pks, $order);
if ($return)
{
echo "1";
}
// Close the application
JFactory::getApplication()->close();
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des données membres

JControllerAdmin::$option
protected

Définition à la ligne 30 du fichier admin.php.

JControllerAdmin::$text_prefix
protected

Définition à la ligne 38 du fichier admin.php.

JControllerAdmin::$view_list
protected

Définition à la ligne 46 du fichier admin.php.

La documentation de cette classe a été générée à partir du fichier suivant :