From 11aacb4f048e659d1b86a6ba229438444a186142 Mon Sep 17 00:00:00 2001
From: cash <cash.costello@gmail.com>
Date: Sat, 12 Nov 2011 14:28:52 -0500
Subject: added better plugin skeleton and added documentation to some of the
 examples

---
 documentation/examples/actions/basic.php | 22 ++++++++++++++++++++++
 1 file changed, 22 insertions(+)
 create mode 100644 documentation/examples/actions/basic.php

(limited to 'documentation/examples/actions/basic.php')

diff --git a/documentation/examples/actions/basic.php b/documentation/examples/actions/basic.php
new file mode 100644
index 000000000..926e11b79
--- /dev/null
+++ b/documentation/examples/actions/basic.php
@@ -0,0 +1,22 @@
+<?php
+/**
+ * Demonstrates adding an annotation through an action
+ *
+ * This action adds a rating annotation to an entity. If this was coming from
+ * a five-star rating tool, the rating would be a number between 0 and 5. The
+ * GUID of the entity being rating is also submitted to the action.
+ */
+
+$rating = get_input('rating');
+$guid = get_input('guid');
+
+$entity = get_entity($guid);
+if (!$entity) {
+	register_error(elgg_echo('rating:failure'));
+	forward(REFERER);
+}
+
+$entity->annotate('rating', $rating);
+
+system_message(elgg_echo('rating:success'));
+forward(REFERER);
-- 
cgit v1.2.3