Adds widget hooks

Author: jcheron

Ajax/common/Widget.php

@@ -18,9 +18,10 @@
 use Ajax\semantic\html\collections\form\traits\FormTrait;
 use Ajax\common\html\BaseWidget;
 use Ajax\semantic\html\modules\HtmlModal;
+use Ajax\common\html\traits\BaseHooksTrait;
 
 abstract class Widget extends HtmlDoubleElement {
-	use FieldAsTrait,FormTrait;
+	use FieldAsTrait,FormTrait,BaseHooksTrait;
 
 	/**
 	 * @var string classname
@@ -52,7 +53,6 @@ abstract class Widget extends HtmlDoubleElement {
 
 	protected $_generated;
 
-
 	public function __construct($identifier,$model,$modelInstance=NULL) {
 		parent::__construct($identifier);
 		$this->_template="%wrapContentBefore%%content%%wrapContentAfter%";

Ajax/common/html/traits/BaseHooksTrait.php

@@ -0,0 +1,49 @@
+<?php
+
+namespace Ajax\common\html\traits;
+
+trait BaseHooksTrait {
+	protected $_hooks=[];
+	
+	/**
+	 * @param string $hookKey
+	 * @return boolean
+	 */
+	public function hookExists($hookKey){
+		return isset($this->_hooks[$hookKey]);
+	}
+	
+	/**
+	 * @param string $hookKey
+	 * @return callable|NULL
+	 */
+	public function getHook($hookKey){
+		if(isset($this->_hooks[$hookKey])){
+			return $this->_hooks[$hookKey];
+		}
+		return null;
+	}
+	
+	/**
+	 * Adds a new Hook
+	 * @param String $hookKey
+	 * @param callable $callable
+	 */
+	public function addHook($hookKey,$callable){
+		$this->_hooks[$hookKey]=$callable;
+	}
+	
+	/**
+	 * Executes the hook with key $hookKey
+	 * @param string $hookKey
+	 * @param mixed|null $variable
+	 * @return void|mixed
+	 */
+	public function execHook($hookKey,$variable=null){
+		if(($hook=$this->getHook($hookKey))!=null){
+			return $hook($variable);
+		}
+		return;
+	}
+}
+

Ajax/common/html/traits/BaseHtmlPropertiesTrait.php

@@ -65,7 +65,7 @@ public function addProperties($properties) {
 		return $this;
 	}
 
-	protected function removePropertyValue($name, $value) {
+	public function removePropertyValue($name, $value) {
 		$this->_self->properties[$name]=\str_replace($value, "", $this->_self->properties[$name]);
 		return $this;
 	}
@@ -100,7 +100,7 @@ public function removeProperty($name) {
 			unset($this->_self->properties[$name]);
 			return $this;
 	}
-
+	
 	public function propertyContains($propertyName, $value) {
 		$values=$this->_self->getProperty($propertyName);
 		if (isset($values)) {

Ajax/semantic/widgets/dataform/DataForm.php

@@ -88,6 +88,16 @@ protected function _generateFields($form,$values,$headers,$sepFirst,$wrappers){
 		if(isset($wrapper)){
 			$added->wrap($wrapper[0],$wrapper[1]);
 		}
+		$this->execHook("onGenerateFields",$added);
+	}
+	
+	/**
+	 * Function called when a field is generated
+	 * the generated field is the first parameter
+	 * @param callable $callback the fonction to call when a field is generated
+	 */
+	public function onGenerateField($callback){
+		$this->addHook("onGenerateFields",$callback);
 	}
 
 	/**