phpMv / phpMv-UI

Ajax/semantic/widgets/datatable/DataTable.php

Doc Comments +10 added lines

@@ -32,6 +32,10 @@ 
 	protected $_targetSelector;
 
 
+	/**
+	 * @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);
@@ -55,6 +59,9 @@ 
 
 
 
+	/**
+	 * @param string $op
+	 */
 	protected function _generateBehavior($op,$params,JsUtils $js){
 		if(isset($this->_urls[$op])){
 			$params=\array_merge($params,["attr"=>"data-ajax"]);
@@ -184,6 +191,9 @@ 
 		return $this;
 	}
 
+	/**
+	 * @param PositionInTable $part
+	 */
 	private function addToolbarRow($part,$table,$captions){
 		$hasPart=$table->hasPart($part);
 		if($hasPart){

Spacing +67 added lines, -67 removed lines

@@ -21,7 +21,7 @@ 
  *
  */
 class DataTable extends Widget {
-	use TableTrait,DataTableFieldAsTrait,HasCheckboxesTrait;
+	use TableTrait, DataTableFieldAsTrait, HasCheckboxesTrait;
 	protected $_searchField;
 	protected $_urls;
 	protected $_pagination;
@@ -32,33 +32,33 @@ 
 	protected $_targetSelector;
 
 
-	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);
 		}
 	}
 
@@ -71,62 +71,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);
 			}
@@ -137,37 +137,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->identifier." tbody",["preventDefault"=>false,"jqueryDone"=>"replaceWith"]);
+		if (isset($this->_urls["refresh"]))
+			$menu->postOnClick($this->_urls["refresh"], "{'p':$(this).attr('data-page')}", "#".$this->identifier." tbody", ["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;
 		}
 	}
@@ -179,23 +179,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"];
 	}
 
@@ -209,36 +209,36 @@ 
 	 * @return \Ajax\semantic\widgets\datatable\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;
 	}
 
-	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 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;
 	}
@@ -254,7 +254,7 @@ 
 		return $this;
 	}
 
-	public function asForm(){
+	public function asForm() {
 		return $this->getForm();
 	}
 
@@ -262,7 +262,7 @@ 
 
 	protected function getTargetSelector() {
 		$result=$this->_targetSelector;
-		if(!isset($result))
+		if (!isset($result))
 			$result="#".$this->identifier;
 		return $result;
 	}

Ajax/semantic/widgets/datatable/HasCheckboxesTrait.php

Spacing +18 added lines, -18 removed lines

@@ -10,17 +10,17 @@ 
  * @author jc
  * @property string identifier
  */
-trait HasCheckboxesTrait{
+trait HasCheckboxesTrait {
 	protected $_hasCheckboxes;
 	protected $_hasCheckedMessage=false;
 	protected $_checkedMessage;
 	protected $_checkedClass;
 
-	abstract public function addInToolbar($element,$callback=NULL);
+	abstract public function addInToolbar($element, $callback=NULL);
 
-	protected function _runCheckboxes(JsUtils $js){
+	protected function _runCheckboxes(JsUtils $js) {
 		$checkedMessageCall="";
-		if($this->_hasCheckedMessage){
+		if ($this->_hasCheckedMessage) {
 			$msg=$this->getCheckedMessage();
 			$checkedMessageFunction="function updateChecked(){var msg='".$msg[0]."',count=\$('#{$this->identifier} [name=\"selection[]\"]:checked').length,all=\$('#{$this->identifier} [name=\"selection[]\"]').length;
 			if(count==1) msg='".$msg[1]."';
@@ -28,10 +28,10 @@ 
 						\$('#checked-count-".$this->identifier."').contents().filter(function() {return this.nodeType == 3;}).each(function(){this.textContent = msg.replace('{count}',count);});
 							\$('#toolbar-{$this->identifier} .visibleOnChecked').toggle(count>0);}\$('#toolbar-".$this->identifier." .visibleOnChecked').hide();";
 			$checkedMessageCall="updateChecked();";
-			if(isset($this->_checkedClass)){
+			if (isset($this->_checkedClass)) {
 				$checkedMessageCall.="$(this).closest('tr').toggleClass('".$this->_checkedClass."',$(this).prop('checked'));";
 			}
-			$js->exec($checkedMessageFunction,true);
+			$js->exec($checkedMessageFunction, true);
 		}
 		$js->execOn("change", "#".$this->identifier." [name='selection[]']", "
 				var \$parentCheckbox=\$('#ck-main-ck-{$this->identifier}'),\$checkbox=\$('#{$this->identifier} [name=\"selection[]\"]'),allChecked=true,allUnchecked=true;
@@ -39,10 +39,10 @@ 
 				if(allChecked) {\$parentCheckbox.checkbox('set checked');}else if(allUnchecked){\$parentCheckbox.checkbox('set unchecked');}else{\$parentCheckbox.checkbox('set indeterminate');};".$checkedMessageCall);
 	}
 
-	protected function _generateMainCheckbox(&$captions){
-		$ck=new HtmlCheckbox("main-ck-".$this->identifier,"");
+	protected function _generateMainCheckbox(&$captions) {
+		$ck=new HtmlCheckbox("main-ck-".$this->identifier, "");
 		$checkedMessageCall="";
-		if($this->_hasCheckedMessage)
+		if ($this->_hasCheckedMessage)
 			$checkedMessageCall="updateChecked();";
 
 			$ck->setOnChecked($this->_setAllChecked("true").$checkedMessageCall);
@@ -50,9 +50,9 @@ 
 			\array_unshift($captions, $ck);
 	}
 
-	protected function _setAllChecked($checked){
+	protected function _setAllChecked($checked) {
 		$result="$('#".$this->identifier." [name=%quote%selection[]%quote%]').prop('checked',".$checked.");";
-		if(isset($this->_checkedClass)){
+		if (isset($this->_checkedClass)) {
 			$result.="$('#".$this->identifier." tr').toggleClass('".$this->_checkedClass."',".$checked.");";
 		}
 		return $result;
@@ -68,9 +68,9 @@ 
 	}
 
 	protected function getCheckedMessage() {
-		$result= $this->_checkedMessage;
-		if(!isset($result)){
-			$result=[0=>"none selected",1=>"one item selected","other"=>"{count} items selected"];
+		$result=$this->_checkedMessage;
+		if (!isset($result)) {
+			$result=[0=>"none selected", 1=>"one item selected", "other"=>"{count} items selected"];
 		}
 		return $result;
 	}
@@ -90,14 +90,14 @@ 
 	 * @param array $checkedMessage
 	 * @param callable $callback
 	 */
-	public function addCountCheckedInToolbar(array $checkedMessage=null,$callback=null){
-		if(isset($checkedMessage))
+	public function addCountCheckedInToolbar(array $checkedMessage=null, $callback=null) {
+		if (isset($checkedMessage))
 			$this->_checkedMessage=$checkedMessage;
 			$checkedMessage=$this->getCheckedMessage();
 			$this->_hasCheckboxes=true;
 			$this->_hasCheckedMessage=true;
-			$element=new HtmlLabel("checked-count-".$this->identifier,$checkedMessage[0]);
-			$this->addInToolbar($element,$callback);
+			$element=new HtmlLabel("checked-count-".$this->identifier, $checkedMessage[0]);
+			$this->addInToolbar($element, $callback);
 	}
 
 	public function setCheckedClass($_checkedClass) {