Serialized Strings
Serialized Strings are very hard to read. This tries to make it a little bit easier
by highlighting certain parts of the string while making others unobtrusive.
visit HLI#X
1. pre(serialize($Test)) type: string
in builder\plugins\serializedDump.php on line 18 5 if (!include
dirname(__FILE__).'/../../globals.php') {
6 return;
7 }
8 echo $head;
9 ?>
10
11
12 <p>
13 Serialized Strings are very hard to read. This tries to make it a little bit easier
14 by highlighting certain parts of the string while making others unobtrusive.
15 </p>
16 <?php
17 $Test = new Test;
18 pre(serialize($Test));
19 ?>
20 <p>
21 You can compare this string with the following object. They are identical.
22 </p>
23 <?php
24 pre($Test);
25 ?>
26 <?php
27 echo foot();
28 ?> O:4:"Test":4:{s:10:" Test null";N;s:8:" * array";a:6:{s:5:"hello";s:5:"world";i:0;i:1;i:1;i:2;i:2;d:.35;i:3;b:0;i:4;s:0:"";}s:8:" * test2";O:5:"Test2":1:{s:9:" * array2";a:1:{s:3:"HLI";s:5:"Haily";}}s:9:" * array2";a:1:{s:3:"HLI";s:5:"Haily";}}
/
*** global scope ***
You can compare this string with the following object. They are identical.
visit HLI#X
2. pre($Test) type: Test (object) user-class Test
extends Test2
implements TestInterface
D:\my_files\Webentwicklung\public_html\TuLib\HLI.devel\examples\testclasses.php line 59
+ A test class for demonstration of HLI.
This class is used to demonstrate some object-related features of HLI.
Here you see all PHPDoc tags available. Note that some of these are unwarrantedly used on this class. Also, the undocumented tag "throws" is supported, too.
See the Test::test() method for tags only available to methods and functions.
See Test::__construct() for inline tags
abstract
access: public
author: Thomas Forster <thc@forestfactory.de>
category: CAT
copyright: 2007 by Thomas Forster
deprecated: Do not use this class!
example: example/file.php
final
license: http://www.gnu.org/licenses/lgpl.html GNU Lesser General Public License 2.1 and following
link: http://www.example.com, http://www.example.org
name: $theName
package: Test_Package
see: main_class, TEST_CONST
see: subclass
see: func()
see: subclass::$foo, subclass::bar()
since: version 0.1
subpackage: Test_Subpackage
todo: Something todo
uses: Test2
var: string
version: 0.1
members
− static public
+ $spub
Members can be documented, too
methods
− public
+ __construct()
− Examples for inline PHPDoc tags
is displayed plain.
The , and tags are ignored, as they are only for tutorials.
{@internal tags as always displayed as you surly are "internal" if you use HLI }}
is not supported at the moment, but it will follow.
ToSomeFunction() is just highlighted and displayed. is ignored as the function code is always available.
+ Source
function __construct() {
$this->test2 = new Test2;
self::$staticTest2 = new Test2;
}
D:\my_files\Webentwicklung\public_html\TuLib\HLI.devel\examples\testclasses.php line 89
+ method([$bool = false], [$test = NULL])
− An example method
Here you see all PHPDoc tags that can only be used on methods:
param: bool $bool A boolean variable
param: Test $test
return: bool|Test Depending on input params
throws: Exception Thrown if $bool is false and $test is not of type Test
+ Source
function method($bool = false, Test $test = null)
{
if (!$bool and $test instanceof Test) {
throw new Exception('bool must be false');
}
if ($test) {
return $test;
}
return $bool;
}
D:\my_files\Webentwicklung\public_html\TuLib\HLI.devel\examples\testclasses.php line 103
in builder\plugins\serializedDump.php on line 2411
12 <p>
13 Serialized Strings are very hard to read. This tries to make it a little bit easier
14 by highlighting certain parts of the string while making others unobtrusive.
15 </p>
16 <?php
17 $Test = new Test;
18 pre(serialize($Test));
19 ?>
20 <p>
21 You can compare this string with the following object. They are identical.
22 </p>
23 <?php
24 pre($Test);
25 ?>
26 <?php
27 echo foot();
28 ?> − Test {
static public $spub = 'static public'
static protected $sprot = 'static protected'
static private $spriv = *** unreadable ***
static protected $staticTest2 = Test2
protected $array = − Array (
'hello' => 'world',
0 => 1,
1 => 2,
2 => 3.5,
3 => false,
4 => ''
)
protected $test2 = − Test2 {
protected $array2 = − Array (
'HLI' => 'Haily'
)
}
protected $array2 = − Array (
'HLI' => 'Haily'
)
private $null = NULL
}
/
*** global scope ***