Skip to content

improve event_listeners #61

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
rudnerbjoern merged 1 commit into from
Jun 17, 2025
Merged

improve event_listeners #61

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions .vscode/settings.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,15 +9,18 @@
"dashlets",
"extkey",
"fileref",
"finalclass",
"Hipska",
"ITSM",
"jointype",
"jqueryui",
"metavalue",
"metavalues",
"mgmt",
"MOVEUP",
"neighbour",
"neighbours",
"networkflow",
"Nihilo",
"noout",
"stylesheet",
Expand Down
46 changes: 40 additions & 6 deletions 3.2/itop_design.xsd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -354,7 +354,7 @@
<xs:element name="event_listener">
<xs:complexType>
<xs:all>
<xs:element name="event" type="xs:string" minOccurs="0" />
<xs:element name="event" type="eventEnumeration" minOccurs="0" />
<xs:element name="callback" type="xs:string" minOccurs="0" />
<xs:element name="code" type="xs:string" minOccurs="0" />
<xs:element name="rank" type="xs:string" minOccurs="0" />
Expand Down Expand Up @@ -1288,12 +1288,22 @@
</xs:element>
<xs:element name="event_listeners" minOccurs="0">
<xs:complexType>
<xs:sequence>
<xs:element name="listener" minOccurs="0" maxOccurs="unbounded">
<xs:sequence minOccurs="0" maxOccurs="unbounded">
<xs:element name="event_listener">
<xs:complexType>
<xs:choice maxOccurs="unbounded">
<xs:any processContents="lax" />
</xs:choice>
<xs:all>
<xs:element name="event" type="eventEnumeration" minOccurs="0" />
<xs:element name="filters" minOccurs="0">
<xs:complexType>
<xs:sequence maxOccurs="unbounded">
<xs:element name="filter" type="alteredString" />
</xs:sequence>
</xs:complexType>
</xs:element>
<xs:element name="rank" type="alteredFloat" minOccurs="0" />
<xs:element name="callback" type="xs:string" minOccurs="0" />
<xs:element name="code" type="xs:string" minOccurs="0" />
</xs:all>
<xs:attribute name="id" type="xs:string" use="required" />
<xs:attributeGroup ref="alteredNode" />
</xs:complexType>
Expand Down Expand Up @@ -1465,6 +1475,30 @@
</xs:sequence>
</xs:complexType>

<xs:simpleType name="eventEnumeration">
<xs:restriction base="xs:string">
<xs:enumeration value="EVENT_DB_COMPUTE_VALUES" />
<xs:enumeration value="EVENT_DB_BEFORE_WRITE" />
<xs:enumeration value="EVENT_DB_ABOUT_TO_DELETE" />
<xs:enumeration value="EVENT_DB_CHECK_TO_WRITE" />
<xs:enumeration value="EVENT_DB_CHECK_TO_DELETE" />
<xs:enumeration value="EVENT_DB_AFTER_WRITE" />
<xs:enumeration value="EVENT_DB_AFTER_DELETE" />
<xs:enumeration value="EVENT_DB_LINKS_CHANGED" />
<xs:enumeration value="EVENT_DB_ARCHIVE" />
<xs:enumeration value="EVENT_DB_UNARCHIVE" />
<xs:enumeration value="EVENT_DB_SET_INITIAL_ATTRIBUTES_FLAGS" />
<xs:enumeration value="EVENT_DB_SET_ATTRIBUTES_FLAGS" />
<xs:enumeration value="EVENT_DB_OBJECT_RELOAD" />
<xs:enumeration value="EVENT_ENUM_TRANSITIONS" />
<xs:enumeration value="EVENT_DISPLAY_OBJECT_DETAILS" />
<xs:enumeration value="EVENT_LOGIN" />
<xs:enumeration value="EVENT_ADD_ATTACHMENT_TO_OBJECT" />
<xs:enumeration value="EVENT_REMOVE_ATTACHMENT_FROM_OBJECT" />
<xs:enumeration value="EVENT_DOWNLOAD_DOCUMENT" />
</xs:restriction>
</xs:simpleType>

