path: root/help/api-handler-area.html
diff options
Diffstat (limited to 'help/api-handler-area.html')
1 files changed, 45 insertions, 0 deletions
diff --git a/help/api-handler-area.html b/help/api-handler-area.html
new file mode 100644
index 0000000..41fd473
--- /dev/null
+++ b/help/api-handler-area.html
@@ -0,0 +1,45 @@
+In Views areas (header, footer, empty-text) are pluggable, this means you can write your own php logic to place whatever you want.
+You should have read <a href="topic:views/api">API</a> and <a href="topic:views/api-tables">Tables API</a> to get a basic knowledge
+how to extend views.
+<h3>Create your own area handler</h3>
+The first step is to tell views: Hey i want to add a new area handler.
+Therefore you have to implement hook_views_data and add a new one. For example:
+function yourmodule_views_data() {
+ $data['views']['collapsible_area'] = array(
+ 'title' =&gt; t('Collabsible Text area'),
+ 'help' =&gt; t('Provide collabsible markup text for the area.'),
+ 'area' =&gt; array(
+ 'handler' =&gt; 'yourmodule_handler_collapsible_area_text',
+ ),
+ );
+The second step is to write this handler. Therefore create a file called and
+add register your handler with hook_views_handlers, see <a href="topic:views/api-handlers">Handlers API</a>
+Then add content to your area file like this:
+class yourmodule_handler_collapsible_area_text extends views_handler_area_text {
+ function render($empty = FALSE) {
+ // Here you just return a string of your content you want.
+ if ($render = parent::render($empty)) {
+ $element = array(
+ '#type' =&gt; 'fieldset',
+ '#title' =&gt; t('Title'),
+ '#value' =&gt; $render,
+ );
+ $output = theme('fieldset', $element);
+ return $output;
+ }
+ }
+As on every handler you can add options so you can configure the behavior. If the area isn't shown yet in the views interface, please clear the cache :) \ No newline at end of file