Warning: This page has not been updated in over over a year and may be outdated or deprecated.
development:plugins:controllers
Differences
This shows you the differences between two versions of the page.
Both sides previous revisionPrevious revisionNext revision | Previous revisionNext revisionBoth sides next revision | ||
development:plugins:controllers [2015/12/10 18:54] – [Background] demiankatz | development:plugins:controllers [2020/05/12 12:27] – demiankatz | ||
---|---|---|---|
Line 5: | Line 5: | ||
===== Background ===== | ===== Background ===== | ||
- | A full description of Zend Framework 2 controllers is beyond the scope of this page, but in a nutshell: | + | A full description of Laminas |
**Controller workflow:** | **Controller workflow:** | ||
Line 17: | Line 17: | ||
* Each action method in a controller needs to return either data to pass to a view or a response object if a non-standard action (like a redirect) is necessary. | * Each action method in a controller needs to return either data to pass to a view or a response object if a non-standard action (like a redirect) is necessary. | ||
- | Some of the resources on the [[vufind2:zend_framework_2.0|Zend Framework]] page provide more detailed documentation. | + | Some of the resources on the [[development:architecture: |
===== VuFind-Specific Controller Conventions ===== | ===== VuFind-Specific Controller Conventions ===== | ||
Line 30: | Line 30: | ||
To override an existing controller, follow these steps: | To override an existing controller, follow these steps: | ||
- | * Create a [[vufind2:customizing_vufind_2.0# | + | * Create a [[development:architecture: |
- | * Create a new class in your module' | + | * Create a new class in your module' |
- | * In your module' | + | * If you used the code generator, you are now done. If you are setting things up manually, you will also need to add some configuration to activate your new class. |
< | < | ||
- | $config = array( | + | $config = [ |
- | ' | + | ' |
- | 'invokables' => array( | + | 'factories' => [ |
- | 'controllername' => ' | + | 'YourNamespace\Controller\ControllerNameController' |
- | | + | ], |
- | | + | ' |
- | ); | + | ' |
+ | | ||
+ | | ||
+ | ]; | ||
</ | </ | ||
Line 48: | Line 51: | ||
Creating a new controller is much like overriding an existing one. | Creating a new controller is much like overriding an existing one. | ||
- | * As described above, create a custom module, build a new controller, and set up an invokables | + | * As described above, create a custom module, build a new controller, and set up a factory |
- | * Now you need to add routing rules so the framework knows how to find your controller and so you can conveniently link to it within templates. | + | * Now you need to add routing rules so the framework knows how to find your controller and so you can conveniently link to it within templates. |
==== Example - How to add a new page to your theme ==== | ==== Example - How to add a new page to your theme ==== | ||
- | // Note: this example | + | :!: This example |
- | * Create a new controller in /vufindroot/module/ | + | // Note: this example assumes you have set up a [[development: |
- | It extends AbstractBase | + | |
- | class InfoController extends AbstractBase | + | |
- | { | + | |
- | /** | + | |
- | * | + | |
- | * @return \Zend\View\Model\ViewModel | + | |
- | */ | + | |
- | public function homeAction() | + | |
- | { | + | |
- | return $this-> | + | |
- | } | + | |
- | } | + | |
- | | + | |
- | below the ' | + | |
- | add a new | + | |
- | ' | + | |
- | ' | + | |
- | and below | + | |
- | $staticRoutes = array( | + | |
- | add your template filename and path | + | |
- | ' | + | |
- | * Then create in your theme a directory and a file (lowercase) named as in the configuration (e.g. /vufindroot/themes/demovufind/ | + | |
- | * Put your contents in that file. For test you can try with | + | |
- | '' | + | <code php> |
+ | <?php | ||
+ | |||
+ | namespace MyModule\Controller; | ||
+ | |||
+ | class TestController extends \VuFind\Controller\AbstractBase | ||
+ | { | ||
+ | /** | ||
+ | * | ||
+ | * @return \Laminas\View\Model\ViewModel | ||
+ | */ | ||
+ | public function homeAction() | ||
+ | { | ||
+ | return $this-> | ||
+ | } | ||
+ | } | ||
+ | </ | ||
+ | |||
+ | * Now set up a static route to this new controller action like this: | ||
+ | |||
+ | php $VUFIND_HOME/ | ||
+ | |||
+ | | ||
+ | * Put your contents in that file. For example, | ||
+ | |||
+ | <code php> | ||
+ | This is my test page -- it includes a copy of the home page: | ||
+ | <? | ||
+ | </code> | ||
---- struct data ---- | ---- struct data ---- | ||
---- | ---- | ||
development/plugins/controllers.txt · Last modified: 2021/08/03 14:04 by demiankatz