Skip to content

Commit fdca699

Browse files
committed
documentation checking
1 parent 29801f1 commit fdca699

File tree

16 files changed

+45
-16
lines changed

16 files changed

+45
-16
lines changed

Ajax/bootstrap/html/HtmlModal.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -121,10 +121,10 @@ public function renderView(JsUtils $js,$initialController,$viewName, $params=arr
121121
/**
122122
* render the content of $controller::$action and set the response to the modal content
123123
* @param JsUtils $js
124-
* @param string $title The panel title
125124
* @param Controller $initialControllerInstance
126125
* @param string $controllerName the controller name
127126
* @param string $actionName the action name
127+
* @param array $params
128128
*/
129129
public function forward(JsUtils $js,$initialControllerInstance,$controllerName,$actionName,$params=NULL){
130130
$this->content=$js->forward($initialControllerInstance, $controllerName, $actionName,$params);

Ajax/bootstrap/html/base/HtmlNavElement.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -27,7 +27,7 @@ public function __construct($identifier,$tagName){
2727

2828
/**
2929
* Associate an ajax get to the elements, displayed in $targetSelector
30-
* $attr member is used to build each element url
30+
* $this->attr member is used to build each element url
3131
* @param string $targetSelector the target of the get
3232
* @param string $attr the html attribute used to build the elements url
3333
* @return HtmlNavElement

Ajax/common/Widget.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -259,12 +259,16 @@ public function setDefaultValueFunction($defaultValueFunction){
259259
return $this;
260260
}
261261

262+
/**
263+
* @param string|boolean $disable
264+
* @return string
265+
*/
262266
public function jsDisabled($disable=true){
263267
return "$('#".$this->identifier." .ui.input').toggleClass('disabled',".$disable.");";
264268
}
265269

266270
/**
267-
* @param unknown $caption
271+
* @param string $caption
268272
* @param callable $callback function($element)
269273
* @return \Ajax\common\html\HtmlDoubleElement
270274
*/

Ajax/common/html/traits/BaseHtmlEventsTrait.php

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44
use Ajax\service\AjaxCall;
55
use Ajax\common\components\SimpleExtComponent;
66
use Ajax\service\Javascript;
7+
use Ajax\common\html\BaseHtml;
78

89
/**
910
* @author jc
@@ -24,6 +25,11 @@ public function addEvent($event, $jsCode, $stopPropagation=false, $preventDefaul
2425
return $this->_addEvent($event, $jsCode);
2526
}
2627

28+
/**
29+
* @param string $event
30+
* @param string $jsCode
31+
* @return BaseHtml
32+
*/
2733
public function _addEvent($event, $jsCode) {
2834
if (array_key_exists($event, $this->_events)) {
2935
if (is_array($this->_events[$event])) {
@@ -93,6 +99,14 @@ protected function _eventsOnCreate(JsUtils $js=NULL){
9399
}
94100
}
95101

102+
/**
103+
* @param string $operation
104+
* @param string $event
105+
* @param string $url
106+
* @param string $responseElement
107+
* @param array $parameters
108+
* @return BaseHtml
109+
*/
96110
public function _ajaxOn($operation, $event, $url, $responseElement="", $parameters=array()) {
97111
$params=array ("url" => $url,"responseElement" => $responseElement );
98112
$params=array_merge($params, $parameters);

Ajax/semantic/html/collections/HtmlBreadcrumb.php

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,9 +63,8 @@ public function __construct($identifier, $items=array(), $autoActive=true, $star
6363

6464
/**
6565
* Associate an ajax get to the breadcrumb elements, displayed in $targetSelector
66-
* $attr member is used to build each element url
66+
* $this->attr member is used to build each element url
6767
* @param string $targetSelector the target of the get
68-
* @param string $attr the html attribute used to build the elements url
6968
* @return HtmlBreadcrumbs
7069
*/
7170
public function autoGetOnClick($targetSelector) {

Ajax/semantic/html/collections/form/traits/CheckboxTrait.php

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,7 @@
44

55
use Ajax\semantic\html\base\constants\CheckboxType;
66
use Ajax\semantic\html\modules\checkbox\AbstractCheckbox;
7+
use Ajax\semantic\html\collections\form\HtmlFormField;
78

89
/**
910
* @author jc
@@ -22,7 +23,7 @@ public function setType($checkboxType) {
2223
* Attach $this to $selector and fire $action
2324
* @param string $selector jquery selector of the associated element
2425
* @param string $action action to execute : check, uncheck or NULL for toggle
25-
* @return \Ajax\semantic\html\collections\form\AbstractHtmlFormRadioCheckbox
26+
* @return HtmlFormField
2627
*/
2728
public function attachEvent($selector, $action=NULL) {
2829
return $this->getHtmlCk()->attachEvent($selector, $action);
@@ -31,7 +32,7 @@ public function attachEvent($selector, $action=NULL) {
3132
/**
3233
* Attach $this to an array of $action=>$selector
3334
* @param array $events associative array of events to attach ex : ["#bt-toggle","check"=>"#bt-check","uncheck"=>"#bt-uncheck"]
34-
* @return \Ajax\semantic\html\collections\form\AbstractHtmlFormRadioCheckbox
35+
* @return HtmlFormField
3536
*/
3637
public function attachEvents($events=array()) {
3738
return $this->getHtmlCk()->attachEvents($events);
@@ -55,7 +56,7 @@ public function getDataField(){
5556
/**
5657
* Check the checkbox
5758
* @param boolean $value
58-
* @return \Ajax\semantic\html\collections\form\traits\CheckboxTrait
59+
* @return HtmlFormField
5960
*/
6061
public function setChecked($value=true){
6162
if($value===true){

Ajax/semantic/html/collections/form/traits/FieldTrait.php

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ abstract public function addToProperty($name, $value, $separator=" ");
1818
abstract public function addLabel($caption, $style="label-default", $leftSeparator=" ");
1919
abstract public function addContent($content,$before=false);
2020
abstract public function getField();
21+
abstract public function getItem($index);
22+
abstract public function getDataField();
23+
2124
public function setFocus() {
2225
$this->getField()->addToProperty("class", State::FOCUS);
2326
}

Ajax/semantic/html/content/HtmlListItem.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -33,7 +33,7 @@ protected function initContent($content){
3333
}
3434
if(isset($title)){
3535
$this->setTitle($title,$desc);
36-
}elseif (isset($header)===true){
36+
}elseif (isset($header)){
3737
$this->setTitle($header,$desc,"header");
3838
}
3939
if(isset($items)){

Ajax/semantic/html/content/table/HtmlTableContent.php

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,8 +74,12 @@ public function addRow($colCount) {
7474
return $this->addItem($colCount);
7575
}
7676

77+
/**
78+
* @param mixed $row
79+
* @return HtmlTR
80+
*/
7781
public function _addRow($row) {
78-
$this->addItem($row);
82+
return $this->addItem($row);
7983
}
8084

8185
/**

Ajax/semantic/html/elements/HtmlButton.php

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ public function asSubmit() {
9898

9999
/**
100100
* Add and return a button label
101-
* @param string $caption
101+
* @param string $label
102102
* @param boolean $before
103103
* @param string $icon
104104
* @return \Ajax\semantic\html\elements\HtmlLabel

0 commit comments

Comments
 (0)