PHPackages                             andydune/rzn-view-component - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Templating & Views](/categories/templating)
4. /
5. andydune/rzn-view-component

ActiveLibrary[Templating & Views](/categories/templating)

andydune/rzn-view-component
===========================

View component module for ZF2.

v0.4.0(12y ago)1441MITPHPPHP >=5.4.0

Since Jan 29Pushed 12y ago2 watchersCompare

[ Source](https://github.com/AndyDune/RznViewComponent)[ Packagist](https://packagist.org/packages/andydune/rzn-view-component)[ Docs](https://github.com/AndyDune/RznViewComponent)[ RSS](/packages/andydune-rzn-view-component/feed)WikiDiscussions master Synced 2mo ago

READMEChangelog (5)Dependencies (1)Versions (6)Used By (1)

RznViewComponent
================

[](#rznviewcomponent)

A ZF2 module that add view helper IncludeComponent. Lightweight instrument for insert into the page a finished local block witch implements chain: model-template-cache.

The plugin includes three elements: service, view and cache.

Basic Using
-----------

[](#basic-using)

```

```

#### There are 4 parameters:

[](#there-are-4-parameters)

1. Registered service name.
2. View file name. It point as for view helper "partial"
3. Initial data to betray to service.
4. Local configuration array.

Installation via Composer
-------------------------

[](#installation-via-composer)

### Steps

[](#steps)

#### 1. Add to composer.

[](#1-add-to-composer)

```
    "require" : {
        "andydune/rzn-view-component": "dev-master"
    }

```

#### 2. Copy config file (`rzn-view-component.global.php`) to your application autoload dir if you need to change basic configuration.

[](#2-copy-config-file-rzn-view-componentglobalphp-to-your-application-autoload-dir-if-you-need-to-change-basic-configuration)

#### 3. Add module to application config (/config/application.config.php)

[](#3-add-module-to-application-config-configapplicationconfigphp)

```
   ...
   'modules' => array(
        'RznViewComponent',
   ),
   ...

```

Configuration
-------------

[](#configuration)

Here is basic configuration:

```
return array(
    'rznviewcomponent' => array(
        'cache_service' => 'cache_view_component',
        'cache_adapter' => array(
                                'name' => 'filesystem',
                                'options' => array(
                                    'ttl' => 3600,
                                    'dirLevel' => 2,
                                    'file_locking' => false,
                                    'cacheDir' => 'data/cache',
                                    'dirPermission' => 0755,
                                    'filePermission' => 0666,
                                ),
                            ),
        'cache_remove_item_key' => 'slay_component_cache',
        'cache_allow'   => false, // check cache adapter options and set true to enable component cache
        'view_script_prefix' => '', // not used yet
        'use_result_object' => false
    )
);
```

If you want to make changes copy /module.config.php to /config/autoload/rzn-view-component.global.php or insert part of configuration array into your application config.

### Config parameters

[](#config-parameters)

#### 1. cache\_service

[](#1-cache_service)

Name of cache service. Module has its own desctipted cashe service "cache\_view\_component".You can specify you own service which implements Zend\\Cache\\Storage\\StorageInterface.

#### 2. cache\_adapter

[](#2-cache_adapter)

Configuration array for Zend cache factory. Here is default values.

#### 3. cache\_remove\_item\_key

[](#3-cache_remove_item_key)

Parameter specifies the name of a variable from a query, a positive value which resets the cache component of the current site page. Specify a blank value, if you want to disable this ability.

Example: `http://mymegasite.com/catalog/frogs.html?slay_component_cache=1`

#### 3. use\_result\_object

[](#3-use_result_object)

By default view helper `includeComponent` returns html to show on a site page. If you need helper returns extra data (tile for block, result flag) set `true`. What values component will return you need to define in the fourth parameter of helper. For this purpose use the key `result_key_return`.

Example:

```