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 publiques statiques | Fonctions membres protégées | Fonctions membres protégées statiques | Attributs protégés | Attributs protégés statiques
Référence de la classe JControllerLegacy
+ Graphe d'héritage de JControllerLegacy:
+ Graphe de collaboration de JControllerLegacy:

Liste de tous les membres

Fonctions membres publiques

 __construct ($config=array())
 addViewPath ($path)
 authorise ($task)
 display ($cachable=false, $urlparams=array())
 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 publiques statiques

static addModelPath ($path, $prefix= '')
static getInstance ($prefix, $config=array())

Fonctions membres protégées

 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)

Fonctions membres protégées statiques

static createFileName ($type, $parts=array())

Attributs protégés

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

Attributs protégés statiques

static $instance

Description détaillée

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

Documentation des constructeurs et destructeur

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

Constructor.

Paramètres:
array$configAn optional associative array of configuration settings. Recognized key values include 'name', 'default_task', 'model_path', and 'view_path' (this list is not meant to be comprehensive).
Depuis:
12.2

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

Réimplémentée dans JControllerForm, et JControllerAdmin.

Définition à la ligne 319 du fichier legacy.php.

Références JLog\addLogger(), JLog\ALL, et JFactory\getApplication().

{
$this->methods = array();
$this->message = null;
$this->messageType = 'message';
$this->paths = array();
$this->redirect = null;
$this->taskMap = array();
if (defined('JDEBUG') && JDEBUG)
{
JLog::addLogger(array('text_file' => 'jcontroller.log.php'), JLog::ALL, array('controller'));
}
$this->input = JFactory::getApplication()->input;
// Determine the methods to exclude from the base class.
$xMethods = get_class_methods('JControllerLegacy');
// Get the public methods in this class using reflection.
$r = new ReflectionClass($this);
$rMethods = $r->getMethods(ReflectionMethod::IS_PUBLIC);
foreach ($rMethods as $rMethod)
{
$mName = $rMethod->getName();
// Add default display method if not explicitly declared.
if (!in_array($mName, $xMethods) || $mName == 'display')
{
$this->methods[] = strtolower($mName);
// Auto register the methods as tasks.
$this->taskMap[strtolower($mName)] = $mName;
}
}
// Set the view name
if (empty($this->name))
{
if (array_key_exists('name', $config))
{
$this->name = $config['name'];
}
else
{
$this->name = $this->getName();
}
}
// Set a base path for use by the controller
if (array_key_exists('base_path', $config))
{
$this->basePath = $config['base_path'];
}
else
{
$this->basePath = JPATH_COMPONENT;
}
// If the default task is set, register it as such
if (array_key_exists('default_task', $config))
{
$this->registerDefaultTask($config['default_task']);
}
else
{
$this->registerDefaultTask('display');
}
// Set the models prefix
if (empty($this->model_prefix))
{
if (array_key_exists('model_prefix', $config))
{
// User-defined prefix
$this->model_prefix = $config['model_prefix'];
}
else
{
$this->model_prefix = $this->name . 'Model';
}
}
// Set the default model search path
if (array_key_exists('model_path', $config))
{
// User-defined dirs
$this->addModelPath($config['model_path'], $this->model_prefix);
}
else
{
$this->addModelPath($this->basePath . '/models', $this->model_prefix);
}
// Set the default view search path
if (array_key_exists('view_path', $config))
{
// User-defined dirs
$this->setPath('view', $config['view_path']);
}
else
{
$this->setPath('view', $this->basePath . '/views');
}
// Set the default view.
if (array_key_exists('default_view', $config))
{
$this->default_view = $config['default_view'];
}
elseif (empty($this->default_view))
{
$this->default_view = $this->getName();
}
}

+ Voici le graphe d'appel pour cette fonction :

Documentation des fonctions membres

static JControllerLegacy::addModelPath (   $path,
  $prefix = '' 
)
static

Adds to the stack of model paths in LIFO order.

Paramètres:
mixed$pathThe directory (string), or list of directories (array) to add.
string$prefixA prefix for models
Renvoie:
void

Définition à la ligne 154 du fichier legacy.php.

Références JModelLegacy\addIncludePath().

