From 08c5b507bbaf4937ff637bd138f64119873e2922 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 12 Nov 2011 14:49:36 -0500
Subject: cleaned up the plugin hooks documentation

---
 documentation/examples/hooks/advanced.php          | 28 +++++++++++++++
 documentation/examples/hooks/all.php               | 12 +++++++
 documentation/examples/hooks/basic.php             | 41 +++++++---------------
 documentation/examples/hooks/register/advanced.php | 23 ------------
 documentation/examples/hooks/register/all.php      |  8 -----
 documentation/examples/hooks/register/basic.php    | 14 --------
 documentation/examples/hooks/register/emit.php     |  7 ----
 documentation/examples/hooks/trigger.php           | 14 ++++++++
 documentation/examples/hooks/trigger/advanced.php  |  9 -----
 documentation/examples/hooks/trigger/basic.php     |  9 -----
 10 files changed, 66 insertions(+), 99 deletions(-)
 create mode 100644 documentation/examples/hooks/advanced.php
 create mode 100644 documentation/examples/hooks/all.php
 delete mode 100644 documentation/examples/hooks/register/advanced.php
 delete mode 100644 documentation/examples/hooks/register/all.php
 delete mode 100644 documentation/examples/hooks/register/basic.php
 delete mode 100644 documentation/examples/hooks/register/emit.php
 create mode 100644 documentation/examples/hooks/trigger.php
 delete mode 100644 documentation/examples/hooks/trigger/advanced.php
 delete mode 100644 documentation/examples/hooks/trigger/basic.php

(limited to 'documentation')

diff --git a/documentation/examples/hooks/advanced.php b/documentation/examples/hooks/advanced.php
new file mode 100644
index 000000000..ca036c46a
--- /dev/null
+++ b/documentation/examples/hooks/advanced.php
@@ -0,0 +1,28 @@
+<?php
+/**
+ * This snippet demonstrates how to change the value of a hook. The content
+ * passed into the hook is 'This is some Sample Content.'. After the two hook
+ * handlers are done, the new content is 'This is some $@mple Content.'.
+ */
+
+// the output:page hook is triggered by elgg_view_page().
+elgg_register_plugin_hook_handler('output', 'page', 'example_plugin_hook_handler', 600);
+elgg_register_plugin_hook_handler('output', 'page', 'example_plugin_hook_handler_2', 601);
+
+function example_plugin_hook_handler($hook, $type, $value, $params) {
+	// change a to @
+	$value = str_replace('a', '@', $value);
+
+	return $value;
+}
+
+function example_plugin_hook_handler_2($hook, $type, $value, $params) {
+	// change S to $
+	$value = str_replace('S', '$', $value);
+
+	return $value;
+}
+
+$content = 'This is some Sample Content.';
+
+echo elgg_view_page('Title', $content);
diff --git a/documentation/examples/hooks/all.php b/documentation/examples/hooks/all.php
new file mode 100644
index 000000000..76b562335
--- /dev/null
+++ b/documentation/examples/hooks/all.php
@@ -0,0 +1,12 @@
+<?php
+/**
+ * This snippet demonstrates how to register for multiple hooks with the same
+ * type.
+ */
+
+elgg_register_plugin_hook_handler('all', 'system', 'example_plugin_hook_handler');
+
+// This function will be called for any hook of type 'system'
+function example_plugin_hook_handler($hook, $type, $value, $params) {
+	// logic here.
+}
diff --git a/documentation/examples/hooks/basic.php b/documentation/examples/hooks/basic.php
index 71076ee96..734d9e884 100644
--- a/documentation/examples/hooks/basic.php
+++ b/documentation/examples/hooks/basic.php
@@ -1,34 +1,17 @@
 <?php
+/**
+ * The handler for a plugin hook receives information about the hook (name and
+ * type), the current value for the hook, and parameters related to the hook.
+ */
 
-elgg_register_plugin_hook_handler('get_items', 'example', 'example_plugin_hook');
-elgg_register_plugin_hook_handler('get_items', 'example', 'example_plugin_hook_2');
+elgg_register_plugin_hook_handler('forward', '404', 'example_plugin_hook_handler');
 
