phpMv / phpMv-UI

Ajax/semantic/widgets/datatable/DataTable.php

Doc Comments +18 added lines, -5 removed lines

@@ -33,6 +33,10 @@ 
 	protected $_refreshSelector;
 
 
+	/**
+	 * @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);
@@ -56,6 +60,9 @@ 
 
 
 
+	/**
+	 * @param string $op
+	 */
 	protected function _generateBehavior($op,$params,JsUtils $js){
 		if(isset($this->_urls[$op])){
 			$params=\array_merge($params,["attr"=>"data-ajax"]);
@@ -185,6 +192,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param PositionInTable $part
+	 */
 	private function addToolbarRow($part,$table,$captions){
 		$hasPart=$table->hasPart($part);
 		if($hasPart){
@@ -224,8 +234,8 @@ 
 	 * Paginates the DataTable element with a Semantic HtmlPaginationMenu component
 	 * @param number $page the active page number
 	 * @param number $total_rowcount the total number of items
-	 * @param number $items_per_page The number of items per page
-	 * @param number $pages_visibles The number of visible pages in the Pagination component
+	 * @param integer $items_per_page The number of items per page
+	 * @param integer $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
 	public function paginate($page,$total_rowcount,$items_per_page=10,$pages_visibles=4){
@@ -235,9 +245,9 @@ 
 
 	/**
 	 * Auto Paginates the DataTable element with a Semantic HtmlPaginationMenu component
-	 * @param number $page the active page number
-	 * @param number $items_per_page The number of items per page
-	 * @param number $pages_visibles The number of visible pages in the Pagination component
+	 * @param integer $page the active page number
+	 * @param integer $items_per_page The number of items per page
+	 * @param integer $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
 	public function autoPaginate($page=1,$items_per_page=10,$pages_visibles=4){
@@ -303,6 +313,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @return string
+	 */
 	public function getRefreshSelector() {
 		if(isset($this->_refreshSelector))
 			return $this->_refreshSelector;

Spacing +70 added lines, -70 removed lines

@@ -21,7 +21,7 @@ 
  *
  */
 class DataTable extends Widget {
-	use TableTrait,DataTableFieldAsTrait,HasCheckboxesTrait;
+	use TableTrait, DataTableFieldAsTrait, HasCheckboxesTrait;
 	protected $_searchField;
 	protected $_urls;
 	protected $_pagination;
@@ -33,33 +33,33 @@ 
 	protected $_refreshSelector;
 
 
-	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);
 		$this->_urls=[];
 	}
 
-	public function run(JsUtils $js){
-		if($this->_hasCheckboxes && isset($js)){
+	public function run(JsUtils $js) {
+		if ($this->_hasCheckboxes && isset($js)) {
 			$this->_runCheckboxes($js);
 		}
-		if($this->_visibleHover){
-			$js->execOn("mouseover", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'visible');",["preventDefault"=>false,"stopPropagation"=>true]);
-			$js->execOn("mouseout", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'hidden');",["preventDefault"=>false,"stopPropagation"=>true]);
+		if ($this->_visibleHover) {
+			$js->execOn("mouseover", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'visible');", ["preventDefault"=>false, "stopPropagation"=>true]);
+			$js->execOn("mouseout", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'hidden');", ["preventDefault"=>false, "stopPropagation"=>true]);
 		}
-		if(\is_array($this->_deleteBehavior))
-			$this->_generateBehavior("delete",$this->_deleteBehavior, $js);
-		if(\is_array($this->_editBehavior))
-			$this->_generateBehavior("edit",$this->_editBehavior,$js);
+		if (\is_array($this->_deleteBehavior))
+			$this->_generateBehavior("delete", $this->_deleteBehavior, $js);
+		if (\is_array($this->_editBehavior))
+			$this->_generateBehavior("edit", $this->_editBehavior, $js);
 		return parent::run($js);
 	}
 
 
 
-	protected function _generateBehavior($op,$params,JsUtils $js){
-		if(isset($this->_urls[$op])){
-			$params=\array_merge($params,["attr"=>"data-ajax"]);
-			$js->getOnClick("#".$this->identifier." ._".$op, $this->_urls[$op],$this->getTargetSelector(),$params);
+	protected function _generateBehavior($op, $params, JsUtils $js) {
+		if (isset($this->_urls[$op])) {
+			$params=\array_merge($params, ["attr"=>"data-ajax"]);
+			$js->getOnClick("#".$this->identifier." ._".$op, $this->_urls[$op], $this->getTargetSelector(), $params);
 		}
 	}
 
@@ -72,62 +72,62 @@ 
 	}
 
 
-	public function compile(JsUtils $js=NULL,&$view=NULL){
-		if(!$this->_generated){
+	public function compile(JsUtils $js=NULL, &$view=NULL) {
+		if (!$this->_generated) {
 			$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)){
-				if(isset($this->_urls["refresh"]))
-					$this->_searchField->postOn("change", $this->_urls["refresh"],"{'s':$(this).val()}","#".$this->identifier." tbody",["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+			if (isset($this->_searchField) && isset($js)) {
+				if (isset($this->_urls["refresh"]))
+					$this->_searchField->postOn("change", $this->_urls["refresh"], "{'s':$(this).val()}", "#".$this->identifier." tbody", ["preventDefault"=>false, "jqueryDone"=>"replaceWith"]);
 			}
 
 			$this->_generateContent($table);
 
-			if($this->_hasCheckboxes && $table->hasPart("thead")){
+			if ($this->_hasCheckboxes && $table->hasPart("thead")) {
 					$table->getHeader()->getCell(0, 0)->addClass("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]);
+			$this->content=JArray::sortAssociative($this->content, [PositionInTable::BEFORETABLE, "table", PositionInTable::AFTERTABLE]);
 			$this->_compileForm();
 			$this->_generated=true;
 		}
-		return parent::compile($js,$view);
+		return parent::compile($js, $view);
 	}
 
 
 
-	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) use($table){
 			$this->_instanceViewer->setInstance($instance);
 			InstanceViewer::$index++;
-			$values= $this->_instanceViewer->getValues();
-			if($this->_hasCheckboxes){
-				$ck=new HtmlCheckbox("ck-".$this->identifier,"");
+			$values=$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($values, $ck);
 			}
@@ -138,37 +138,37 @@ 
 		});
 	}
 
-	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);
-		if(isset($this->_urls["refresh"]))
-			$menu->postOnClick($this->_urls["refresh"],"{'p':$(this).attr('data-page')}",$this->getRefreshSelector(),["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+		if (isset($this->_urls["refresh"]))
+			$menu->postOnClick($this->_urls["refresh"], "{'p':$(this).attr('data-page')}", $this->getRefreshSelector(), ["preventDefault"=>false, "jqueryDone"=>"replaceWith"]);
 	}
 
-	protected function _getFieldName($index){
+	protected function _getFieldName($index) {
 		return parent::_getFieldName($index)."[]";
 	}
 
-	protected function _getFieldCaption($index){
+	protected function _getFieldCaption($index) {
 		return null;
 	}
 
-	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;
 		}
 	}
@@ -180,23 +180,23 @@ 
 	 * @param callable $callback function called after the field compilation
 	 * @return 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"];
 	}
 
@@ -210,12 +210,12 @@ 
 	 * @return DataTable
 	 */
 	public function setUrls($urls) {
-		if(\is_array($urls)){
-			$this->_urls["refresh"]=JArray::getValue($urls, "refresh",0);
-			$this->_urls["edit"]=JArray::getValue($urls, "edit",1);
-			$this->_urls["delete"]=JArray::getValue($urls, "delete",2);
-		}else{
-			$this->_urls=["refresh"=>$urls,"edit"=>$urls,"delete"=>$urls];
+		if (\is_array($urls)) {
+			$this->_urls["refresh"]=JArray::getValue($urls, "refresh", 0);
+			$this->_urls["edit"]=JArray::getValue($urls, "edit", 1);
+			$this->_urls["delete"]=JArray::getValue($urls, "delete", 2);
+		} else {
+			$this->_urls=["refresh"=>$urls, "edit"=>$urls, "delete"=>$urls];
 		}
 		return $this;
 	}
@@ -228,8 +228,8 @@ 
 	 * @param number $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
-	public function paginate($page,$total_rowcount,$items_per_page=10,$pages_visibles=4){
-		$this->_pagination=new Pagination($items_per_page,$pages_visibles,$page,$total_rowcount);
+	public function paginate($page, $total_rowcount, $items_per_page=10, $pages_visibles=4) {
+		$this->_pagination=new Pagination($items_per_page, $pages_visibles, $page, $total_rowcount);
 		return $this;
 	}
 
@@ -240,8 +240,8 @@ 
 	 * @param number $pages_visibles The number of visible pages in the Pagination component
 	 * @return DataTable
 	 */
-	public function autoPaginate($page=1,$items_per_page=10,$pages_visibles=4){
-		$this->_pagination=new Pagination($items_per_page,$pages_visibles,$page);
+	public function autoPaginate($page=1, $items_per_page=10, $pages_visibles=4) {
+		$this->_pagination=new Pagination($items_per_page, $pages_visibles, $page);
 		return $this;
 	}
 
@@ -251,20 +251,20 @@ 
 	 * @param array $compileParts
 	 * @return DataTable
 	 */
-	public function refresh($compileParts=["tbody"]){
+	public function refresh($compileParts=["tbody"]) {
 		$this->_compileParts=$compileParts;
 		return $this;
 	}
 
 
-	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;
 	}
@@ -280,7 +280,7 @@ 
 		return $this;
 	}
 
-	public function asForm(){
+	public function asForm() {
 		return $this->getForm();
 	}
 
@@ -288,7 +288,7 @@ 
 
 	protected function getTargetSelector() {
 		$result=$this->_targetSelector;
-		if(!isset($result))
+		if (!isset($result))
 			$result="#".$this->identifier;
 		return $result;
 	}
@@ -304,7 +304,7 @@ 
 	}
 
 	public function getRefreshSelector() {
-		if(isset($this->_refreshSelector))
+		if (isset($this->_refreshSelector))
 			return $this->_refreshSelector;
 		return "#".$this->identifier." tbody";
 	}

Braces +23 added lines, -16 removed lines

@@ -47,10 +47,12 @@ 
 			$js->execOn("mouseover", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'visible');",["preventDefault"=>false,"stopPropagation"=>true]);
 			$js->execOn("mouseout", "#".$this->identifier." tr", "$(event.target).closest('tr').find('.visibleover').css('visibility', 'hidden');",["preventDefault"=>false,"stopPropagation"=>true]);
 		}
-		if(\is_array($this->_deleteBehavior))
-			$this->_generateBehavior("delete",$this->_deleteBehavior, $js);
-		if(\is_array($this->_editBehavior))
-			$this->_generateBehavior("edit",$this->_editBehavior,$js);
+		if(\is_array($this->_deleteBehavior)) {
+					$this->_generateBehavior("delete",$this->_deleteBehavior, $js);
+		}
+		if(\is_array($this->_editBehavior)) {
+					$this->_generateBehavior("edit",$this->_editBehavior,$js);
+		}
 		return parent::run($js);
 	}
 
@@ -85,12 +87,14 @@ 
 
 			$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)){
-				if(isset($this->_urls["refresh"]))
-					$this->_searchField->postOn("change", $this->_urls["refresh"],"{'s':$(this).val()}","#".$this->identifier." tbody",["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+				if(isset($this->_urls["refresh"])) {
+									$this->_searchField->postOn("change", $this->_urls["refresh"],"{'s':$(this).val()}","#".$this->identifier." tbody",["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+				}
 			}
 
 			$this->_generateContent($table);
@@ -145,8 +149,9 @@ 
 		$menu->floatRight();
 		$menu->setActiveItem($this->_pagination->getPage()-1);
 		$footer->setValues($menu);
-		if(isset($this->_urls["refresh"]))
-			$menu->postOnClick($this->_urls["refresh"],"{'p':$(this).attr('data-page')}",$this->getRefreshSelector(),["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+		if(isset($this->_urls["refresh"])) {
+					$menu->postOnClick($this->_urls["refresh"],"{'p':$(this).attr('data-page')}",$this->getRefreshSelector(),["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+		}
 	}
 
 	protected function _getFieldName($index){
@@ -189,7 +194,7 @@ 
 		$hasPart=$table->hasPart($part);
 		if($hasPart){
 			$row=$table->getPart($part)->addRow(\sizeof($captions));
-		}else{
+		} else{
 			$row=$table->getPart($part)->getRow(0);
 		}
 		$row->mergeCol();
@@ -214,7 +219,7 @@ 
 			$this->_urls["refresh"]=JArray::getValue($urls, "refresh",0);
 			$this->_urls["edit"]=JArray::getValue($urls, "edit",1);
 			$this->_urls["delete"]=JArray::getValue($urls, "delete",2);
-		}else{
+		} else{
 			$this->_urls=["refresh"=>$urls,"edit"=>$urls,"delete"=>$urls];
 		}
 		return $this;
@@ -288,8 +293,9 @@ 
 
 	protected function getTargetSelector() {
 		$result=$this->_targetSelector;
-		if(!isset($result))
-			$result="#".$this->identifier;
+		if(!isset($result)) {
+					$result="#".$this->identifier;
+		}
 		return $result;
 	}
 
@@ -304,8 +310,9 @@ 
 	}
 
 	public function getRefreshSelector() {
-		if(isset($this->_refreshSelector))
-			return $this->_refreshSelector;
+		if(isset($this->_refreshSelector)) {
+					return $this->_refreshSelector;
+		}
 		return "#".$this->identifier." tbody";
 	}
 

Ajax/semantic/widgets/datatable/Pagination.php

Spacing +17 added lines, -17 removed lines

@@ -9,7 +9,7 @@ 
 	private $pages_visibles;
 	private $row_count;
 
-	public function __construct($items_per_page=10,$pages_visibles=4,$page=1,$row_count=null){
+	public function __construct($items_per_page=10, $pages_visibles=4, $page=1, $row_count=null) {
 		$this->items_per_page=$items_per_page;
 		$this->row_count=$row_count;
 		$this->page=$page;
@@ -17,29 +17,29 @@ 
 		$this->visible=true;
 	}
 
-	public function getObjects($objects){
+	public function getObjects($objects) {
 		$auto=(!isset($this->row_count));
 		$os=$objects;
-		if(!\is_array($os)){
+		if (!\is_array($os)) {
 			$os=[];
-			foreach ($objects as $o){
+			foreach ($objects as $o) {
 				$os[]=$o;
 			}
 		}
-		$this->page_count = 0;
-		$row_count=($auto)?\sizeof($os):$this->row_count;
-		if (0 === $row_count) {
+		$this->page_count=0;
+		$row_count=($auto) ? \sizeof($os) : $this->row_count;
+		if (0===$row_count) {
 			$this->visible=false;
 		} else {
 			$this->visible=true;
-			$this->page_count = (int)ceil($row_count / $this->items_per_page);
-			if($this->page > $this->page_count+1) {
-				$this->page = 1;
+			$this->page_count=(int)ceil($row_count/$this->items_per_page);
+			if ($this->page>$this->page_count+1) {
+				$this->page=1;
 			}
 		}
-		if($auto){
-			$offset = ($this->page - 1) * $this->items_per_page;
-			return array_slice($os, $offset,$this->items_per_page);
+		if ($auto) {
+			$offset=($this->page-1)*$this->items_per_page;
+			return array_slice($os, $offset, $this->items_per_page);
 		}
 		return $os;
 	}
@@ -75,14 +75,14 @@ 
 		return $this->page_count;
 	}
 
-	public function getPagesNumbers(){
-		$middle= (int)ceil(($this->pages_visibles-1)/ 2);
+	public function getPagesNumbers() {
+		$middle=(int)ceil(($this->pages_visibles-1)/2);
 		$first=$this->page-$middle;
-		if($first<1){
+		if ($first<1) {
 			$first=1;
 		}
 		$last=$first+$this->pages_visibles-1;
-		if($last>$this->page_count){
+		if ($last>$this->page_count) {
 			$last=$this->page_count;
 		}
 		return \range($first, $last);