khanh.pndc/nextcloud-docs
1
0
Fork 0
mirror of https://github.com/nextcloud/documentation.git synced 2026-01-03 02:09:45 +07:00
Code Issues Packages Projects Releases Wiki Activity

updated hooks

Browse Source
This commit is contained in:
Bernhard Posselt
2013-02-09 16:39:19 +01:00
parent 03e60ceacb
commit 4421424a63
1 changed files with 27 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

56
developer_manual/app/hooks.rst
View File

@@ -1,11 +1,7 @@
Hooks
=====
.. todo:: Needs to be reworked
In ownCloud apps, function or methods (event handlers) which are used by the app
and called by ownCloud core hooks, are generally stored in
apps/appname/lib/hooks.php.Hooks are a way of implementing the `observer
In ownCloud apps, function or methods (event handlers) which are used by the app and called by ownCloud core hooks, are generally stored in :file:`apps/appname/lib/hooks.php`. Hooks are a way of implementing the `observer
pattern`_, and are commonly used by web platform applications to provide clean
interfaces to third party applications which need to modify core application
functionality.
@@ -13,61 +9,63 @@ functionality.
In ownCloud, a hook is a function whose name can be used by developers of
plug-ins to ensure that additional code is executed at a precise place during
the execution of other parts of ownCloud code. For example, when an ownCloud
user is deleted, the ownCloud core hook ``post_deleteUser`` is executed.
In the calendar app's ``appinfo/app.php``, this hook is connected to the app's
own event handler ``deleteUser`` (``user`` here refers to an ownCloud user;
``deleteUser`` deletes all addressbooks for that a given ownCloud user).
user is deleted, the ownCloud core hook **post_deleteUser** is executed.
In the calendar app's :file:`appinfo/app.php`, this hook is connected to the app's
own event handler **deleteUser** (**user** here refers to an ownCloud user;
**deleteUser** deletes all addressbooks for that a given ownCloud user).
When ``post_deleteUser`` calls the calender app's ``deleteUser`` event handler,
When **post_deleteUser** calls the calender app's **deleteUser** event handler,
it supplies it with an argument, which is an array containing the user ID of the
user that has just been deleted. This user ID is then used by the event handler
to specify which address books to delete. There are three components to the use
of hooks in this example:
#. The ownCloud core hook ``post_deleteUser``, (see what arguments / data it
will provide in ``lib/user.php``, where it is defined)
#. The event handler ``deleteUser``, defined in ``apps/contacts/lib/hooks.php``.
#. The ownCloud core hook **post_deleteUser**, (see what arguments / data it
will provide in :file:`lib/user.php`, where it is defined)
#. The event handler **deleteUser**, defined in :file:`apps/contacts/lib/hooks.php`.
#. The connection of the hook to the event handler, in
``apps/contacts/appinfo/app.php``.
:file:`apps/contacts/appinfo/app.php`.
ownCloud uses the following hook terminology:
Hook Terminology
----------------
* Signal class / emitter class: the class that contains the method which
contains the creation of the hook (and a call to the ``emit()`` method)
* **Signal class / emitter class:** the class that contains the method which
contains the creation of the hook (and a call to the **emit()** method)
e.g. OC_User
* Signal / signal name: the name of the hook, e.g. ``post_deleteUser``
* Slot class: class housing the event handling method, e.g.
``OC_Contacts_Hooks``
* Slot name: event handler method, e.g. deleteUser (function that deletes
* **Signal / signal name:** the name of the hook, e.g. **post_deleteUser**
* **Slot class**: class housing the event handling method, e.g.
**OC_Contacts_Hooks**
* **Slot name**: event handler method, e.g. deleteUser (function that deletes
all contact address books for a user)
ownCloud core provides the following hooks:
Available hooks
---------------
File: ``apps/calendar/ajax/events.php``, Class: OC_Calendar
File: **apps/calendar/ajax/events.php**, Class: OC_Calendar
* Hook: getEvents
File: ``apps/calendar/index.php``, Class: OC_Calendar
File: **apps/calendar/index.php**, Class: OC_Calendar
* Hook: getSources
File: ``dav.php``, Class: OC_DAV
File: **dav.php**, Class: OC_DAV
* Hook: initialize
File: ``lib/migrate.php``, Class: OC_User
File: **lib/migrate.php**, Class: OC_User
* Hook: pre_createUser
* Hook: post_createUser
File: ``lib/filecache.php``, Class: OC_Filesystem
File: **lib/filecache.php**, Class: OC_Filesystem
* Hook: post_write
* Hook: post_write
* Hook: post_delete
* Hook: post_write
File: ``lib/user.php``, Class: OC_User
File: **lib/user.php**, Class: OC_User
* Hook: pre_createUser
* Hook: post_createUser
@@ -79,7 +77,7 @@ File: ``lib/user.php``, Class: OC_User
* Hook: pre_setPassword
* Hook: post_setPassword
File: ``lib/group.php``, Class: OC_Group
File: **lib/group.php**, Class: OC_Group
* Hook: pre_createGroup
* Hook: post_createGroup