|
| __construct (Input $input=null, Registry $config=null, WebClient $client=null, Container $container=null) |
|
| checkSession () |
|
| enqueueMessage ($msg, $type=self::MSG_INFO) |
|
| getCfg ($varname, $default=null) |
|
| getClientId () |
|
| getMenu ($name=null, $options=array()) |
|
| getMessageQueue ($clear=false) |
|
| getName () |
|
| getPathway () |
|
| getTemplate ($params=false) |
|
| getUserState ($key, $default=null) |
|
| getUserStateFromRequest ($key, $request, $default=null, $type='none') |
|
| isHttpsForced ($clientId=null) |
|
| isClient ($identifier) |
|
| login ($credentials, $options=array()) |
|
| logout ($userid=null, $options=array()) |
|
| redirect ($url, $status=303) |
|
| setUserState ($key, $value) |
|
| toString ($compress=false) |
|
| isCli () |
|
| setMenuFactory (MenuFactoryInterface $menuFactory) |
|
| __construct (Input $input=null, Registry $config=null, WebClient $client=null, ResponseInterface $response=null) |
|
| execute () |
|
| getDocument () |
|
| getLanguage () |
|
| flushAssets () |
|
| loadDocument (Document $document=null) |
|
| loadLanguage (Language $language=null) |
|
| loadSession (Session $session=null) |
|
| afterSessionStart (SessionEvent $event) |
|
| getConfig () |
|
| __construct (Input $input=null, Registry $config=null, Web\WebClient $client=null, ResponseInterface $response=null) |
|
| __get ($name) |
|
| execute () |
|
| getInput () |
|
| redirect ($url, $status=303) |
|
| allowCache ($allow=null) |
|
| setHeader ($name, $value, $replace=false) |
|
| getHeaders () |
|
| clearHeaders () |
|
| sendHeaders () |
|
| setBody ($content) |
|
| prependBody ($content) |
|
| appendBody ($content) |
|
| getBody () |
|
| getResponse () |
|
| isValidHttpStatus ($code) |
|
| setResponse (ResponseInterface $response) |
|
| isSslConnection () |
|
| __construct (Registry $config=null) |
|
| close ($code=0) |
|
| execute () |
|
| get ($key, $default=null) |
|
| getLogger () |
|
| set ($key, $value=null) |
|
| setConfiguration (Registry $config) |
|
| setLogger (LoggerInterface $logger) |
|
| setDispatcher (DispatcherInterface $dispatcher) |
|
| setContainer (Container $container) |
|
| getDocument () |
|
| getSession () |
|
| setSession (SessionInterface $session) |
|
| checkToken ($method='post') |
|
| getFormToken ($forceNew=false) |
|
| getMessageQueue () |
|
| getIdentity () |
|
| getInput () |
|
| getLanguage () |
|
| loadIdentity (User $identity=null) |
|
| bootComponent ($component) |
|
| bootModule ($module, $applicationName) |
|
| bootPlugin ($plugin, $type) |
|
| getDispatcher () |
|
| triggerEvent ($eventName, $args=[]) |
|
Joomla! CMS Application class
- Depuis
- 3.2
checkUserRequireReset |
( |
|
$option, |
|
|
|
$view, |
|
|
|
$layout, |
|
|
|
$tasks |
|
) |
| |
|
protected |
Check if the user is required to reset their password.
If the user is required to reset their password will be redirected to the page that manage the password reset.
- Paramètres
-
string | $option | The option that manage the password reset |
string | $view | The view that manage the password reset |
string | $layout | The layout of the view that manage the password reset |
string | $tasks | Permitted tasks |
- Renvoie
- void
- Exceptions
-
Références $layout, $name, $option, $task, $url, $user, $view, Text\_(), Route\_(), Factory\getApplication(), et Factory\getUser().
static getInstance |
( |
|
$name = null , |
|
|
|
$prefix = '\JApplication' , |
|
|
Container |
$container = null |
|
) |
| |
|
static |
Returns a reference to the global CmsApplication object, only creating it if it doesn't already exist.
This method must be invoked as: $web = CmsApplication::getInstance();
- Paramètres
-
string | $name | The name (optional) of the CmsApplication class to instantiate. |
string | $prefix | The class name prefix of the object. |
Container | $container | An optional dependency injection container to inject into the application. |
- Renvoie
- CmsApplication
- Depuis
- 3.2
- Exceptions
-
Références $container, $name, $prefix, elseif, Factory\getContainer(), Factory\getUser(), null, et Text\sprintf().
login |
( |
|
$credentials, |
|
|
|
$options = array() |
|
) |
| |
Login authentication function.
Username and encoded password are passed the onUserLogin event which is responsible for the user validation. A successful validation updates the current session record with the user's details.
Username and encoded password are sent as credentials (along with other possibilities) to each observer (authentication plugin) for user validation. Successful validation will update the current session with the user details.
- Paramètres
-
array | $credentials | Array('username' => string, 'password' => string) |
array | $options | Array('remember' => boolean) |
- Renvoie
- boolean| True on success, false if failed or silent handling is configured, or a object on authentication error.
- Depuis
- 3.2
Références $options, $results, $user, Text\_(), Factory\getApplication(), Authentication\getInstance(), Joomla\CMS\Application\getLogger(), Factory\getUser(), PluginHelper\importPlugin(), Authentication\STATUS_DENIED, Authentication\STATUS_EXPIRED, Authentication\STATUS_SUCCESS, et Joomla\CMS\Application\triggerEvent().
logout |
( |
|
$userid = null , |
|
|
|
$options = array() |
|
) |
| |
Logout authentication function.
Passed the current user information to the onUserLogout event and reverts the current session record back to 'anonymous' parameters. If any of the authentication plugins did not successfully complete the logout routine then the whole method fails. Any errors raised should be done in the plugin as this provides the ability to give much more information about why the routine may have failed.
- Paramètres
-
integer | $userid | The user to load - Can be an integer or string - If string, it is converted to ID automatically |
array | $options | Array('clientid' => array of client id's) |
- Renvoie
- boolean True on success
- Depuis
- 3.2
Références $options, $parameters, $results, $user, Factory\getUser(), PluginHelper\importPlugin(), et Joomla\CMS\Application\triggerEvent().
Route the application.
Routing is the process of examining the request environment to determine which component should receive the request. The component optional parameters are then set in the request object to be processed when the application is being dispatched.
- Renvoie
- void
- Depuis
- 3.2
- Obsolète:
- 5.0 Implement the route functionality in the extending class, this here will be removed without replacement
Références $active, $base, $item, $key, $position, $result, $uri, $value, Uri\base(), Uri\getInstance(), PluginHelper\importPlugin(), null, StringHelper\strtolower(), et Joomla\CMS\Application\triggerEvent().