phpMv / phpMv-UI

Ajax/semantic/widgets/datatable/DataTable.php

Doc Comments +18 added lines, -3 removed lines

@@ -40,6 +40,10 @@ 
 		parent::run($js);
 	}
 
+	/**
+	 * @param string $identifier
+	 * @param string $model
+	 */
 	public function __construct($identifier,$model,$modelInstance=NULL) {
 		parent::__construct($identifier, $model,$modelInstance);
 		$this->_init(new InstanceViewer($identifier), "table", new HtmlTable($identifier, 0,0), false);
@@ -154,6 +158,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param PositionInTable $part
+	 */
 	private function addToolbarRow($part,$table,$captions){
 		$hasPart=$table->hasPart($part);
 		if($hasPart){
@@ -198,7 +205,7 @@ 
 	/**
 	 * @param string $caption
 	 * @param callable $callback
-	 * @return callable
+	 * @return \Closure
 	 */
 	private function getFieldButtonCallable($caption,$callback=null){
 		return $this->getCallable("getFieldButton",[$caption],$callback);
@@ -206,9 +213,9 @@ 
 
 	/**
 	 * @param callable $thisCallback
-	 * @param array $parameters
+	 * @param string[] $parameters
 	 * @param callable $callback
-	 * @return callable
+	 * @return \Closure
 	 */
 	private function getCallable($thisCallback,$parameters,$callback=null){
 		$result=function($instance) use($thisCallback,$parameters,$callback){
@@ -269,11 +276,19 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param string $icon
+	 * @param string $class
+	 */
 	private function addDefaultButton($icon,$class=null,$callback=null){
 		$this->addField($this->getCallable("getDefaultButton",[$icon,$class],$callback));
 		return $this;
 	}
 
+	/**
+	 * @param string $icon
+	 * @param string $class
+	 */
 	private function insertDefaultButtonIn($index,$icon,$class=null,$callback=null){
 		$this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class],$callback));
 		return $this;

Spacing +80 added lines, -80 removed lines

@@ -30,8 +30,8 @@ 
 	protected $_hasCheckboxes;
 	protected $_compileParts;
 
-	public function run(JsUtils $js){
-		if($this->_hasCheckboxes && isset($js)){
+	public function run(JsUtils $js) {
+		if ($this->_hasCheckboxes && isset($js)) {
 			$js->execOn("change", "#".$this->identifier." [name='selection[]']", "
 		var \$parentCheckbox=\$('#ck-main-ck-{$this->identifier}'),\$checkbox=\$('#{$this->identifier} [name=\"selection[]\"]'),allChecked=true,allUnchecked=true;
 		\$checkbox.each(function() {if($(this).prop('checked')){allUnchecked = false;}else{allChecked = false;}});
@@ -40,9 +40,9 @@ 
 		parent::run($js);
 	}
 
-	public function __construct($identifier,$model,$modelInstance=NULL) {
-		parent::__construct($identifier, $model,$modelInstance);
-		$this->_init(new InstanceViewer($identifier), "table", new HtmlTable($identifier, 0,0), false);
+	public function __construct($identifier, $model, $modelInstance=NULL) {
+		parent::__construct($identifier, $model, $modelInstance);
+		$this->_init(new InstanceViewer($identifier), "table", new HtmlTable($identifier, 0, 0), false);
 	}
 
 	/**
@@ -54,61 +54,61 @@ 
 	}
 
 
-	public function compile(JsUtils $js=NULL,&$view=NULL){
+	public function compile(JsUtils $js=NULL, &$view=NULL) {
 		$this->_instanceViewer->setInstance($this->_model);
 		$captions=$this->_instanceViewer->getCaptions();
 
 		$table=$this->content["table"];
 
-		if($this->_hasCheckboxes){
+		if ($this->_hasCheckboxes) {
 			$this->_generateMainCheckbox($captions);
 		}
 
 		$table->setRowCount(0, \sizeof($captions));
 		$table->setHeaderValues($captions);
-		if(isset($this->_compileParts))
+		if (isset($this->_compileParts))
 			$table->setCompileParts($this->_compileParts);
-		if(isset($this->_searchField) && isset($js)){
-			$this->_searchField->postOn("change", $this->_urls,"{'s':$(this).val()}","-#".$this->identifier." tbody",["preventDefault"=>false]);
+		if (isset($this->_searchField) && isset($js)) {
+			$this->_searchField->postOn("change", $this->_urls, "{'s':$(this).val()}", "-#".$this->identifier." tbody", ["preventDefault"=>false]);
 		}
 
 		$this->_generateContent($table);
 
-		if($this->_hasCheckboxes && $table->hasPart("thead")){
-				$table->getHeader()->getCell(0, 0)->addToProperty("class","no-sort");
+		if ($this->_hasCheckboxes && $table->hasPart("thead")) {
+				$table->getHeader()->getCell(0, 0)->addToProperty("class", "no-sort");
 		}
 
-		if(isset($this->_pagination) && $this->_pagination->getVisible()){
+		if (isset($this->_pagination) && $this->_pagination->getVisible()) {
 			$this->_generatePagination($table);
 		}
-		if(isset($this->_toolbar)){
+		if (isset($this->_toolbar)) {
 			$this->_setToolbarPosition($table, $captions);
 		}
-		$this->content=JArray::sortAssociative($this->content, [PositionInTable::BEFORETABLE,"table",PositionInTable::AFTERTABLE]);
-		return parent::compile($js,$view);
+		$this->content=JArray::sortAssociative($this->content, [PositionInTable::BEFORETABLE, "table", PositionInTable::AFTERTABLE]);
+		return parent::compile($js, $view);
 	}
 
-	private function _generateMainCheckbox(&$captions){
-		$ck=new HtmlCheckbox("main-ck-".$this->identifier,"");
+	private function _generateMainCheckbox(&$captions) {
+		$ck=new HtmlCheckbox("main-ck-".$this->identifier, "");
 		$ck->setOnChecked("$('#".$this->identifier." [name=%quote%selection[]%quote%]').prop('checked',true);");
 		$ck->setOnUnchecked("$('#".$this->identifier." [name=%quote%selection[]%quote%]').prop('checked',false);");
 		\array_unshift($captions, $ck);
 	}
 
-	protected function _generateContent($table){
+	protected function _generateContent($table) {
 		$objects=$this->_modelInstance;
-		if(isset($this->_pagination)){
+		if (isset($this->_pagination)) {
 			$objects=$this->_pagination->getObjects($this->_modelInstance);
 		}
 		InstanceViewer::setIndex(0);
-		$table->fromDatabaseObjects($objects, function($instance){
+		$table->fromDatabaseObjects($objects, function($instance) {
 			$this->_instanceViewer->setInstance($instance);
 			InstanceViewer::$index++;
-			$result= $this->_instanceViewer->getValues();
-			if($this->_hasCheckboxes){
-				$ck=new HtmlCheckbox("ck-".$this->identifier,"");
+			$result=$this->_instanceViewer->getValues();
+			if ($this->_hasCheckboxes) {
+				$ck=new HtmlCheckbox("ck-".$this->identifier, "");
 				$field=$ck->getField();
-				$field->setProperty("value",$this->_instanceViewer->getIdentifier());
+				$field->setProperty("value", $this->_instanceViewer->getIdentifier());
 				$field->setProperty("name", "selection[]");
 				\array_unshift($result, $ck);
 			}
@@ -116,28 +116,28 @@ 
 		});
 	}
 
-	private function _generatePagination($table){
+	private function _generatePagination($table) {
 		$footer=$table->getFooter();
 		$footer->mergeCol();
-		$menu=new HtmlPaginationMenu("pagination-".$this->identifier,$this->_pagination->getPagesNumbers());
+		$menu=new HtmlPaginationMenu("pagination-".$this->identifier, $this->_pagination->getPagesNumbers());
 		$menu->floatRight();
 		$menu->setActiveItem($this->_pagination->getPage()-1);
 		$footer->setValues($menu);
-		$menu->postOnClick($this->_urls,"{'p':$(this).attr('data-page')}","-#".$this->identifier." tbody",["preventDefault"=>false]);
+		$menu->postOnClick($this->_urls, "{'p':$(this).attr('data-page')}", "-#".$this->identifier." tbody", ["preventDefault"=>false]);
 	}
 
-	protected function _setToolbarPosition($table,$captions=NULL){
-		switch ($this->_toolbarPosition){
+	protected function _setToolbarPosition($table, $captions=NULL) {
+		switch ($this->_toolbarPosition) {
 			case PositionInTable::BEFORETABLE:
 			case PositionInTable::AFTERTABLE:
-				if(isset($this->_compileParts)===false){
+				if (isset($this->_compileParts)===false) {
 					$this->content[$this->_toolbarPosition]=$this->_toolbar;
 				}
 				break;
 			case PositionInTable::HEADER:
 			case PositionInTable::FOOTER:
 			case PositionInTable::BODY:
-				$this->addToolbarRow($this->_toolbarPosition,$table, $captions);
+				$this->addToolbarRow($this->_toolbarPosition, $table, $captions);
 				break;
 		}
 	}
@@ -149,23 +149,23 @@ 
 	 * @param callable $callback function called after the field compilation
 	 * @return \Ajax\semantic\widgets\datatable\DataTable
 	 */
-	public function afterCompile($index,$callback){
-		$this->_instanceViewer->afterCompile($index,$callback);
+	public function afterCompile($index, $callback) {
+		$this->_instanceViewer->afterCompile($index, $callback);
 		return $this;
 	}
 
-	private function addToolbarRow($part,$table,$captions){
+	private function addToolbarRow($part, $table, $captions) {
 		$hasPart=$table->hasPart($part);
-		if($hasPart){
+		if ($hasPart) {
 			$row=$table->getPart($part)->addRow(\sizeof($captions));
-		}else{
+		} else {
 			$row=$table->getPart($part)->getRow(0);
 		}
 		$row->mergeCol();
 		$row->setValues([$this->_toolbar]);
 	}
 
-	public function getHtmlComponent(){
+	public function getHtmlComponent() {
 		return $this->content["table"];
 	}
 
@@ -178,8 +178,8 @@ 
 		return $this;
 	}
 
-	public function paginate($items_per_page=10,$page=1){
-		$this->_pagination=new Pagination($items_per_page,4,$page);
+	public function paginate($items_per_page=10, $page=1) {
+		$this->_pagination=new Pagination($items_per_page, 4, $page);
 	}
 
 	public function getHasCheckboxes() {
@@ -191,7 +191,7 @@ 
 		return $this;
 	}
 
-	public function refresh($compileParts=["tbody"]){
+	public function refresh($compileParts=["tbody"]) {
 		$this->_compileParts=$compileParts;
 		return $this;
 	}
@@ -200,8 +200,8 @@ 
 	 * @param callable $callback
 	 * @return callable
 	 */
-	private function getFieldButtonCallable($caption,$callback=null){
-		return $this->getCallable("getFieldButton",[$caption],$callback);
+	private function getFieldButtonCallable($caption, $callback=null) {
+		return $this->getCallable("getFieldButton", [$caption], $callback);
 	}
 
 	/**
@@ -210,16 +210,16 @@ 
 	 * @param callable $callback
 	 * @return callable
 	 */
-	private function getCallable($thisCallback,$parameters,$callback=null){
-		$result=function($instance) use($thisCallback,$parameters,$callback){
-			$object=call_user_func_array(array($this,$thisCallback), $parameters);
-			if(isset($callback)){
-				if(\is_callable($callback)){
-					$callback($object,$instance);
+	private function getCallable($thisCallback, $parameters, $callback=null) {
+		$result=function($instance) use($thisCallback, $parameters, $callback){
+			$object=call_user_func_array(array($this, $thisCallback), $parameters);
+			if (isset($callback)) {
+				if (\is_callable($callback)) {
+					$callback($object, $instance);
 				}
 			}
-			if($object instanceof HtmlSemDoubleElement){
-				$object->setProperty("data-ajax",$this->_instanceViewer->getIdentifier());
+			if ($object instanceof HtmlSemDoubleElement) {
+				$object->setProperty("data-ajax", $this->_instanceViewer->getIdentifier());
 			}
 			return $object;
 		};
@@ -230,8 +230,8 @@ 
 	 * @param string $caption
 	 * @return HtmlButton
 	 */
-	private function getFieldButton($caption){
-		return new HtmlButton("",$caption);
+	private function getFieldButton($caption) {
+		return new HtmlButton("", $caption);
 	}
 
 	/**
@@ -240,8 +240,8 @@ 
 	 * @param callable $callback
 	 * @return \Ajax\semantic\widgets\datatable\DataTable
 	 */
-	public function addFieldButton($caption,$callback=null){
-		$this->addField($this->getCallable("getFieldButton",[$caption],$callback));
+	public function addFieldButton($caption, $callback=null) {
+		$this->addField($this->getCallable("getFieldButton", [$caption], $callback));
 		return $this;
 	}
 
@@ -252,8 +252,8 @@ 
 	 * @param callable $callback
 	 * @return \Ajax\semantic\widgets\datatable\DataTable
 	 */
-	public function insertFieldButton($index,$caption,$callback=null){
-		$this->insertField($index, $this->getFieldButtonCallable($caption,$callback));
+	public function insertFieldButton($index, $caption, $callback=null) {
+		$this->insertField($index, $this->getFieldButtonCallable($caption, $callback));
 		return $this;
 	}
 
@@ -264,60 +264,60 @@ 
 	 * @param callable $callback
 	 * @return \Ajax\semantic\widgets\datatable\DataTable
 	 */
-	public function insertInFieldButton($index,$caption,$callback=null){
-		$this->insertInField($index, $this->getFieldButtonCallable($caption,$callback));
+	public function insertInFieldButton($index, $caption, $callback=null) {
+		$this->insertInField($index, $this->getFieldButtonCallable($caption, $callback));
 		return $this;
 	}
 
-	private function addDefaultButton($icon,$class=null,$callback=null){
-		$this->addField($this->getCallable("getDefaultButton",[$icon,$class],$callback));
+	private function addDefaultButton($icon, $class=null, $callback=null) {
+		$this->addField($this->getCallable("getDefaultButton", [$icon, $class], $callback));
 		return $this;
 	}
 
-	private function insertDefaultButtonIn($index,$icon,$class=null,$callback=null){
-		$this->insertInField($index,$this->getCallable("getDefaultButton",[$icon,$class],$callback));
+	private function insertDefaultButtonIn($index, $icon, $class=null, $callback=null) {
+		$this->insertInField($index, $this->getCallable("getDefaultButton", [$icon, $class], $callback));
 		return $this;
 	}
 
-	private function getDefaultButton($icon,$class=null){
+	private function getDefaultButton($icon, $class=null) {
 		$bt=$this->getFieldButton("");
 		$bt->asIcon($icon);
-		if(isset($class))
+		if (isset($class))
 			$bt->addToProperty("class", $class);
 		return $bt;
 	}
 
-	public function addDeleteButton($callback=null){
-		return $this->addDefaultButton("remove","delete red basic",$callback);
+	public function addDeleteButton($callback=null) {
+		return $this->addDefaultButton("remove", "delete red basic", $callback);
 	}
 
-	public function addEditButton($callback=null){
-		return $this->addDefaultButton("edit","edit basic",$callback);
+	public function addEditButton($callback=null) {
+		return $this->addDefaultButton("edit", "edit basic", $callback);
 	}
 
-	public function addEditDeleteButtons($callbackEdit=null,$callbackDelete=null){
+	public function addEditDeleteButtons($callbackEdit=null, $callbackDelete=null) {
 		$this->addEditButton($callbackEdit);
 		$index=$this->_instanceViewer->visiblePropertiesCount()-1;
-		$this->insertDeleteButtonIn($index,$callbackDelete);
+		$this->insertDeleteButtonIn($index, $callbackDelete);
 		return $this;
 	}
 
-	public function insertDeleteButtonIn($index,$callback=null){
-		return $this->insertDefaultButtonIn($index,"remove","delete red basic",$callback);
+	public function insertDeleteButtonIn($index, $callback=null) {
+		return $this->insertDefaultButtonIn($index, "remove", "delete red basic", $callback);
 	}
 
-	public function insertEditButtonIn($index,$callback=null){
-		return $this->insertDefaultButtonIn($index,"edit","edit basic",$callback);
+	public function insertEditButtonIn($index, $callback=null) {
+		return $this->insertDefaultButtonIn($index, "edit", "edit basic", $callback);
 	}
 
-	public function addSearchInToolbar($position=Direction::RIGHT){
+	public function addSearchInToolbar($position=Direction::RIGHT) {
 		return $this->addInToolbar($this->getSearchField())->setPosition($position);
 	}
 
-	public function getSearchField(){
-		if(isset($this->_searchField)===false){
-			$this->_searchField=new HtmlInput("search-".$this->identifier,"search","","Search...");
-			$this->_searchField->addIcon("search",Direction::RIGHT);
+	public function getSearchField() {
+		if (isset($this->_searchField)===false) {
+			$this->_searchField=new HtmlInput("search-".$this->identifier, "search", "", "Search...");
+			$this->_searchField->addIcon("search", Direction::RIGHT);
 		}
 		return $this->_searchField;
 	}

Braces +7 added lines, -5 removed lines

@@ -66,8 +66,9 @@ 
 
 		$table->setRowCount(0, \sizeof($captions));
 		$table->setHeaderValues($captions);
-		if(isset($this->_compileParts))
-			$table->setCompileParts($this->_compileParts);
+		if(isset($this->_compileParts)) {
+					$table->setCompileParts($this->_compileParts);
+		}
 		if(isset($this->_searchField) && isset($js)){
 			$this->_searchField->postOn("change", $this->_urls,"{'s':$(this).val()}","-#".$this->identifier." tbody",["preventDefault"=>false]);
 		}
@@ -158,7 +159,7 @@ 
 		$hasPart=$table->hasPart($part);
 		if($hasPart){
 			$row=$table->getPart($part)->addRow(\sizeof($captions));
-		}else{
+		} else{
 			$row=$table->getPart($part)->getRow(0);
 		}
 		$row->mergeCol();
@@ -282,8 +283,9 @@ 
 	private function getDefaultButton($icon,$class=null){
 		$bt=$this->getFieldButton("");
 		$bt->asIcon($icon);
-		if(isset($class))
-			$bt->addToProperty("class", $class);
+		if(isset($class)) {
+					$bt->addToProperty("class", $class);
+		}
 		return $bt;
 	}