Skip to content

Commit 6ca0fcf

Browse files
committed
return types for doc
1 parent 3509848 commit 6ca0fcf

File tree

4 files changed

+66
-0
lines changed

4 files changed

+66
-0
lines changed

Ajax/semantic/traits/SemanticComponentsTrait.php

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,30 +59,65 @@ public function accordion($attachTo=NULL, $params=NULL) {
5959
return $this->addComponent(new Accordion($this->js), $attachTo, $params);
6060
}
6161

62+
/**
63+
* @param string $attachTo
64+
* @param string|array $params
65+
* @return Sticky
66+
*/
6267
public function sticky($attachTo=NULL, $params=NULL) {
6368
return $this->addComponent(new Sticky($this->js), $attachTo, $params);
6469
}
6570

71+
/**
72+
* @param string $attachTo
73+
* @param string|array $params
74+
* @return Checkbox
75+
*/
6676
public function checkbox($attachTo=NULL, $params=NULL) {
6777
return $this->addComponent(new Checkbox($this->js), $attachTo, $params);
6878
}
6979

80+
/**
81+
* @param string $attachTo
82+
* @param string|array $params
83+
* @return Rating
84+
*/
7085
public function rating($attachTo=NULL, $params=NULL) {
7186
return $this->addComponent(new Rating($this->js), $attachTo, $params);
7287
}
7388

89+
/**
90+
* @param string $attachTo
91+
* @param string|array $params
92+
* @return Progress
93+
*/
7494
public function progress($attachTo=NULL, $params=NULL) {
7595
return $this->addComponent(new Progress($this->js), $attachTo, $params);
7696
}
7797

98+
/**
99+
* @param string $attachTo
100+
* @param string|array $params
101+
* @return Search
102+
*/
78103
public function search($attachTo=NULL, $params=NULL) {
79104
return $this->addComponent(new Search($this->js), $attachTo, $params);
80105
}
81106

107+
/**
108+
* @param string $attachTo
109+
* @param string|array $params
110+
* @return Dimmer
111+
*/
82112
public function dimmer($attachTo=NULL, $params=NULL) {
83113
return $this->addComponent(new Dimmer($this->js), $attachTo, $params);
84114
}
85115

116+
/**
117+
* @param string $attachTo
118+
* @param string|array $params
119+
* @return Modal
120+
*/
86121
public function modal($attachTo=NULL, $params=NULL,$paramsParts=NULL) {
87122
$result= $this->addComponent(new Modal($this->js), $attachTo, $params);
88123
$result->setParamParts($paramsParts);

Ajax/semantic/traits/SemanticHtmlCollectionsTrait.php

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@ public abstract function addHtmlComponent($htmlComponent);
1212
* @param string $identifier
1313
* @param int $rowCount
1414
* @param int $colCount
15+
* @return HtmlTable
1516
*/
1617
public function htmlTable($identifier, $rowCount, $colCount){
1718
return $this->addHtmlComponent(new HtmlTable($identifier, $rowCount, $colCount));

Ajax/semantic/traits/SemanticHtmlElementsTrait.php

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,13 @@ public function htmlIcon($identifier, $icon) {
9696
return $this->addHtmlComponent(new HtmlIcon($identifier, $icon));
9797
}
9898

99+
/**
100+
* @param string $identifier
101+
* @param string $src
102+
* @param string $alt
103+
* @param string $size
104+
* @return HtmlImage
105+
*/
99106
public function htmlImage($identifier, $src="", $alt="", $size=NULL) {
100107
return $this->addHtmlComponent(new HtmlImage($identifier, $src, $alt, $size));
101108
}
@@ -134,6 +141,12 @@ public function htmlLabel($identifier, $content="", $icon=NULL,$tagName="div") {
134141
return $this->addHtmlComponent(new HtmlLabel($identifier, $content,$icon, $tagName));
135142
}
136143

144+
/**
145+
* @param string $identifier
146+
* @param array $labels
147+
* @param array $attributes
148+
* @return HtmlLabelGroups
149+
*/
137150
public function htmlLabelGroups($identifier,$labels=array(),$attributes=array()){
138151
return $this->addHtmlComponent(new HtmlLabelGroups($identifier,$labels,$attributes));
139152
}
@@ -175,15 +188,26 @@ public function htmlSegmentGroups($identifier, $items=array()) {
175188
* @param string|HtmlSemDoubleElement $hiddenContent
176189
* @param RevealType|string $type
177190
* @param Direction|string $attributeType
191+
* @return HtmlReveal
178192
*/
179193
public function htmlReveal($identifier, $visibleContent, $hiddenContent, $type=RevealType::FADE, $attributeType=NULL) {
180194
return $this->addHtmlComponent(new HtmlReveal($identifier, $visibleContent, $hiddenContent, $type, $attributeType));
181195
}
182196

197+
/**
198+
* @param string $identifier
199+
* @param array $steps
200+
* @return HtmlStep
201+
*/
183202
public function htmlStep($identifier, $steps=array()) {
184203
return $this->addHtmlComponent(new HtmlStep($identifier, $steps));
185204
}
186205

206+
/**
207+
* @param string $identifier
208+
* @param string $flag
209+
* @return HtmlFlag
210+
*/
187211
public function htmlFlag($identifier, $flag) {
188212
return $this->addHtmlComponent(new HtmlFlag($identifier, $flag));
189213
}

Ajax/semantic/traits/SemanticHtmlViewsTrait.php

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,11 +12,17 @@ public abstract function addHtmlComponent($htmlComponent);
1212
/**
1313
*
1414
* @param string $identifier
15+
* @return HtmlCard
1516
*/
1617
public function htmlCard($identifier) {
1718
return $this->addHtmlComponent(new HtmlCard($identifier));
1819
}
1920

21+
/**
22+
* @param string $identifier
23+
* @param array $cards
24+
* @return HtmlCardGroups
25+
*/
2026
public function htmlCardGroups($identifier, $cards=array()) {
2127
return $this->addHtmlComponent(new HtmlCardGroups($identifier, $cards));
2228
}

0 commit comments

Comments
 (0)