Add helper methods

Author: lukasbestle

etc/template.php

@@ -1,10 +1,4 @@
 <?php
 
-namespace Kirby\Modules;
-
 // Redirect to the page where the module appears
-if($page->parent()->uid() === Modules::parentUid()) {
-	go($page->parent()->parent());
-} else {
-	go($page->parent());
-}
+go($page->page());

lib/modulepage.php

@@ -0,0 +1,37 @@
+<?php
+
+namespace Kirby\Modules;
+
+// Kirby dependencies
+use Page;
+
+/**
+ * ModulePage
+ * 
+ * @package Kirby Modules Plugin
+ * @author  Lukas Bestle <[email protected]>
+ * @license MIT
+ */
+class ModulePage extends Page {
+	/**
+	 * Returns the page where the module appears
+	 *
+	 * @return Page
+	 */
+	public function page() {
+		if($this->parent()->uid() === Modules::parentUid()) {
+			return $this->parent()->parent();
+		} else {
+			return $this->parent();
+		}
+	}
+	
+	/**
+	 * Returns the module object
+	 *
+	 * @return Module
+	 */
+	public function module() {
+		return new Module($this);
+	}
+}

lib/modules.php

@@ -88,7 +88,7 @@ public function modules() {
 	}
 
 	/**
-	 * Registers the page method and all blueprints within Kirby
+	 * Registers the page methods, page models and all blueprints within Kirby
 	 * Called only once when the plugin is loaded
 	 */
 	public static function register() {
@@ -98,10 +98,33 @@ public static function register() {
 		// Calling it will call the modules() helper
 		$kirby->set('page::method', 'modules', 'modules');
 
-		// Register blueprints and dummy templates for all modules
+		// Register $page->moduleList() method
+		$kirby->set('page::method', 'moduleList', function($page) {
+			$modules = new static($page);
+			return $modules->modules();
+		});
+		
+		// Register $page->moduleCount($module) method
+		$kirby->set('page::method', 'moduleCount', function($page, $module = null) {
+			$moduleList = $page->moduleList();
+			if($module) {
+				$module = new Module($module);
+				$moduleList = $moduleList->filterBy('intendedTemplate', $module->template());
+			}
+			
+			return $moduleList->count();
+		});
+		
+		// Register $page->hasModules($module) method
+		$kirby->set('page::method', 'hasModules', function($page, $module = null) {
+			return $page->moduleCount($module) > 0;
+		});
+		
+		// Register blueprints, page models and dummy templates for all modules
 		foreach(static::allModules() as $module) {
-			$kirby->set('blueprint', $module->template(), $module->blueprintFile());
-			$kirby->set('template',  $module->template(), dirname(__DIR__) . DS . 'etc' . DS . 'template.php');
+			$kirby->set('blueprint',   $module->template(), $module->blueprintFile());
+			$kirby->set('page::model', $module->template(), 'kirby\\modules\\modulepage');
+			$kirby->set('template',    $module->template(), dirname(__DIR__) . DS . 'etc' . DS . 'template.php');
 		}
 	}
 

modules.php

@@ -8,11 +8,12 @@
 
 // Define autoloader
 load(array(
-	'kirby\\modules\\modules' => __DIR__ . DS . 'lib' . DS . 'modules.php',
-	'kirby\\modules\\module'  => __DIR__ . DS . 'lib' . DS . 'module.php',
+	'kirby\\modules\\modules'    => __DIR__ . DS . 'lib' . DS . 'modules.php',
+	'kirby\\modules\\module'     => __DIR__ . DS . 'lib' . DS . 'module.php',
+	'kirby\\modules\\modulepage' => __DIR__ . DS . 'lib' . DS . 'modulepage.php',
 ));
 
-// Register page method and blueprints
+// Register page methods, blueprints and page models
 Kirby\Modules\Modules::register();
 
 /**

package.json

@@ -3,6 +3,6 @@
   "description": "Kirby Modules Plugin",
   "author": "Lukas Bestle <[email protected]>",
   "license": "MIT",
-  "version": "1.0.1",
+  "version": "1.1.0",
   "type": "kirby-plugin"
 }

readme.md

@@ -131,6 +131,37 @@ c::set('modules.parent.uid', 'modules');
 c::set('modules.template.prefix', 'module.');
 ```
 
+## Helper methods
+
+Besides the main `$page->modules()` method that is used to output the module snippets, there are also a few other helper methods you can use:
+
+### `$page->moduleList()`
+
+Returns an array of the module pages for the given page.
+
+### `$page->moduleCount($type)`
+
+Returns the number of modules. If `$type` is given, returns the number of modules of that type.
+
+### `$page->hasModules($type)`
+
+Returns whether the page has any modules. If `$type` is given, returns whether the page has modules of that type.
+
+### `$module->page()`
+
+Returns the page where the module appears. Depending on your setup, it's either the parent page or the grandparent page.
+
+### `$module->module()`
+
+Returns the module object. You can use it to get more information about the module:
+
+```
+var_dump($module->module()->name()); // Name of the module
+var_dump($module->module()->template()); // Template name of the module
+```
+
+There are also a few other values of the module object, see `lib/module.php`.
+
 ## Using together with the Patterns plugin
 
 Since the plugin only requires the modules to have a snippet and a blueprint, modules can be stored inside the `site/patterns` directory if you use the [Patterns plugin](https://github.com/getkirby-plugins/patterns-plugin). This is useful if you want to present the different modules in the Patterns interface.