-$params = array('username' => 'Joe');
-$items = elgg_trigger_plugin_hook('get_items', 'example', $params, $default);
+function example_plugin_hook_handler($hook, $type, $value, $params) {
+	var_dump($hook);
+	var_dump($type);
+	var_dump($value);
+	var_dump($params);
 
-var_dump($items);
-
-function example_plugin_hook($hook, $type, $value, $params) {
-	if (is_array($value)) {
-		$value[] = "Hook Value 1";
-		$value[] = "Hook Value 2";
-	}
-
-	return $value;
-}
-
-function example_plugin_hook_2($hook, $type, $value, $params) {
-	$username = isset($params['username']) ? $params['username'] : NULL;
-	if (is_array($value)) {
-		switch($username) {
-			case 'Joe':
-				$value[] = "Joe's item";
-				break;
-			case 'John':
-				$value[] = "Joe's item";
-				break;
-		}
-	}
-
-	return $value;
+	// we are not changing $value so return null
+	return null;
 }
diff --git a/documentation/examples/hooks/register/advanced.php b/documentation/examples/hooks/register/advanced.php
deleted file mode 100644
index e3951c19c..000000000
--- a/documentation/examples/hooks/register/advanced.php
+++ /dev/null
@@ -1,23 +0,0 @@
-<?php
-
-// the output:page hook is triggered by elgg_view_page().
-elgg_register_plugin_hook_handler('output', 'page', 'example_plugin_hook_handler', 600);
-elgg_register_plugin_hook_handler('output', 'page', 'example_plugin_hook_handler_2', 601);
-
-function example_plugin_hook_handler($event, $type, $value, $params) {
-	// change A to @
-	$value = str_replace('A', '@', $value);
-
-	return $value;
-}
-
-function example_plugin_hook_handler_2($event, $type, $value, $params) {
-	// change S to $
-	$value = str_replace('S', '$', $value);
-
-	return $value;
-}
-
-$content = 'This is some Sample Content.';
-
-echo elgg_view_page('Title', $content);
\ No newline at end of file
diff --git a/documentation/examples/hooks/register/all.php b/documentation/examples/hooks/register/all.php
deleted file mode 100644
index 0ff19bc86..000000000
--- a/documentation/examples/hooks/register/all.php
+++ /dev/null
@@ -1,8 +0,0 @@
-<?php
-
-elgg_register_plugin_hook_handler('all', 'system', 'example_plugin_hook_handler');
-
-// This function will be called for any hook of type 'system'
-function example_plugin_hook_handler($hook, $type, $value, $params) {
-	// logic here.
-}
diff --git a/documentation/examples/hooks/register/basic.php b/documentation/examples/hooks/register/basic.php
deleted file mode 100644
index 20493e200..000000000
--- a/documentation/examples/hooks/register/basic.php
+++ /dev/null
@@ -1,14 +0,0 @@
-<?php
-
-elgg_register_plugin_hook_handler('forward', 'system', 'example_plugin_hook_handler');
-
-function example_plugin_hook_handler($event, $type, $value, $params) {
-	var_dump($event);
-	var_dump($type);
-	var_dump($value);
-	var_dump($params);
-	
-	return true;
-}
-
-
diff --git a/documentation/examples/hooks/register/emit.php b/documentation/examples/hooks/register/emit.php
deleted file mode 100644
index 8382d72ca..000000000
--- a/documentation/examples/hooks/register/emit.php
+++ /dev/null
@@ -1,7 +0,0 @@
-<?php
-
-// @todo this is an event, not a hook
-elgg_register_event_handler('test', 'example', 'example_init_system_callback');
-
-$params = new ElggObject();
-elgg_trigger_event('test', 'example', $params);
diff --git a/documentation/examples/hooks/trigger.php b/documentation/examples/hooks/trigger.php
new file mode 100644
index 000000000..4216fd6c0
--- /dev/null
+++ b/documentation/examples/hooks/trigger.php
@@ -0,0 +1,14 @@
+<?php
+/**
+ * The current value for the hook is passed into the trigger function. Handlers
+ * can change this value. In this snippet, we check if the value of true was
+ * changed by the handler functions.
+ */
+
+$result = elgg_trigger_plugin_hook('get_status', 'example', null, true);
+
+if ($result) {
+	var_dump('Plugin hook says ok!');
+} else {
+	var_dump('Plugin hook says no.');
+}
diff --git a/documentation/examples/hooks/trigger/advanced.php b/documentation/examples/hooks/trigger/advanced.php
deleted file mode 100644
index 5901a06e0..000000000
--- a/documentation/examples/hooks/trigger/advanced.php
+++ /dev/null
@@ -1,9 +0,0 @@
-<?php
-
-$default = array('Entry 1', 'Entry 2', 'Entry 3');
-
-$menu = elgg_trigger_plugin_hook('get_menu_items', 'menu', null, $default);
-
-foreach ($menu as $item) {
-	var_dump($item);
-}
diff --git a/documentation/examples/hooks/trigger/basic.php b/documentation/examples/hooks/trigger/basic.php
deleted file mode 100644
index ea27a8a98..000000000
--- a/documentation/examples/hooks/trigger/basic.php
+++ /dev/null
@@ -1,9 +0,0 @@
-<?php
-
-$result = elgg_trigger_plugin_hook('get_status', 'example', null, true);
-
-if ($result) {
-	var_dump('Plugin hook says ok!');
-} else {
-	var_dump('Plugin hook says no.');
-}
-- 
cgit v1.2.3