This repository has been archived by the owner on Jun 8, 2022. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 6
/
index.html
614 lines (522 loc) · 12.9 KB
/
index.html
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
<!DOCTYPE html>
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>PhpDoc2Cheatsheet</title>
<meta name="description" content="Cheatsheet for phpDocumentor">
<meta name="keywords" content="phpDocumentor, php documentor, documentation php, documentation generator for php">
<meta name="author" content="Jose Ruzafa">
<link rel="stylesheet" type="text/css" href="css/stylesheet.css" media="all">
<link rel="stylesheet" type="text/css" href="css/bootstrap.min.css" media="all">
<link rel="stylesheet" type="text/css" href="css/vendor.css" media="all">
</head>
<body id="top">
<script type="text/javascript">
var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-41784445-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();
</script>
<div id="ribbon">
<a href="https://github.com/jruzafa/PhpDoc2Cheatsheet" onclick="_gaq.push(['_trackEvent', 'Tolls', 'Github repo link']);">
<img style="position: absolute; top: 0; right: 0; border: 0;" src="images/forkme_right_red_aa0000.png" alt="Fork me on GitHub" width="149" height="149"></a>
</div>
<div id="container" class="container">
<div class="inner">
<div id="controller">
<header>
<div id="title">PhpDoc2Cheatsheet</div>
<h1>Lot of Code Snippets for phpDocumentor</h1>
</header>
<div class="nav-container" style="height: auto;">
<nav class="" style="top: 0px;">
<ul class="nav nav-pills">
<li>
<a href="#" onclick="_gaq.push(['_trackEvent', 'Menu', 'File']);">File</a>
</li>
<li>
<a href="#variable" onclick="_gaq.push(['_trackEvent', 'Menu', 'Variable']);">Variable</a>
</li>
<li>
<a href="#class" onclick="_gaq.push(['_trackEvent', 'Menu', 'Class']);">Class</a>
</li>
<li>
<a href="#function" onclick="_gaq.push(['_trackEvent', 'Menu', 'Function']);">Function</a>
</li>
<li>
<a href="#tags" onclick="_gaq.push(['_trackEvent', 'Menu', 'Tags']);">Tags</a>
</li>
<li>
<a href="#arrays" onclick="_gaq.push(['_trackEvent', 'Menu', 'Arrays']);">Arrays</a>
</li>
<li>
<a href="#mult_types" onclick="_gaq.push(['_trackEvent', 'Menu', 'Tags']);">Multiple types</a>
</li>
</ul>
</nav>
</div>
<section id="main_content">
<!--- ############# FILE ########## -->
<section>
<h2 id="controllers">FILE<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<pre><code>/** File docBlock description
*
* This block demonstrates the rich
* information that can be included
* in in-code documentation through
* DocBlocks and tags
* @author Jane Doe <jdoe@php.net>
* @version 1.0
* @package sample
*/</code></pre>
</div>
</div>
</section>
<!--- ############# VARIABLE ########## -->
<section>
<h2 id="variable">VARIABLE<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<h4>Elements</h4>
<pre>
<code>/**
* Global variable declaration docBlock
* @global integer $GLOBALS['_myvar']
* @name $_myvar
*/
$GLOBALS['_myvar'] = 6;
</code>
</pre>
</div>
</div>
</section>
<!--- ############# CLASS ########## -->
<section>
<h2 id="class">CLASS<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<pre>
<code>/**
* An example class, this is grouped with
* other classes in the "sample" package and
* is part of "classes" subpackage
* @package sample
* @subpackage classes
*/
class myclass {
...
}
</code>
</pre>
</div>
</div>
</section>
<!--- ############# FUNCTION ########## -->
<section>
<h2 id="function">FUNCTION<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<pre>
<code>/**
* A sample function docblock
* @global string document the use $_myvar
* @staticvar integer $staticvar is returned
* @param string $param1 name to declare
* @param string $param2 value of the name
* @return integer
*/
function aFunc($param1, $param2='optional') {
static $staticvar = 7;
global $_myvar;
return $staticvar;
}
</code>
</pre>
</div>
</div>
</section>
<!--- ############# TAGS ########## -->
<section>
<h2 id="tags">TAGS<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<h4>@api</h4>
<pre><code>/**
* This method will not change until a major release.
*
* @api
*
* @return void
*/
function showVersion()
{
<...>
}</code></pre>
<h4>@author</h4>
<pre><code>/**
* @author My Name
* @author My Name <my.name@example.com>
*/</code></pre>
<h4>@category</h4>
<pre><code>/**
* Page-Level DocBlock
*
* @category MyCategory
* @package MyPackage
*/</code></pre>
<h4>@copyright</h4>
<pre><code>/**
* @copyright 1997-2005 The PHP Group
*/</code></pre>
<h4>@deprecated</h4>
<pre><code>/**
* @deprecated
* @deprecated 1.0.0
* @deprecated No longer used by internal code and not recommended.
* @deprecated 1.0.0 No longer used by internal code and not recommended.
*/
function count()
{
<...>
}</code></pre>
<h4>@example</h4>
<pre><code>/**
* @example example1.php Counting in action.
* @example http://example.com/example2.phps Counting in action by a 3rd party.
* @example "My Own Example.php" My counting.
*/
function count()
{
<...>
}</code></pre>
<h4>@filesource</h4>
<pre><code>/**
* @filesource
*/</code></pre>
<h4>@global</h4>
<h5>This tag is not included in phpDocumentor 2.0</h5>
<pre><code>/**
*@global [Type] [name] @global [Type] [description]*/
</code></pre>
<h4>@ignore</h4>
<pre><code>if ($ostest) {
/**
* This define will either be 'Unix' or 'Windows'
*/
define("OS","Unix");
} else {
/**
* @ignore
*/
define("OS","Windows");
}</code></pre>
<h4>@internal</h4>
<pre><code>/**
* @internal
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}</code></pre>
<h4>@link</h4>
<h5>Normal tag:</h5>
<pre><code>/**
* @link http://example.com/my/bar Documentation of Foo.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}
</code></pre>
<h5>Inline tag:</h5>
<pre><code>/**
* This method counts the occurrences of Foo.
*
* When no more Foo ({@link http://example.com/my/bar}) are given this
* function will add one as there must always be one Foo.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}</code></pre>
<h4>@license</h4>
<pre><code>/**
* @license GPL
* @license http://opensource.org/licenses/gpl-license.php GNU Public License
*/</code></pre>
<h4>@method</h4>
<pre><code>class Parent
{
public function __call()
{
<...>
}
}
/**
* @method string getString()
* @method void setInteger(integer $integer)
* @method setString(integer $integer)
*/
class Child extends Parent
{
<...>
}</code></pre>
<h4>@package</h4>
<pre><code>/**
* @package PSR\Documentation\API
*/</code></pre>
<h4>@param</h4>
<pre><code>/**
* Counts the number of items in the provided array.
*
* @param mixed[] $array Array structure to count the elements of.
*
* @return int Returns the number of elements.
*/
function count(array $items)
{
<...>
}</code></pre>
</div>
<div class="span6">
<h4>@property</h4>
<pre><code> class Parent
{
public function __get()
{
<...>
}
}
/**
* @property string $myProperty
*/
class Child extends Parent
{
<...>
}</code></pre>
<h4>@property-read</h4>
<pre><code>class Parent {
public function __get()
{
<...>
}
}
/**
* @property-read string $myProperty
*/
class Child extends Parent
{
<...>
}</code></pre>
<h4>@property-write</h4>
<pre><code>class Parent
{
public function __set()
{
<...>
}
}
/**
* @property-write string $myProperty
*/
class Child extends Parent
{
<...>
}</code></pre>
<h4>@return (Singular type)</h4>
<pre><code>/**
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}</code></pre>
<h4>@return (two types)</h4>
<pre><code>/**
* @return string|null The label's text or null if none provided.
*/
function getLabel()
{
<...>
}</code></pre>
<h4>@see</h4>
<pre><code>/**
* @see http://example.com/my/bar Documentation of Foo.
* @see MyClass::$items for the property whose items are counted
* @see MyClass::setItems() to set the items for this collection.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}</code></pre>
<h4>@since</h4>
<pre><code>/**
* @since 1.0.1 First time this was introduced.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}
/**
* @since 1.0.2 Added the $b argument.
* @since 1.0.1 Added the $a argument.
* @since 1.0.0
*
* @return void
*/
function dump($a, $b)
{
<...>
}</code></pre>
<h4>@source</h4>
<pre><code>/**
* @source 2 1 Check that ensures lazy counting.
*/
function count()
{
if (null === $this->count) {
<...>
}
}</code></pre>
<h4>@subpackage</h4>
<pre><code>/**
* @package PSR
* @subpackage Documentation\API
*/</code></pre>
<h4>@throws</h4>
<pre><code>/**
* Counts the number of items in the provided array.
*
* @param mixed[] $array Array structure to count the elements of.
*
* @throws InvalidArgumentException if the provided argument is not of type
* 'array'.
*
* @return int Returns the number of elements.
*/
function count($items)
{
<...>
}</code></pre>
<h4>@todo</h4>
<pre><code>/**
* Counts the number of items in the provided array.
*
* @todo add an array parameter to count
*
* @return int Returns the number of elements.
*/
function count()
{
<...>
}</code></pre>
<h4>@uses & @used-by</h4>
<pre><code>/**
* @uses MyClass::$items to retrieve the count from.
*
* @return integer Indicates the number of items.
*/
function count()
{
<...>
}</code></pre>
<h4>@version</h4>
<pre><code>/**
* @version 1.0.1
*/
class Counter
{
<...>
}
/**
* @version GIT: $Id$ In development. Very unstable.
*/
class NeoCounter
{
<...>
}</code></pre>
</div>
</div>
</section>
</section>
<!-- End Main -->
</section>
<!--- ############# ARRAYS ########## -->
<section>
<h2 id="arrays">ARRAYS<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<h4>unspecified:</h4>
<pre>
<code>@return array</code>
</pre>
</div>
</div>
<div class="row">
<div class="span6">
<h4>specified containing a single type:</h4>
<pre>
<code>@return int[]</code>
</pre>
</div>
</div>
<div class="row">
<div class="span6">
<h4>specified containing multiple types:</h4>
<pre>
<code>@return (int|string)[]</code>
</pre>
</div>
</div>
</section>
<!--- ############# MULTIPLE TYPES ########## -->
<section>
<h2 id="mult_types">MULTIPLE TYPES<a href="#top" class="small">back to top</a></h2>
<hr>
<div class="row">
<div class="span6">
<pre>
<code>@return int|null </code>
</pre>
</div>
</div>
</section>
</div>
</div>
<footer>
<div class="row">
<div class="span9">
PhpDoc2Cheatsheet by
<a href="https://twitter.com/jruzafa">jruzafa</a><br>
</div>
</div>
</footer>
</div>
<script type="text/javascript" src="js/jquery.js"></script>
<script type="text/javascript" src="js/waypoints.min.js"></script>
<script type="text/javascript" src="js/navbar2.js"></script>
<a href="#" id="toTop" style="display: none;"><span id="toTopHover"></span>To Top</a>
</body>
</html>