/
View Hook Module

View Hook Module

Owned by Maciej Szczytowski (Unlicensed)
Last updated: May 05, 2011 by Michal Nawalany (Unlicensed)Version comment

Overview

This module is used for defining new view's hook. Please see also articles describing hook definition.

Module's schema is defined in view.xsd.

Attributes

name

type

required

description

plugin

string

yes

Name of the plugin where the view belongs.

view

string

yes

Name of the view where the component belongs.

type

string

yes

Type of the hook.

class

string

yes

Name of the class where the listener is defined.

method

string

yes

Name of the listener's method.

Example

Please find below an example of plugin defining one view's hook. Lines 8 contains a module which defines new beforeRender view's hook for view sampleView which belongs to samplePlugin. Hook is defined in class com.sample.SampleHook in method invoke.

<?xml version="1.0" encoding="UTF-8"?>
<plugin plugin="samplePlugin" version="1.0.0" 
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
    xmlns="http://schema.qcadoo.org/plugin" 
    xmlns:view="http://schema.qcadoo.org/modules/view" 
    xsi:schemaLocation="http://schema.qcadoo.org/plugin http://schema.qcadoo.org/plugin.xsd http://schema.qcadoo.org/modules/view http://schema.qcadoo.org/modules/view.xsd">

    <view:view-hook plugin="otherPlugin" view="sampleView" type="beforeRender" class="com.sample.SampleHook" method="invoke" />

</plugin>