From c0260ff7018c1f29cf27d6fdb6ff6c7e4db5fff4 Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 18:25:18 -0800 Subject: more doco --- doc/hook/app_menu.bb | 1 - doc/hook/cron.bb | 4 ++++ doc/hook/cron_daily.bb | 2 ++ doc/hook/cron_weekly.bb | 2 ++ doc/hook/smilie.bb | 18 ++++++++++++++++++ doc/hook/tagged.bb | 15 +++++++++++++++ 6 files changed, 41 insertions(+), 1 deletion(-) delete mode 100644 doc/hook/app_menu.bb (limited to 'doc/hook') diff --git a/doc/hook/app_menu.bb b/doc/hook/app_menu.bb deleted file mode 100644 index 0458a692a..000000000 --- a/doc/hook/app_menu.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]app_menu[/h2] diff --git a/doc/hook/cron.bb b/doc/hook/cron.bb index ebbb64d50..55120b6c2 100644 --- a/doc/hook/cron.bb +++ b/doc/hook/cron.bb @@ -1 +1,5 @@ [h2]cron[/h2] + +Called when cron task (include/poller.php) is executed. The hook data is a string representing the current time (UTC). + + diff --git a/doc/hook/cron_daily.bb b/doc/hook/cron_daily.bb index c5062330a..802bea5e4 100644 --- a/doc/hook/cron_daily.bb +++ b/doc/hook/cron_daily.bb @@ -1 +1,3 @@ [h2]cron_daily[/h2] + +Called when cron task (include/poller.php) performs a cron_daily operation. The hook data is a string representing the current time (UTC). diff --git a/doc/hook/cron_weekly.bb b/doc/hook/cron_weekly.bb index 8dc85e494..c01bf9611 100644 --- a/doc/hook/cron_weekly.bb +++ b/doc/hook/cron_weekly.bb @@ -1 +1,3 @@ [h2]cron_weekly[/h2] + +Called when cron task (include/poller.php) performs a cron_weekly operation. The hook data is a string representing the current time (UTC). diff --git a/doc/hook/smilie.bb b/doc/hook/smilie.bb index cea3e0c94..575acc178 100644 --- a/doc/hook/smilie.bb +++ b/doc/hook/smilie.bb @@ -1 +1,19 @@ [h2]smilie[/h2] + + +Called when processing translation of emoticons. It is passed an array containing two sub-arrays: + + array( + 'texts' => array('text1','text2',...), + 'icons' => array('icon1','icon2',...) + ); + + texts is the emoticon text - for example ':-)' for a traditional smile face. + icons is the HTML used as a replacement. For example + '<img class="smiley" src="https://localhost/images/smiley-smile.gif" alt=":-)" />' + + If adding or removing an entry from either array, the corresponding element from the matching array must also + be added or removed. Emoticons less than three characters in length or not recommended as they get triggered + incorrectly quite often. Extended emoticons are indicated by convention using a preceding colon, for example + + :walrus_kissing_a_baby \ No newline at end of file diff --git a/doc/hook/tagged.bb b/doc/hook/tagged.bb index 5add76713..05d081d07 100644 --- a/doc/hook/tagged.bb +++ b/doc/hook/tagged.bb @@ -1 +1,16 @@ [h2]tagged[/h2] + + +This hook is called when a delivery is made which results in the recipient being tagged. + +The hook data is an array containing + + array( + 'channel_id' => int, + 'item' => item structure of the delivered item from database, + 'body' => the body of the referenced item + + ); + + Note: This hook is called before secondary delivery chains are invoked in the case of tagging a forum. This means that permissions and some item attributes will be those of the item before being re-packaged and before ownership of this item is given to the forum. + -- cgit v1.2.3 From e6de9bfa4ebe1fb1c7dd05c0d572c7d79d3323ee Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 19:42:37 -0800 Subject: get rid of the pre-comanche widget placement and wgl code --- doc/hook/get_widgets.bb | 1 - 1 file changed, 1 deletion(-) delete mode 100644 doc/hook/get_widgets.bb (limited to 'doc/hook') diff --git a/doc/hook/get_widgets.bb b/doc/hook/get_widgets.bb deleted file mode 100644 index 54b43858a..000000000 --- a/doc/hook/get_widgets.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]get_widgets[/h2] -- cgit v1.2.3 From c4a3487f0cee6391419fd73f2f89f074731a064c Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 20:29:36 -0800 Subject: remove the obsolete avatar_img function (gravatar/libravatar lookup) --- doc/hook/avatar_lookup.bb | 1 - 1 file changed, 1 deletion(-) delete mode 100644 doc/hook/avatar_lookup.bb (limited to 'doc/hook') diff --git a/doc/hook/avatar_lookup.bb b/doc/hook/avatar_lookup.bb deleted file mode 100644 index abd84de5e..000000000 --- a/doc/hook/avatar_lookup.bb +++ /dev/null @@ -1 +0,0 @@ -[h2]avatar_lookup[/h2] -- cgit v1.2.3 From 7ec687988746e1037d86d25186c2dd5f2addb15b Mon Sep 17 00:00:00 2001 From: redmatrix Date: Mon, 9 Nov 2015 20:56:37 -0800 Subject: more doco --- doc/hook/probe_well_known.bb | 2 ++ doc/hook/validate_channelname.bb | 22 ++++++++++++++++++++++ 2 files changed, 24 insertions(+) (limited to 'doc/hook') diff --git a/doc/hook/probe_well_known.bb b/doc/hook/probe_well_known.bb index eff690f31..62898c536 100644 --- a/doc/hook/probe_well_known.bb +++ b/doc/hook/probe_well_known.bb @@ -1 +1,3 @@ [h2]probe_well_known[/h2] + +This hook is under construction and not currently used - see include/probe.php \ No newline at end of file diff --git a/doc/hook/validate_channelname.bb b/doc/hook/validate_channelname.bb index c78961017..2ab12bbec 100644 --- a/doc/hook/validate_channelname.bb +++ b/doc/hook/validate_channelname.bb @@ -1 +1,23 @@ [h2]validate_channelname[/h2] + +Called when creating a new channel or changing the channel name in mod/settings.php + +Hook data consists of an array + + array( + 'name' => supplied name + ); + + If the hook handler determines the name is valid, do nothing. If there is an issue with the name, + set $hook_data['message'] to the message text which should be displayed to the member - and the name will + not be accepted. + + + Example: + [code] + if(mb_strlen($hook_data['name']) < 3) + $hook_data['message'] = t('Name too short.'); + [/code] + + + \ No newline at end of file -- cgit v1.2.3