SuggestionboxControllerSuggestionbox

class SuggestionboxControllerSuggestionbox extends JController


Located at : UKNOWVA_ROOT/components/com_suggestionbox/controllers/suggestionbox.php

Methods

JObject
__construct(array $config = array())

Constructor.

from JController
string
__toString()

Magic method to convert the object to a string gracefully.

from JObject
mixed
def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

from JObject
mixed
get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

from JObject
array
getProperties(boolean $public = true)

Returns an associative array of object properties.

from JObject
string
getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

from JObject
array
getErrors()

Return all errors, if any.

from JObject
mixed
set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

from JObject
boolean
setProperties(mixed $properties)

Set the object properties based on a named array/hash.

from JObject
void
setError(string $error)

Add an error message.

from JObject
string
toString() deprecated

No description

from JObject
static void
addModelPath(mixed $path, string $prefix = '')

Adds to the stack of model paths in LIFO order.

from JController
static mixed
getInstance(string $prefix, array $config = array())

Method to get a singleton controller instance.

from JController
JController
addViewPath(mixed $path)

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

from JController
boolean
authorize(string $task) deprecated

Authorisation check

from JController
boolean
authorise(string $task)

Authorisation check

from JController
JController
display(boolean $cachable = false, array $urlparams = false)

Typical view method for MVC based architecture

from JController
mixed
execute(string $task)

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

from JController
object
getModel(string $name = '', string $prefix = '', array $config = array())

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

from JController
string
getName()

Method to get the controller name

from JController
string
getTask()

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

from JController
array
getTasks()

Gets the available tasks in the controller.

from JController
object
getView(string $name = '', string $type = '', string $prefix = '', array $config = array())

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

from JController
boolean
redirect()

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

from JController
JController
registerDefaultTask(string $method)

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

from JController
JController
registerTask(string $task, string $method)

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

from JController
JController
unregisterTask(string $task)

Unregister (unmap) a task in the class.

from JController
void
setAccessControl(string $section, string $value = null) deprecated

Sets the access control levels.

from JController
string
setMessage(string $text, string $type = 'message')

Sets the internal message that is passed with a redirect

from JController
JController
setRedirect(string $url, string $msg = null, string $type = null)

Set a URL for browser redirection.

from JController

Details

in JController at line 292
JObject __construct(array $config = array())

Constructor.

Parameters

array $config An optional associative array of configuration settings. Recognized key values include 'name', 'defaulttask', 'modelpath', and 'view_path' (this list is not meant to be comprehensive).

Return Value

JObject

in JObject at line 56
string __toString()

Magic method to convert the object to a string gracefully.

Return Value

string The classname.

in JObject at line 70
mixed def(string $property, mixed $default = null)

Sets a default value if not alreay assigned

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed

in JObject at line 88
mixed get(string $property, mixed $default = null)

Returns a property of the object or the default value if the property is not set.

Parameters

string $property The name of the property.
mixed $default The default value.

Return Value

mixed The value of the property.

See also

getProperties()

in JObject at line 107
array getProperties(boolean $public = true)

Returns an associative array of object properties.

Parameters

boolean $public If true, returns only the public properties.

Return Value

array

See also

get()

in JObject at line 133
string getError(integer $i = null, boolean $toString = true)

Get the most recent error message.

Parameters

integer $i Option error index.
boolean $toString Indicates if JError objects should return their error message.

Return Value

string Error message

in JObject at line 165
array getErrors()

Return all errors, if any.

Return Value

array Array of error messages or JErrors.

in JObject at line 180
mixed set(string $property, mixed $value = null)

Modifies a property of the object, creating it if it does not already exist.

Parameters

string $property The name of the property.
mixed $value The value of the property to set.

Return Value

mixed Previous value of the property.

in JObject at line 198
boolean setProperties(mixed $properties)

Set the object properties based on a named array/hash.

Parameters

mixed $properties Either an associative array or another object.

Return Value

boolean

See also

set()

in JObject at line 222
void setError(string $error)

Add an error message.

Parameters

string $error Error message.

Return Value

void

