Download the PHP package ingenerator/kohana-view without Composer

kohana-view provides separation of view logic and templating for PHP applications. It's designed to be used with the Kohana framework - but you should be able to use it with most PHP projects with a little work.

For legacy projects, it can coexist with the standard Kohana View class, but it is not in any way compatible - each view needs to use either the stock View or be updated to work with kohana-view. In particular, there are significant differences in how we approach page layout views compared to the stock Kohana Controller_Template.

Why you should use it

• Class-based views keep logic out of your controllers, and out of your templates
• Easier to find and update all the display logic in your application
• Easier to customise display logic for modules, configurable sections of applications, etc
• Make the dependencies of each View more obvious and easier to maintain
• Automatically escape all view variables when output as HTML (by default, can be disabled)
• Clean, well-structured code with no global state is easier to test and less at risk of error
• Fully unit tested

Installation

Install with composer: $> composer require ingenerator/kohana-view

Add to your application/bootstrap.php:

We also recommend using a dependency injection container / service container to manage all the dependencies in your project. Kohana-view doesn't require one in particular, but comes with configuration for zeelot/kohana-dependencies. Examples in this readme assume you're using that container, so if you're using something else (really, don't try and do it all inline in PHP) then fetch dependencies from your container however required.

Caching ViewModel schemas

The library needs to parse your AbstractViewModel classes to validate the variables passed to display (see below).

While it will work "out of the box", we strongly recommend registering a suitable psr/cache implementation to avoid any performance issues from the use of Reflection at runtime. For example, you could composer require symfony/cache and add something like this to your bootstrap:

Creating your first view

Each view starts with a class implementing the Ingenerator\KohanaView\ViewModel interface. You can roll your own, or extend from Ingenerator\KohanaView\ViewModel\AbstractViewModel for a base class with some useful common functionality. View classes can be named anything you like, with or without namespaces, whatever.

Each view class has a corresponding template - by default the template name is mapped from the class name but you can customise this.

To render this view in a controller response you'd do something like this:

Template mapping

All templates are loaded from the /views path in the Cascading File System, using the same rules as the rest of Kohana to select the appropriate version when a template is present in one or more modules/application directories.

By default, the template is selected based on the name of the view class. Namespace separators and underscores become directory separators, CamelCased words become under_scored, and View/ViewModel is stripped from beginning and end. For example:

If you want to customise this globally you can provide an alternate implementation of the ViewTemplateSelector class used by the TemplateManager.

Sometimes, however, you just want to customise it for a single view - either because the default mapping isn't ideal for some reason or because the template depends on the result of some view logic. In that case you can implement the TemplateSpecifyingViewModel interface on your ViewModel and explicitly tell the rendering engine which template to use.

Page Layout / Page Content

Kohana-view provides out-of-the-box support for the common case where you have a number of page content views that you want to render within a (or possibly a chain of) containing page layout view(s). This is similar to Kohana's stock Controller_Template, except that it supports a recursive rendering model where each view can be contained in another up to the final overall site template.

For example, this would allow you to have a set of content-area views, a view that renders any of these content areas inside a layout with a sidebar and a main area, and a further parent view that renders your overall page header/footer/ etc. As with the old Controller_Template, for AJAX requests the renderer by default only renders the content-area view and not any of the containing template(s) - this can be customised. This also means you can have your controller extend any arbitrary base class.

To use PageLayoutRenderer you need a minimum of two views - one implementing NestedChildView and one implementing NestedParentView.

You may want to extend from the provided AbstractIntermediateLayoutView, AbstractPageContentView and AbstractPageLayoutView - though this is in no way compulsory.

Advanced examples

display() properties and default variables

Anything that extends AbstractViewModel will enforce that the array passed to AbstractViewModel->display() contains values for all properties that are "view model properties". This is to ensure that the view model is always in the correct state even if it is rendered multiple times (as often happens with partials and sub-views).

By default, these are any properties that are:

• public (at least for reading)
• not promoted properties from the class constructor
• do not have property hooks

You can customise this by tagging properties with one of the DisplayVariableAttribute attributes.

You can also use a DisplayVariableAttribute to mark that a property can be passed into display() but can also be left with a default value. The default will be reassigned on every call to ->display() to ensure that the property is always in expected state.

Caching variables

You may have a computed view variable (e.g. from a property hook) that you only want to recompute if the underlying view data has changed. Views that extend AbstractViewModel can solve this with the ->getCached() helper method.

The variables array is cleared with every call to display, so values cached in this way will be cleared every time you provide new view data (eg if rendering a view in a loop).

Rendering nested views (partials)

The containing view model should expose a reference to the view model for the partial, which might be passed in as a constructor dependency, created by a dynamic variable method, or injected in some other way.

View models don't have any reference to the renderer, so they cannot render the partial directly. Instead, this happens when the template is rendered. The simplest way to do this is to simply <?=$view->child_view;?> - this will automatically detect that the child_view is a ViewModel instance and render it.

Alternatively, the current Renderer is provided as the $renderer variable inside the template scope, allowing you to call $renderer->render() yourself.

For example:

Configuring whether or not templates are compiled

The template engine automatically compiles your source templates to add the auto-escaping functionality. Compiled templates are cached on disk for future executions. By default, they are cached within the Kohana::$cache directory

• alongside your autoloader cache etc - which we recommend should be flushed on every deployment.

The template manager will always compile templates if they don't exist on disk. However, you can also configure it to compile on every request - useful in development.

If you are using the default dependency container then these options are configured for you, including setting recompile_always = (Kohana::$environemnt === Kohana::DEVELOPMENT). You can adjust these settings by adding custom configuration in application/config/kohanaview.php - see config/kohanaview.php for the defaults.

If you are using your own service container you should configure the $options argument to your CFSTemplateManager accordingly.

Credits

This package is heavily inspired by dyron/kohana-view which itself is a fork of zombor/View-Model but as of version 2.x has been fully rewritten for a cleaner and more separated structure using a test-first approach. Thanks and credit to @zombor, @dyron, @nanodocumet and @slacker for their various contributions to the original packages.

The 2.x version of this package has been sponsored by inGenerator Ltd

Contributing

Contributions are very welcome. Please ensure that you follow our coding style, add tests for every change, and avoid introducing global state or excessive dependencies. For major or API breaking changes please discuss your idea with us in an issue first so we can work with you to understand the issue and find a way to resolve it that suits current and future users.

Bug fixes should branch off from the earliest (>=2.0) version where they are relevant and we will merge them up as required. New features should branch off from the development branch of the current version.

Licence

Licensed under the BSD-3-Clause Licence