<!-- ########################### Stimuli ########################### -->
<xs:complexType name="StimulusBase" abstract="true">
<xs:annotation>
Expand Down
80 changes: 68 additions & 12 deletions test/datamodel.must-validate.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,10 +24,10 @@
<properties>
<is_link>1</is_link>
<comment>Comment</comment>
<category>bizmodel</category>
<category>category</category>
<abstract>false</abstract>
<key_type>autoincrement</key_type>
<db_table>dbtable</db_table>
<db_table>table</db_table>
<db_key_field>id</db_key_field>
<db_final_class_field>finalclass</db_final_class_field>
<naming>
Expand Down Expand Up @@ -180,11 +180,16 @@
</lifecycle>
<event_listeners>
<event_listener id="1">
<event>EVENT_DB_CREATE_DONE</event>
<event>EVENT_DB_BEFORE_WRITE</event>
<callback>callback</callback>
<code>code</code>
<rank>1</rank>
</event_listener>
<event_listener id="OnUserRequestUpdateDone" _delta="define">
<event>EVENT_DB_AFTER_WRITE</event>
<callback>OnUserRequestUpdateDone</callback>
<rank>2</rank>
</event_listener>
</event_listeners>
<methods>
<method id="1">
Expand Down Expand Up @@ -312,11 +317,9 @@
<class id="TestClass2" _delta="define">
<parent>test</parent>
<properties>
<category>bizmodel,searchable</category>
<category>category1,category2</category>
<abstract>false</abstract>

<key_type>autoincrement</key_type>

<db_table>test</db_table>
<db_key_field>id</db_key_field>
<db_final_class_field />
Expand Down Expand Up @@ -434,7 +437,7 @@
<group id="122">
<actions>
<action id="action:read">allow</action>
<action id="stimulus:arch_forrest">allow</action>
<action id="stimulus:ev_done">allow</action>
</actions>
</group>
</groups>
Expand All @@ -449,7 +452,7 @@
<width>37</width>
<height>37</height>
<!-- In tag 'data' provide the image encoded in base 64 -->
<data>iVBORw0KGgoAAAANSUhEUgAAAL...</data>
<data>base64String...</data>
</file>
</files>
<!-- ***************** Dictionaries ***************** -->
Expand Down Expand Up @@ -551,8 +554,8 @@
<report_label>Issued from the request %1$s. The request has been updated.</report_label>
<dest_class>Change</dest_class>
<preset type="array">
<action id="0"> clone(contacts_list,functionalcis_list,org_id,title,caller_id)</action>
<action id="1">set(description,Original description:\n$this->description$)</action>
<action id="0"> clone(...)</action>
<action id="1">set(...)</action>
</preset>
<retrofit type="array">
<action id="0">copy(id, parent_change_id)'</action>
Expand Down Expand Up @@ -600,8 +603,61 @@
</event_datum>
</event_data>
</event>
<event id="event-2" _delta="delete" />
<event id="EVENT_DOWNLOAD_DOCUMENT" _delta="define">
<description>A document has been downloaded from the GUI</description>
<sources>
<source id="Document">Document</source>
</sources>
<event_data>
<event_datum id="object">
<description>The object containing the document</description>
<type>DBObject</type>
</event_datum>
<event_datum id="document">
<description>The document downloaded</description>
<type>ormDocument</type>
</event_datum>
<event_datum id="att_code">
<description>Attribute code of the object, containing the document</description>
<type>string</type>
</event_datum>
<event_datum id="content_disposition">
<description>To differentiate if the document was displayed in preview or truly downloaded</description>
<type>string</type>
</event_datum>
<event_datum id="debug_info">
<description>Debug string</description>
<type>string</type>
</event_datum>
</event_data>
</event>
</events>
<!-- ***************** Event Listeners ***************** -->
<event_listeners />
<event_listeners>
<event_listener id="listener-1">
<event>EVENT_DISPLAY_OBJECT_DETAILS</event>
<filters>
<filter>FAQ</filter>
</filters>
<rank>10</rank>
<code>function(\Combodo\iTop\Service\EventData $oEventData) {}</code>
</event_listener>
<event_listener id="listener-2">
<event>EVENT_DB_COMPUTE_VALUES</event>
<filters>
<filter>FAQ</filter>
</filters>
<rank>20</rank>
<code>function(\Combodo\iTop\Service\EventData $oEventData) {}</code>
</event_listener>
<event_listener id="OnAttachmentDownloadActivateTriggers" _delta="define">
<event>EVENT_DOWNLOAD_DOCUMENT</event>
<filters>
<filter>Attachment</filter>
</filters>
<rank>0</rank>
<code><![CDATA[function(Combodo\iTop\Service\Events\EventData $oEventData){ ... }]]>
</code>
</event_listener>
</event_listeners>
</itop_design>