\MenusControllerMenu
The Menu Type Controller
Synopsis
class MenusControllerMenu
extends JControllerForm
{
- // Inherited members from JControllerForm
- protected $context;
- protected $option;
- protected $view_item;
- protected $view_list;
- protected $text_prefix;
- // Inherited members from JControllerLegacy
- protected $basePath;
- protected $default_view;
- protected $doTask;
- protected $message;
- protected $messageType;
- protected $methods;
- protected $name;
- protected $model_prefix;
- protected $paths;
- protected $redirect;
- protected $task;
- protected $taskMap;
- protected JInput $input;
- protected JControllerLegacy $instance;
- // Inherited members from JObject
- protected $_errors;
- // Inherited methods from JControllerForm
- public void __construct()
- public mixed add()
- protected boolean allowAdd()
- protected boolean allowEdit()
- protected boolean allowSave()
- public boolean batch()
- public boolean cancel()
- public boolean edit()
- public getModel()
- protected string getRedirectToItemAppend()
- protected string getRedirectToListAppend()
- protected void postSaveHook()
- public mixed loadhistory()
- public boolean save()
- // Inherited methods from JControllerLegacy
- public static void addModelPath()
- protected static string createFileName()
- public static JControllerLegacy getInstance()
- public void __construct()
- protected JControllerLegacy addPath()
- public JControllerLegacy addViewPath()
- public boolean authorise()
- protected boolean checkEditId()
- protected mixed createModel()
- protected mixed createView()
- public JControllerLegacy display()
- public mixed execute()
- public getModel()
- public string getName()
- public string getTask()
- public array getTasks()
- public JViewLegacy getView()
- protected void holdEditId()
- public boolean redirect()
- public JControllerLegacy registerDefaultTask()
- public JControllerLegacy registerTask()
- public JControllerLegacy unregisterTask()
- protected void releaseEditId()
- public string setMessage()
- protected void setPath()
- public JControllerLegacy setRedirect()
- // Inherited methods from JObject
- public void __construct()
- public string __toString()
- public mixed def()
- public mixed get()
- public array getProperties()
- public string getError()
- public array getErrors()
- public mixed set()
- public boolean setProperties()
- public void setError()
Hierarchy
Extends
Tasks
Tasks
Line | Task |
---|---|
107 | Probably worth moving to an inflector class based on |
Members
protected
- $_errors
—
array
An array of error messages or Exception objects. - $basePath
—
string
The base path of the controller - $context
—
string
The context for storing internal data, e.g. record. - $default_view
—
string
The default view for the display method. - $doTask
—
string
The mapped task that was performed. - $input
—
JInput
Hold a JInput object for easier access to the input variables. - $instance
—
JControllerLegacy
Instance container. - $message
—
string
Redirect message. - $messageType
—
string
Redirect message type. - $methods
—
array
Array of class methods - $model_prefix
—
string
The prefix of the models - $name
—
array
The name of the controller - $option
—
string
The URL option for the component. - $paths
—
array
The set of search directories for resources (views). - $redirect
—
string
URL for redirection. - $task
—
string
Current or most recently performed task. - $taskMap
—
array
Array of class methods to call for a given task. - $text_prefix
—
string
The prefix to use with controller messages. - $view_item
—
string
The URL view item variable. - $view_list
—
string
The URL view list variable.
Methods
public
- display() — Dummy method to redirect back to standard controller
- save() — Method to save a menu item.
Inherited from JControllerForm
protected
- allowAdd() — Method to check if you can add a new record.
- allowEdit() — Method to check if you can add a new record.
- allowSave() — Method to check if you can save a new or existing record.
- getRedirectToItemAppend() — Gets the URL arguments to append to an item redirect.
- getRedirectToListAppend() — Gets the URL arguments to append to a list redirect.
- postSaveHook() — Function that allows child controller access to model data after the data has been saved.
public
- add() — Method to add a new record.
- batch() — Method to run batch operations.
- cancel() — Method to cancel an edit.
- edit() — Method to edit an existing record.
- getModel() — Method to get a model object, loading it if required.
- loadhistory() — Method to load a row from version history
- save() — Method to save a record.
Inherited from JControllerLegacy
protected
- addPath() — Adds to the search path for templates and resources.
- checkEditId() — Method to check whether an ID is in the edit list.
- createFileName() — Create the filename for a resource.
- createModel() — Method to load and return a model object.
- createView() — 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.
- holdEditId() — Method to add a record ID to the edit list.
- releaseEditId() — Method to check whether an ID is in the edit list.
- setPath() — Sets an entire array of search paths for resources.
public
- addModelPath() — Adds to the stack of model paths in LIFO order.
- addViewPath() — Add one or more view paths to the controller's stack, in LIFO order.
- display() — Typical view method for MVC based architecture
- execute() — Execute a task by triggering a method in the derived class.
- getInstance() — Method to get a singleton controller instance.
- getModel() — Method to get a model object, loading it if required.
- getName() — Method to get the controller name
- getTask() — Get the last task that is being performed or was most recently performed.
- getTasks() — Gets the available tasks in the controller.
- getView() — Method to get a reference to the current view and load it if necessary.
- redirect() — Redirects the browser or returns false if no redirect is set.
- registerDefaultTask() — Register the default task to perform if a mapping is not found.
- registerTask() — Register (map) a task to a method in the class.
- setMessage() — Sets the internal message that is passed with a redirect
- setRedirect() — Set a URL for browser redirection.
- unregisterTask() — Unregister (unmap) a task in the class.
Inherited from JObject
public
- __toString() — Magic method to convert the object to a string gracefully.
- def() — Sets a default value if not alreay assigned
- get() — Returns a property of the object or the default value if the property is not set.
- getError() — Get the most recent error message.
- getErrors() — Return all errors, if any.
- getProperties() — Returns an associative array of object properties.
- set() — Modifies a property of the object, creating it if it does not already exist.
- setError() — Add an error message.
- setProperties() — Set the object properties based on a named array/hash.