{
JModelLegacy::addIncludePath($path, $prefix);
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::addPath (   $type,
  $path 
)
protected

Adds to the search path for templates and resources.

Paramètres:
string$typeThe path type (e.g. 'model', 'view').
mixed$pathThe directory string or stream array to search.
Renvoie:
JControllerLegacy A JControllerLegacy object to support chaining.
Depuis:
12.2
Note:
Replaces _addPath.

Définition à la ligne 448 du fichier legacy.php.

Références JPath\check().

{
// Just force path to array
settype($path, 'array');
if (!isset($this->paths[$type]))
{
$this->paths[$type] = array();
}
// Loop through the path directories
foreach ($path as $dir)
{
// No surrounding spaces allowed!
$dir = rtrim(JPath::check($dir, '/'), '/') . '/';
// Add to the top of the search dirs
array_unshift($this->paths[$type], $dir);
}
return $this;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::addViewPath (   $path)

Add one or more view paths to the controller's stack, in LIFO order.

Paramètres:
mixed$pathThe directory (string) or list of directories (array) to add.
Renvoie:
JControllerLegacy This object to support chaining.

Définition à la ligne 478 du fichier legacy.php.

{
$this->addPath('view', $path);
return $this;
}
JControllerLegacy::authorise (   $task)

Authorisation check

Paramètres:
string$taskThe ACO Section Value to check access on.
Renvoie:
boolean True if authorised
Depuis:
12.2
Obsolète:
13.3 Use JAccess instead.

Définition à la ligne 495 du fichier legacy.php.

Références JLog\add(), et JLog\WARNING.

{
JLog::add(__METHOD__ . ' is deprecated. Use JAccess instead.', JLog::WARNING, 'deprecated');
return true;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::checkEditId (   $context,
  $id 
)
protected

Method to check whether an ID is in the edit list.

Paramètres:
string$contextThe context for the session storage.
integer$idThe ID of the record to add to the edit list.
Renvoie:
boolean True if the ID is in the edit list.
Depuis:
12.2

Définition à la ligne 512 du fichier legacy.php.

Références JLog\add(), JFactory\getApplication(), et JLog\INFO.

{
if ($id)
{
$app = JFactory::getApplication();
$values = (array) $app->getUserState($context . '.id');
$result = in_array((int) $id, $values);
if (defined('JDEBUG') && JDEBUG)
{
JLog::add(
sprintf(
'Checking edit ID %s.%s: %d %s',
$context,
$id,
(int) $result,
str_replace("\n", ' ', print_r($values, 1))
),
JLog::INFO,
'controller'
);
}
return $result;
}
else
{
// No id for a new item.
return true;
}
}

+ Voici le graphe d'appel pour cette fonction :

static JControllerLegacy::createFileName (   $type,
  $parts = array() 
)
staticprotected

Create the filename for a resource.

Paramètres:
string$typeThe resource type to create the filename for.
array$partsAn associative array of filename information. Optional.
Renvoie:
string The filename.
Note:
Replaced _createFileName.
Depuis:
12.2

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

{
$filename = '';
switch ($type)
{
case 'controller':
if (!empty($parts['format']))
{
if ($parts['format'] == 'html')
{
$parts['format'] = '';
}
else
{
$parts['format'] = '.' . $parts['format'];
}
}
else
{
$parts['format'] = '';
}
$filename = strtolower($parts['name'] . $parts['format'] . '.php');
break;
case 'view':
if (!empty($parts['type']))
{
$parts['type'] = '.' . $parts['type'];
}
else
{
$parts['type'] = '';
}
$filename = strtolower($parts['name'] . '/view' . $parts['type'] . '.php');
break;
}
return $filename;
}
JControllerLegacy::createModel (   $name,
  $prefix = '',
  $config = array() 
)
protected

Method to load and return a model object.

Paramètres:
string$nameThe name of the model.
string$prefixOptional model prefix.
array$configConfiguration array for the model. Optional.
Renvoie:
mixed Model object on success; otherwise null failure.
Depuis:
12.2
Note:
Replaces _createModel.

Définition à la ligne 557 du fichier legacy.php.

Références JModelLegacy\getInstance().

{
// Clean the model name
$modelName = preg_replace('/[^A-Z0-9_]/i', '', $name);
$classPrefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);
$result = JModelLegacy::getInstance($modelName, $classPrefix, $config);
return $result;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::createView (   $name,
  $prefix = '',
  $type = '',
  $config = array() 
)
protected

Method to load and return a view object. This method first looks in the current template directory for a match and, failing that, uses a default set path to load the view class file.

Note the "name, prefix, type" order of parameters, which differs from the "name, type, prefix" order used in related public methods.

Paramètres:
string$nameThe name of the view.
string$prefixOptional prefix for the view class name.
string$typeThe type of view.
array$configConfiguration array for the view. Optional.
Renvoie:
mixed View object on success; null or error result on failure.
Depuis:
12.2
Note:
Replaces _createView.
Exceptions:
Exception

Définition à la ligne 587 du fichier legacy.php.

Références JPath\find(), jimport(), et JText\sprintf().

{
// Clean the view name
$viewName = preg_replace('/[^A-Z0-9_]/i', '', $name);
$classPrefix = preg_replace('/[^A-Z0-9_]/i', '', $prefix);
$viewType = preg_replace('/[^A-Z0-9_]/i', '', $type);
// Build the view class name
$viewClass = $classPrefix . $viewName;
if (!class_exists($viewClass))
{
jimport('joomla.filesystem.path');
$path = JPath::find($this->paths['view'], $this->createFileName('view', array('name' => $viewName, 'type' => $viewType)));
if ($path)
{
require_once $path;
if (!class_exists($viewClass))
{
throw new Exception(JText::sprintf('JLIB_APPLICATION_ERROR_VIEW_CLASS_NOT_FOUND', $viewClass, $path), 500);
}
}
else
{
return null;
}
}
return new $viewClass($config);
}

+ Voici le graphe d'appel pour cette fonction :

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

Typical view method for MVC based architecture

This function is provide as a default implementation, in most cases you will need to override it in your own controllers.

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 dans JControllerAdmin.

Définition à la ligne 633 du fichier legacy.php.

Références JFactory\getApplication(), JFactory\getCache(), JFactory\getConfig(), et JFactory\getDocument().

{
$document = JFactory::getDocument();
$viewType = $document->getType();
$viewName = $this->input->get('view', $this->default_view);
$viewLayout = $this->input->get('layout', 'default');
$view = $this->getView($viewName, $viewType, '', array('base_path' => $this->basePath, 'layout' => $viewLayout));
// Get/Create the model
if ($model = $this->getModel($viewName))
{
// Push the model into the view (as default)
$view->setModel($model, true);
}
$view->document = $document;
$conf = JFactory::getConfig();
// Display the view
if ($cachable && $viewType != 'feed' && $conf->get('caching') >= 1)
{
$option = $this->input->get('option');
$cache = JFactory::getCache($option, 'view');
if (is_array($urlparams))
{
$app = JFactory::getApplication();
if (!empty($app->registeredurlparams))
{
$registeredurlparams = $app->registeredurlparams;
}
else
{
$registeredurlparams = new stdClass;
}
foreach ($urlparams as $key => $value)
{
// Add your safe url parameters with variable type as value {@see JFilterInput::clean()}.
$registeredurlparams->$key = $value;
}
$app->registeredurlparams = $registeredurlparams;
}
$cache->get($view, 'display');
}
else
{
$view->display();
}
return $this;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::execute (   $task)

Execute a task by triggering a method in the derived class.

Paramètres:
string$taskThe task to perform. If no matching task is found, the '__default' task is executed, if defined.
Renvoie:
mixed The value returned by the called method, false in error case.
Depuis:
12.2
Exceptions:
Exception

Définition à la ligne 701 du fichier legacy.php.

Références JText\sprintf().

{
$this->task = $task;
$task = strtolower($task);
if (isset($this->taskMap[$task]))
{
$doTask = $this->taskMap[$task];
}
elseif (isset($this->taskMap['__default']))
{
$doTask = $this->taskMap['__default'];
}
else
{
throw new Exception(JText::sprintf('JLIB_APPLICATION_ERROR_TASK_NOT_FOUND', $task), 404);
}
// Record the actual task being fired
$this->doTask = $doTask;
return $this->$doTask();
}

+ Voici le graphe d'appel pour cette fonction :

static JControllerLegacy::getInstance (   $prefix,
  $config = array() 
)
static

Method to get a singleton controller instance.

Paramètres:
string$prefixThe prefix for the controller.
array$configAn array of optional constructor options.
Renvoie:
JControllerLegacy
Depuis:
12.2
Exceptions:
Exceptionif the controller cannot be loaded.

Définition à la ligne 224 du fichier legacy.php.

Références JFactory\getApplication(), JFilterInput\getInstance(), et JText\sprintf().

{
if (is_object(self::$instance))
{
return self::$instance;
}
$input = JFactory::getApplication()->input;
// Get the environment configuration.
$basePath = array_key_exists('base_path', $config) ? $config['base_path'] : JPATH_COMPONENT;
$format = $input->getWord('format');
$command = $input->get('task', 'display');
// Check for array format.
$filter = JFilterInput::getInstance();
if (is_array($command))
{
$command = $filter->clean(array_pop(array_keys($command)), 'cmd');
}
else
{
$command = $filter->clean($command, 'cmd');
}
// Check for a controller.task command.
if (strpos($command, '.') !== false)
{
// Explode the controller.task command.
list ($type, $task) = explode('.', $command);
// Define the controller filename and path.
$file = self::createFileName('controller', array('name' => $type, 'format' => $format));
$path = $basePath . '/controllers/' . $file;
$backuppath = $basePath . '/controller/' . $file;
// Reset the task without the controller context.
$input->set('task', $task);
}
else
{
// Base controller.
$type = null;
// Define the controller filename and path.
$file = self::createFileName('controller', array('name' => 'controller', 'format' => $format));
$path = $basePath . '/' . $file;
$backupfile = self::createFileName('controller', array('name' => 'controller'));
$backuppath = $basePath . '/' . $backupfile;
}
// Get the controller class name.
$class = ucfirst($prefix) . 'Controller' . ucfirst($type);
// Include the class if not present.
if (!class_exists($class))
{
// If the controller file path exists, include it.
if (file_exists($path))
{
require_once $path;
}
elseif (isset($backuppath) && file_exists($backuppath))
{
require_once $backuppath;
}
else
{
throw new InvalidArgumentException(JText::sprintf('JLIB_APPLICATION_ERROR_INVALID_CONTROLLER', $type, $format));
}
}
// Instantiate the class.
if (class_exists($class))
{
self::$instance = new $class($config);
}
else
{
throw new InvalidArgumentException(JText::sprintf('JLIB_APPLICATION_ERROR_INVALID_CONTROLLER_CLASS', $class));
}
return self::$instance;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::getModel (   $name = '',
  $prefix = '',
  $config = array() 
)

Method to get a model object, loading it if required.

Paramètres:
string$nameThe model name. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration array for model. Optional.
Renvoie:
object The model.
Depuis:
12.2

Réimplémentée dans JControllerForm.

Définition à la ligne 736 du fichier legacy.php.

Références JFactory\getApplication().

{
if (empty($name))
{
$name = $this->getName();
}
if (empty($prefix))
{
$prefix = $this->model_prefix;
}
if ($model = $this->createModel($name, $prefix, $config))
{
// Task is a reserved state
$model->setState('task', $this->task);
// Let's get the application object and set menu information if it's available
$app = JFactory::getApplication();
$menu = $app->getMenu();
if (is_object($menu))
{
if ($item = $menu->getActive())
{
$params = $menu->getParams($item->id);
// Set default state data
$model->setState('parameters.menu', $params);
}
}
}
return $model;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::getName ( )

Method to get the controller name

The dispatcher name is set by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor

Renvoie:
string The name of the dispatcher
Depuis:
12.2
Exceptions:
Exception

Définition à la ligne 782 du fichier legacy.php.

Références JText\_().

{
if (empty($this->name))
{
$r = null;
if (!preg_match('/(.*)Controller/i', get_class($this), $r))
{
throw new Exception(JText::_('JLIB_APPLICATION_ERROR_CONTROLLER_GET_NAME'), 500);
}
$this->name = strtolower($r[1]);
}
return $this->name;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::getTask ( )

Get the last task that is being performed or was most recently performed.

Renvoie:
string The task that is being performed or was most recently performed.
Depuis:
12.2

Définition à la ligne 804 du fichier legacy.php.

{
return $this->task;
}
JControllerLegacy::getTasks ( )

Gets the available tasks in the controller.

Renvoie:
array Array[i] of task names.
Depuis:
12.2

Définition à la ligne 816 du fichier legacy.php.

{
return $this->methods;
}
JControllerLegacy::getView (   $name = '',
  $type = '',
  $prefix = '',
  $config = array() 
)

Method to get a reference to the current view and load it if necessary.

Paramètres:
string$nameThe view name. Optional, defaults to the controller name.
string$typeThe view type. Optional.
string$prefixThe class prefix. Optional.
array$configConfiguration array for view. Optional.
Renvoie:
JViewLegacy Reference to the view or an error.
Depuis:
12.2
Exceptions:
Exception

Définition à la ligne 834 du fichier legacy.php.

Références JText\sprintf().

{
static $views;
if (!isset($views))
{
$views = array();
}
if (empty($name))
{
$name = $this->getName();
}
if (empty($prefix))
{
$prefix = $this->getName() . 'View';
}
if (empty($views[$name]))
{
if ($view = $this->createView($name, $prefix, $type, $config))
{
$views[$name] = & $view;
}
else
{
throw new Exception(JText::sprintf('JLIB_APPLICATION_ERROR_VIEW_NOT_FOUND', $name, $type, $prefix), 500);
}
}
return $views[$name];
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::holdEditId (   $context,
  $id 
)
protected

Method to add a record ID to the edit list.

Paramètres:
string$contextThe context for the session storage.
integer$idThe ID of the record to add to the edit list.
Renvoie:
void
Depuis:
12.2

Définition à la ligne 878 du fichier legacy.php.

Références JLog\add(), JFactory\getApplication(), et JLog\INFO.

{
$app = JFactory::getApplication();
$values = (array) $app->getUserState($context . '.id');
// Add the id to the list if non-zero.
if (!empty($id))
{
array_push($values, (int) $id);
$values = array_unique($values);
$app->setUserState($context . '.id', $values);
if (defined('JDEBUG') && JDEBUG)
{
JLog::add(
sprintf(
'Holding edit ID %s.%s %s',
$context,
$id,
str_replace("\n", ' ', print_r($values, 1))
),
JLog::INFO,
'controller'
);
}
}
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::redirect ( )

Redirects the browser or returns false if no redirect is set.

Renvoie:
boolean False if no redirect exists.
Depuis:
12.2

Définition à la ligne 913 du fichier legacy.php.

Références JFactory\getApplication().

{
if ($this->redirect)
{
$app = JFactory::getApplication();
// Enqueue the redirect message
$app->enqueueMessage($this->message, $this->messageType);
// Execute the redirect
$app->redirect($this->redirect);
}
return false;
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::registerDefaultTask (   $method)

Register the default task to perform if a mapping is not found.

Paramètres:
string$methodThe name of the method in the derived class to perform if a named task is not found.
Renvoie:
JControllerLegacy A JControllerLegacy object to support chaining.
Depuis:
12.2

Définition à la ligne 938 du fichier legacy.php.

{
$this->registerTask('__default', $method);
return $this;
}
JControllerLegacy::registerTask (   $task,
  $method 
)

Register (map) a task to a method in the class.

Paramètres:
string$taskThe task.
string$methodThe name of the method in the derived class to perform for this task.
Renvoie:
JControllerLegacy A JControllerLegacy object to support chaining.
Depuis:
12.2

Définition à la ligne 955 du fichier legacy.php.

{
if (in_array(strtolower($method), $this->methods))
{
$this->taskMap[strtolower($task)] = $method;
}
return $this;
}
JControllerLegacy::releaseEditId (   $context,
  $id 
)
protected

Method to check whether an ID is in the edit list.

Paramètres:
string$contextThe context for the session storage.
integer$idThe ID of the record to add to the edit list.
Renvoie:
void
Depuis:
12.2

Définition à la ligne 991 du fichier legacy.php.

Références JLog\add(), JFactory\getApplication(), et JLog\INFO.

{
$app = JFactory::getApplication();
$values = (array) $app->getUserState($context . '.id');
// Do a strict search of the edit list values.
$index = array_search((int) $id, $values, true);
if (is_int($index))
{
unset($values[$index]);
$app->setUserState($context . '.id', $values);
if (defined('JDEBUG') && JDEBUG)
{
JLog::add(
sprintf(
'Releasing edit ID %s.%s %s',
$context,
$id,
str_replace("\n", ' ', print_r($values, 1))
),
JLog::INFO,
'controller'
);
}
}
}

+ Voici le graphe d'appel pour cette fonction :

JControllerLegacy::setMessage (   $text,
  $type = 'message' 
)

Sets the internal message that is passed with a redirect

Paramètres:
string$textMessage to display on redirect.
string$typeMessage type. Optional, defaults to 'message'.
Renvoie:
string Previous message
Depuis:
12.2

Définition à la ligne 1030 du fichier legacy.php.

{
$previous = $this->message;
$this->message = $text;
$this->messageType = $type;
return $previous;
}
JControllerLegacy::setPath (   $type,
  $path 
)
protected

Sets an entire array of search paths for resources.

Paramètres:
string$typeThe type of path to set, typically 'view' or 'model'.
string$pathThe new set of search paths. If null or false, resets to the current directory only.
Renvoie:
void
Note:
Replaces _setPath.
Depuis:
12.2

Définition à la ligne 1050 du fichier legacy.php.

{
// Clear out the prior search dirs
$this->paths[$type] = array();
// Actually add the user-specified directories
$this->addPath($type, $path);
}
JControllerLegacy::setRedirect (   $url,
  $msg = null,
  $type = null 
)

Set a URL for browser redirection.

Paramètres:
string$urlURL to redirect to.
string$msgMessage to display on redirect. Optional, defaults to value set internally by controller, if any.
string$typeMessage type. Optional, defaults to 'message' or the type set by a previous call to setMessage.
Renvoie:
JControllerLegacy This object to support chaining.
Depuis:
12.2

Définition à la ligne 1070 du fichier legacy.php.

{
$this->redirect = $url;
if ($msg !== null)
{
// Controller may have set this directly
$this->message = $msg;
}
// Ensure the type is not overwritten by a previous call to setMessage.
if (empty($type))
{
if (empty($this->messageType))
{
$this->messageType = 'message';
}
}
// If the type is explicitly set, set it.
else
{
$this->messageType = $type;
}
return $this;
}
JControllerLegacy::unregisterTask (   $task)

Unregister (unmap) a task in the class.

Paramètres:
string$taskThe task.
Renvoie:
JControllerLegacy This object to support chaining.
Depuis:
12.2

Définition à la ligne 974 du fichier legacy.php.

{
unset($this->taskMap[strtolower($task)]);
return $this;
}

Documentation des données membres

JControllerLegacy::$basePath
protected

Définition à la ligne 31 du fichier legacy.php.

JControllerLegacy::$default_view
protected

Définition à la ligne 39 du fichier legacy.php.

JControllerLegacy::$doTask
protected

Définition à la ligne 48 du fichier legacy.php.

JControllerLegacy::$input
protected

Définition à la ligne 136 du fichier legacy.php.

JControllerLegacy::$instance
staticprotected

Définition à la ligne 144 du fichier legacy.php.

JControllerLegacy::$message
protected

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

JControllerLegacy::$messageType
protected

Définition à la ligne 66 du fichier legacy.php.

JControllerLegacy::$methods
protected

Définition à la ligne 75 du fichier legacy.php.

JControllerLegacy::$model_prefix
protected

Définition à la ligne 92 du fichier legacy.php.

JControllerLegacy::$name
protected

Définition à la ligne 84 du fichier legacy.php.

JControllerLegacy::$paths
protected

Définition à la ligne 101 du fichier legacy.php.

JControllerLegacy::$redirect
protected

Définition à la ligne 110 du fichier legacy.php.

JControllerLegacy::$task
protected

Définition à la ligne 119 du fichier legacy.php.

JControllerLegacy::$taskMap
protected

Définition à la ligne 128 du fichier legacy.php.

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