in JObject at line 235
string toString() deprecated

deprecated 12.1 Use magic method __toString()

Return Value

string

See also

__toString()

in JController at line 156
static void addModelPath(mixed $path, string $prefix = '')

Adds to the stack of model paths in LIFO order.

Parameters

mixed $path The directory (string), or list of directories (array) to add.
string $prefix A prefix for models

Return Value

void

in JController at line 212
static mixed getInstance(string $prefix, array $config = array())

Method to get a singleton controller instance.

Parameters

string $prefix The prefix for the controller.
array $config An array of optional constructor options.

Return Value

mixed JController derivative class or JException on error.

in JController at line 427
JController addViewPath(mixed $path)

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

Parameters

mixed $path The directory (string) or list of directories (array) to add.

Return Value

JController This object to support chaining.

in JController at line 445
boolean authorize(string $task) deprecated

deprecated 12.1 Use JAuthorise

Authorisation check

Parameters

string $task The ACO Section Value to check access on

Return Value

boolean True if authorised

in JController at line 461
boolean authorise(string $task)

Authorisation check

Parameters

string $task The ACO Section Value to check access on.

Return Value

boolean True if authorised

in JController at line 601
JController display(boolean $cachable = false, array $urlparams = false)

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.

Parameters

boolean $cachable If true, the view output will be cached
array $urlparams An array of safe url parameters and their variable types, for valid values see {@link JFilterInput::clean()}.

Return Value

JController A JController object to support chaining.

in JController at line 664
mixed execute(string $task)

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

Parameters

string $task The task to perform. If no matching task is found, the '__default' task is executed, if defined.

Return Value

mixed The value returned by the called method, false in error case.

in JController at line 702
object getModel(string $name = '', string $prefix = '', array $config = array())

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

Parameters

string $name The model name. Optional.
string $prefix The class prefix. Optional.
array $config Configuration array for model. Optional.

Return Value

object The model.

in JController at line 740
string 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

Return Value

string The name of the dispatcher

in JController at line 761
string getTask()

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

Return Value

string The task that is being performed or was most recently performed.

in JController at line 772
array getTasks()

Gets the available tasks in the controller.

Return Value

array Array[i] of task names.

in JController at line 788
object getView(string $name = '', string $type = '', string $prefix = '', array $config = array())

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

Parameters

string $name The view name. Optional, defaults to the controller name.
string $type The view type. Optional.
string $prefix The class prefix. Optional.
array $config Configuration array for view. Optional.

Return Value

object Reference to the view or an error.

in JController at line 857
boolean redirect()

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

Return Value

boolean False if no redirect exists.

in JController at line 875
JController registerDefaultTask(string $method)

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

Parameters

string $method The name of the method in the derived class to perform if a named task is not found.

Return Value

JController A JController object to support chaining.

in JController at line 891
JController registerTask(string $task, string $method)

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

Parameters

string $task The task.
string $method The name of the method in the derived class to perform for this task.

Return Value

JController A JController object to support chaining.

in JController at line 908
JController unregisterTask(string $task)

Unregister (unmap) a task in the class.

Parameters

string $task The task.

Return Value

JController This object to support chaining.

in JController at line 958
void setAccessControl(string $section, string $value = null) deprecated

deprecated 12.1 Use JAccess

Sets the access control levels.

Parameters

string $section The ACO section (eg, the component).
string $value The ACO section value (if using a constant value).

Return Value

void

See also

Jaccess

in JController at line 973
string setMessage(string $text, string $type = 'message')

Sets the internal message that is passed with a redirect

Parameters

string $text Message to display on redirect.
string $type Message type (since 11.1). Optional, defaults to 'message'.

Return Value

string Previous message

in JController at line 1013
JController setRedirect(string $url, string $msg = null, string $type = null)

Set a URL for browser redirection.

Parameters

string $url URL to redirect to.
string $msg Message to display on redirect. Optional, defaults to value set internally by controller, if any.
string $type Message type. Optional, defaults to 'message' or the type set by a previous call to setMessage.

Return Value

JController This object to support chaining.