Info

About 4 min

Info

Class Info.

This class extends the Action class and is responsible for displaying the information page.

Full name: \Hazaar\Controller\Info
Parent class: \Hazaar\Controller\Action

Methods

index

Displays the information page.

public index(): void

This method sets the layout to '@views/info' and populates the view with the current version of the application and the time taken since the start of the application in milliseconds.

Inherited methods

__construct

Base controller constructor.

public __construct(?string $name = null): mixed

Parameters:

Parameter	Type	Description
`$name`	?string	The name of the controller. This is the name used when generating URLs.

__toString

Convert the controller object into a string.

public __toString(): string

__get

Get the specified helper object.

public __get(string $helper): ?\Hazaar\Controller\Helper

Parameters:

Parameter	Type	Description
`$helper`	string	the name of the helper

initialize

Initializes the controller action with the given request.

public initialize(\Hazaar\Application\Request $request): null|\Hazaar\Controller\Response

This method checks if the request is an instance of HTTP, is not an XMLHttpRequest, the application is not null, the response type is 'html', and the application configuration has a 'layout' setting. If all these conditions are met, it sets the view layout to the specified layout in the application configuration.

Parameters:

Parameter	Type	Description
`$request`	\Hazaar\Application\Request	the request object to initialize the action with

Return Value:

the response from the parent initialize method, or null

run

public run(?\Hazaar\Application\Route $route = null): \Hazaar\Controller\Response

Parameters:

Parameter	Type	Description
`$route`	?\Hazaar\Application\Route

runAction

Executes the specified action and returns the response.

public runAction(string $actionName, array $actionArgs = [], bool $namedActionArgs = false): \Hazaar\Controller\Response

Parameters:

Parameter	Type	Description
`$actionName`	string	the name of the action to execute
`$actionArgs`	array	the arguments to pass to the action
`$namedActionArgs`	bool	whether the action arguments are named

Return Value:

the response generated by the action

Throws:

if the response is invalid

ResponseInvalid

shutdown

final public shutdown(\Hazaar\Controller\Response $response): void

This method is final.

Parameters:

Parameter	Type	Description
`$response`	\Hazaar\Controller\Response

getName

Get the name of the controller.

public getName(): string

setStatus

Set the default return status code.

public setStatus(?int $code = null): void

Parameters:

Parameter	Type	Description
`$code`	?int

getStatus

Get the status code of the controller.

public getStatus(): int

getBasePath

Get the base path of the controller.

public getBasePath(): string

setBasePath

Set the base path for the controller.

public setBasePath(string $path): void

Parameters:

Parameter	Type	Description
`$path`	string

redirect

Generate a redirect response to redirect the browser.

public redirect(string $location, bool $saveURI = false): \Hazaar\Controller\Response\HTTP\Redirect

It's quite common to redirect the user to an alternative URL. This may be to forward the request to another website, forward them to an authentication page or even just remove processed request parameters from the URL to neaten the URL up.

Parameters:

Parameter	Type	Description
`$location`	string	The URI you want to redirect to
`$saveURI`	bool	Optionally save the URI so we can redirect back. See: `Hazaar\Application::redirectBack()`

redirectBack

Redirect back to a URI saved during redirection.

public redirectBack(?string $altURL = null): false|\Hazaar\Controller\Response\HTTP\Redirect

This mechanism is used with the $saveURI parameter of Hazaar\Application::redirect() so save the current URI into the session so that once we're done processing the request somewhere else we can come back to where we were. This is useful for when a user requests a page but isn't authenticated, we can redirect them to a login page and then that page can call this Hazaar\Application::redirectBack() method to redirect the user back to the page they were originally looking for.

Parameters:

Parameter	Type	Description
`$altURL`	?string

getURL

Generate a URL relative to the controller.

public getURL(): \Hazaar\Application\URL

This is the controller relative method for generating URLs in your application. URLs generated from here are relative to the controller. For URLs that are relative to the current application see Hazaar\Application::url().

Parameters are dynamic and depend on what you are trying to generate.

For examples see: Generating URLs

addHelper

Add a helper to the controller.

public addHelper((\Hazaar\Controller\Helper|string)[]|\Hazaar\Controller\Helper|string $helper, array $args = [], string $alias = null): bool

Parameters:

Parameter	Type	Description
`$helper`	(\Hazaar\Controller\Helper\|string)[]\|\Hazaar\Controller\Helper\|string	The helper to add to the controller. This can be a helper object, a helper class name or an array of helpers.
`$args`	array	an array of arguments to pass to the helper constructor
`$alias`	string	The alias to use for the helper. If not provided, the helper name will be used.

hasHelper

Checks if a helper exists.

public hasHelper(string $helper): bool

Parameters:

Parameter	Type	Description
`$helper`	string	the name of the helper to check

cacheAction

public cacheAction(string $actionName, int $timeout = 60, bool $private = false): bool

Parameters:

Parameter	Type	Description
`$actionName`	string
`$timeout`	int
`$private`	bool

findHelper

Find a helper class by name.

private findHelper(string $name): ?string

This method searches for view helper classes based on the given name. The search order is important because it allows apps to override built-in helpers.

Parameters:

Parameter	Type	Description
`$name`	string	the name of the helper class to find

getCacheKey

Get the cache key for the current action.

private getCacheKey(string $controller, string $action, array $actionArgs = null, null|string& $cacheName = null): false|string

Parameters:

Parameter	Type	Description
`$controller`	string	the controller name
`$action`	string	the action name
`$actionArgs`	array	the action arguments
`$cacheName`	null\|string	the cache name

cacheResponse

private cacheResponse(\Hazaar\Application\Route $route, \Hazaar\Controller\Response $response): bool

Parameters:

Parameter	Type	Description
`$route`	\Hazaar\Application\Route
`$response`	\Hazaar\Controller\Response

getCachedResponse

private getCachedResponse(\Hazaar\Application\Route $route): ?\Hazaar\Controller\Response

Parameters:

Parameter	Type	Description
`$route`	\Hazaar\Application\Route

stream

Sends a stream response to the client.

public stream(array|string $value): bool

This method sends a stream response to the client, allowing the client to download the response as a file. It sets the necessary headers for the response and flushes the output buffer to ensure the response is sent immediately.

Parameters:

Parameter	Type	Description
`$value`	array\|string	The value to be streamed. If an array is provided, it will be converted to a JSON string before streaming.

Return Value:

returns true if the stream response was successfully sent, false otherwise

init

protected init(\Hazaar\Application\Request $request): void

Parameters:

Parameter	Type	Description
`$request`	\Hazaar\Application\Request

initResponse

protected initResponse(\Hazaar\Application\Request $request): ?\Hazaar\Controller\Response

Parameters:

Parameter	Type	Description
`$request`	\Hazaar\Application\Request

registerMethod

Registers a new method with the given name and callback.

public registerMethod(string $name, callable $callback): bool

Parameters:

Parameter	Type	Description
`$name`	string	the name of the method to register
`$callback`	callable	the callback function to associate with the method

Return Value:

returns true if the method was successfully registered

Throws:

if a method with the given name already exists

MethodExists

view

Loads a view.

protected view(string $view): void

Parameters:

Parameter	Type	Description
`$view`	string	the name of the view to load

layout

Sets the layout view for the current controller.

protected layout(string $view): void

This method sets the layout view that will be used to render the response.

Parameters:

Parameter	Type	Description
`$view`	string	the name of the layout view to be used

Automatically generated on 2024-11-14