$component
$component : \Dewdrop\Admin\Component\ComponentAbstract|\Dewdrop\Admin\Component\CrudInterface
A class other stock pages can extend to allow their view scripts to be used even when a page controller sub-class is present for the page. So, you can add an Index.php to your admin component that extends the stock index but still use the stock index.phtml view script if you don't need a custom view script for your use case.
The stock page controller implements a basic three step execution process:
Sub-classes, such as EditAbstract, can be created that alter this basic page controller flow of execution. EditAbstract, for example, will only call process() if the request is a POST.
$component : \Dewdrop\Admin\Component\ComponentAbstract|\Dewdrop\Admin\Component\CrudInterface
$view : \Dewdrop\View\View
A view object available for rendering. Generally, your page should not be rendering any output directly, but instead passing information from models to the view and then rendering the view.
$request : \Dewdrop\Request
An object representing the current HTTP request. The is primarily around to make it easier to test your pages by injecting POST and GET data into the request object.
__construct(\Dewdrop\Admin\Component\ComponentInterface $component, \Dewdrop\Request $request, string $viewScriptPath = null)
Create a new page with a reference to its component and the file in which it is defined.
Also, by default, the page will be configured to look for view scripts in the view-scripts sub-folder of its component.
\Dewdrop\Admin\Component\ComponentInterface | $component | |
\Dewdrop\Request | $request | |
string | $viewScriptPath |
process(\Dewdrop\Admin\ResponseHelper\Standard $helper)
\Dewdrop\Admin\ResponseHelper\Standard | $helper |
url(string $page, array $params = array()) : string
As the component this page belongs to for a URL matching the provided page and query string parameters. This method should always be used for generating URLs in your components so that it will play nicely with various WP integration points like submenus.
string | $page | |
array | $params |
createResponseHelper(callable $redirector) : \Dewdrop\Admin\ResponseHelper\Standard
Create a response helper object for this page.
If your page would benefit from an alternative response helper with additional methods relevant to your use case, you can override this method and the helper will be injected into the page's process() method rather than the standard helper created in PageAbstract.
callable | $redirector |
getView() : \Dewdrop\View\View
Get a reference to this page's view object.