Allows dynamic data from modules to be displayed in content zones.
The Views module (
views) allows dynamic data from modules to be displayed in content zones.
Modules usually define three view types:
home view displays a
small number of records on an home page. The
list view displays a list of records and comes with
a pagination to browse through older or newer records. Finally, the
view view displays the
detail of a record.
Icybee\Modules\Views\Collection::collect event of class Collection\CollectEvent is fired
after the views defined by the enabled modules have been collected. Event hooks may used this event
to alter the collection.
Icybee\Modules\Views\View::alter_records:before event of class View\BeforeAlterRecords
is fired before the records fetched by the provider are altered by the
of the view. The
Icybee\Modules\Views\View::alter_records event of class View\AlterRecords
is fired after the
alter_records method was called. Event hooks may use these events to alter the
Updates the target page of a view.
Returns the relative URL of a record for the specified view type.
Returns the URL of a record for the specified view type.
Returns the relative URL of a record.
Returns the URL of a record.
Returns the target page associated with a view.
Returns the URL of a view.
Returns the view collection.
Displays a view.
<h2>Last articles</h2> <p:call-view name="articles/home" />
The package requires PHP 5.5 or later.
The recommended way to install this package is through Composer.
composer.json file and run
php composer.phar install command to install it:
$ composer require icybee/module-views
Note: This module is part of the modules required by Icybee.
The package is available on GitHub, its repository can be cloned with the following command line:
$ git clone https://github.com/Icybee/module-views views
The test suite is ran with the
make test command. Composer is
automatically installed as well as all the dependencies required to run the suite. The package
directory can later be cleaned with the
make clean command.
The package is continuously tested by Travis CI.
The package is documented as part of the Icybee CMS
documentation. The documentation for the package and its
dependencies can be generated with the
make doc command. The documentation is generated in
docs directory using ApiGen. The package directory can later by
cleaned with the
make clean command.
The module is licensed under the New BSD License - See the LICENSE file for details.