|
| 1 | +## 📦 Class axelhahn\phpclassparser |
| 2 | + |
| 3 | +```txt |
| 4 | +
|
| 5 | + PHP CLASS PARSER |
| 6 | +
|
| 7 | + @author axelhahn |
| 8 | + @license GNU GPL 3.0 |
| 9 | +
|
| 10 | + @source <https://github.com/axelhahn/php-classdoc> |
| 11 | +
|
| 12 | + 2024-07-15 v0.1 axelhahn initial version |
| 13 | +
|
| 14 | +``` |
| 15 | + |
| 16 | +## 🔶 Properties |
| 17 | + |
| 18 | +(none) |
| 19 | + |
| 20 | +## 🔷 Methods |
| 21 | + |
| 22 | +### 🔹 public __construct() |
| 23 | + |
| 24 | +Constructs a new instance of the class. |
| 25 | + |
| 26 | +Line [38](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L38) (5 lines) |
| 27 | + |
| 28 | +**Return**: `void` |
| 29 | + |
| 30 | +**Parameters**: **1** (required: 0) |
| 31 | + |
| 32 | +| Parameter | Type | Description |
| 33 | +|-- |-- |-- |
| 34 | +| \<optional\> $sClassname | `string` | optional: The name of the class. Default is an empty string. |
| 35 | + |
| 36 | +### 🔹 public getClassInfos() |
| 37 | + |
| 38 | +Get metainformation for the class |
| 39 | + |
| 40 | +Line [154](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L154) (15 lines) |
| 41 | + |
| 42 | +**Return**: `array` |
| 43 | + |
| 44 | +**Parameters**: **0** (required: 0) |
| 45 | + |
| 46 | +### 🔹 public getMethods() |
| 47 | + |
| 48 | +Get a hash of methods with its type, parameters, phpdoc infos |
| 49 | + |
| 50 | +Line [175](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L175) (116 lines) |
| 51 | + |
| 52 | +**Return**: `array` |
| 53 | + |
| 54 | +**Parameters**: **1** (required: 0) |
| 55 | + |
| 56 | +| Parameter | Type | Description |
| 57 | +|-- |-- |-- |
| 58 | +| \<optional\> $bPublicOnly | `flag: *` | flag: public only methods or all; default: true (=only public methods) |
| 59 | + |
| 60 | +### 🔹 public getProperties() |
| 61 | + |
| 62 | +Get a hash of properties with its type, phpdoc infos, default value, attributes, etc. |
| 63 | + |
| 64 | +Line [299](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L299) (66 lines) |
| 65 | + |
| 66 | +**Return**: `array` |
| 67 | + |
| 68 | +**Parameters**: **1** (required: 0) |
| 69 | + |
| 70 | +| Parameter | Type | Description |
| 71 | +|-- |-- |-- |
| 72 | +| \<optional\> $bPublicOnly | `flag: *` | flag: public only properties or all; default: true (=only public properties) |
| 73 | + |
| 74 | +### 🔹 public setClassFile() |
| 75 | + |
| 76 | +Sets the class file to be analyzed. |
| 77 | + It will detect namespace and class name to initialize the class. |
| 78 | + |
| 79 | +Line [51](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L51) (74 lines) |
| 80 | + |
| 81 | +**Return**: `string|bool` |
| 82 | + |
| 83 | +**Parameters**: **1** (required: 1) |
| 84 | + |
| 85 | +| Parameter | Type | Description |
| 86 | +|-- |-- |-- |
| 87 | +| \<required\> $file | `string` | The path to the class file. |
| 88 | + |
| 89 | +### 🔹 public setClassname() |
| 90 | + |
| 91 | +Set a classname. |
| 92 | + You can use that method directly if the class file was loaded before. |
| 93 | + Or use setClassFile() to load the class file and detect the classname. |
| 94 | + @see setClassFile() |
| 95 | + |
| 96 | +Line [134](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L134) (10 lines) |
| 97 | + |
| 98 | +**Return**: `void` |
| 99 | + |
| 100 | +**Parameters**: **1** (required: 1) |
| 101 | + |
| 102 | +| Parameter | Type | Description |
| 103 | +|-- |-- |-- |
| 104 | +| \<required\> $sClassname | `string` | classname to access for doc generation |
| 105 | + |
| 106 | +### 🔹 public setSourceUrl() |
| 107 | + |
| 108 | + |
| 109 | + |
| 110 | +Line [145](https://github.com/axelhahn/php-classdoc//blob/main/src/phpclass-parser.class.php#L145) (4 lines) |
| 111 | + |
| 112 | +**Return**: `void` |
| 113 | + |
| 114 | +**Parameters**: **1** (required: 1) |
| 115 | + |
| 116 | +| Parameter | Type | Description |
| 117 | +|-- |-- |-- |
| 118 | +| \<required\> $sSourceUrl | `string` | |
| 119 | + |
| 120 | +--- |
| 121 | +Generated with [Axels PHP class doc parser](https://github.com/axelhahn/php-classdoc) |
0 commit comments