dallgoot /
yaml
Complex classes like Builder often do a lot of different things. To break such a class down, we need to identify a cohesive component within that class. A common approach to find such a component is to look for fields/methods that share the same prefixes, or suffixes. You can also have a look at the cohesion graph to spot any un-connected, or weakly-connected components.
Once you have determined the fields that belong together, you can apply the Extract Class refactoring. If the component makes sense as a sub-class, Extract Subclass is also a candidate, and is often faster.
While breaking up the class, it is a good idea to analyze how other classes use Builder, and based on these observations, apply Extract Interface, too.
| 1 | <?php |
||
| 14 | final class Builder |
||
| 15 | { |
||
| 16 | private static $_root; |
||
|
|
|||
| 17 | private static $_debug; |
||
| 18 | |||
| 19 | const ERROR_NO_KEYNAME = self::class.": key has NO IDENTIFIER on line %d"; |
||
| 20 | const INVALID_DOCUMENT = self::class.": DOCUMENT %d can NOT be a mapping AND a sequence"; |
||
| 21 | |||
| 22 | /** |
||
| 23 | * Builds a file. check multiple documents & split if more than one documents |
||
| 24 | * |
||
| 25 | * @param Node $_root The root node : Node with Node->type === YAML::ROOT |
||
| 26 | * @param int $_debug the level of debugging requested |
||
| 27 | * |
||
| 28 | * @return array|YamlObject list of documents or just one. |
||
| 29 | * @todo implement splitting on YAML::DOC_END also |
||
| 30 | */ |
||
| 31 | public static function buildContent(Node $_root, int $_debug) |
||
| 60 | |||
| 61 | /** |
||
| 62 | * Generic function to distinguish between Node and NodeList |
||
| 63 | * |
||
| 64 | * @param Node|NodeList $node The node. |
||
| 65 | * @param mixed $parent The parent |
||
| 66 | * |
||
| 67 | * @return mixed ( description_of_the_return_value ) |
||
| 68 | */ |
||
| 69 | private static function build(object $node, &$parent = null) |
||
| 74 | |||
| 75 | /** |
||
| 76 | * Builds a node list. |
||
| 77 | * |
||
| 78 | * @param NodeList $node The node |
||
| 79 | * @param mixed $parent The parent |
||
| 80 | * |
||
| 81 | * @return mixed The parent (object|array) or a string representing the NodeList. |
||
| 82 | */ |
||
| 83 | private static function buildNodeList(NodeList $node, &$parent=null) |
||
| 116 | |||
| 117 | /** |
||
| 118 | * Builds a node. |
||
| 119 | * |
||
| 120 | * @param Node $node The node of any Node->type |
||
| 121 | * @param mixed $parent The parent |
||
| 122 | * |
||
| 123 | * @return mixed The node value as scalar, array or object or null to otherwise. |
||
| 124 | */ |
||
| 125 | private static function buildNode(Node $node, &$parent) |
||
| 153 | |||
| 154 | /** |
||
| 155 | * Builds a key and set the property + value to the given parent |
||
| 156 | * |
||
| 157 | * @param Node $node The node with type YAML::KEY |
||
| 158 | * @param object|array $parent The parent |
||
| 159 | * |
||
| 160 | * @throws \ParseError if Key has no name(identifier) Note: empty string is allowed |
||
| 161 | * @return null |
||
| 162 | */ |
||
| 163 | private static function buildKey(Node $node, &$parent=null) |
||
| 198 | |||
| 199 | /** |
||
| 200 | * Builds an item. Adds the item value to the parent array|Iterator |
||
| 201 | * |
||
| 202 | * @param Node $node The node with type YAML::ITEM |
||
| 203 | * @param array|\Iterator $parent The parent |
||
| 204 | * |
||
| 205 | * @throws \Exception if parent is another type than array or object Iterator |
||
| 206 | * @return null |
||
| 207 | */ |
||
| 208 | private static function buildItem(Node $node, &$parent) |
||
| 232 | |||
| 233 | |||
| 234 | /** |
||
| 235 | * Builds a litteral (folded or not) or any NodeList that has YAML::RAW type (like a multiline value) |
||
| 236 | * |
||
| 237 | * @param NodeList $children The children |
||
| 238 | * @param integer $type The type |
||
| 239 | * |
||
| 240 | * @return string The litteral. |
||
| 241 | * @todo : Example 6.1. Indentation Spaces spaces must be considered as content |
||
| 242 | */ |
||
| 243 | private static function buildLitteral(NodeList $list, int $type):string |
||
| 272 | |||
| 273 | /** |
||
| 274 | * Builds a set key. |
||
| 275 | * |
||
| 276 | * @param Node $node The node of type YAML::SET_KEY. |
||
| 277 | * @param object $parent The parent |
||
| 278 | * |
||
| 279 | * @throws \Exception if a problem occurs during serialisation (json format) of the key |
||
| 280 | */ |
||
| 281 | private function buildSetKey(Node $node, &$parent) |
||
| 289 | |||
| 290 | /** |
||
| 291 | * Builds a set value. |
||
| 292 | * |
||
| 293 | * @param Node $node The node of type YAML::SET_VALUE |
||
| 294 | * @param object $parent The parent (the document object or any previous object created through a mapping key) |
||
| 295 | */ |
||
| 296 | private function buildSetValue(Node $node, &$parent) |
||
| 307 | |||
| 308 | /** |
||
| 309 | * Builds a tag and its value (also built) and encapsulates them in a Tag object. |
||
| 310 | * |
||
| 311 | * @param Node $node The node of type YAML::TAG |
||
| 312 | * @param mixed $parent The parent |
||
| 313 | * |
||
| 314 | * @return Tag|null The tag object of class Dallgoot\Yaml\Tag. |
||
| 315 | */ |
||
| 316 | private static function buildTag(Node $node, &$parent) |
||
| 342 | |||
| 343 | /** |
||
| 344 | * Builds a directive. NOT IMPLEMENTED YET |
||
| 345 | * |
||
| 346 | * @param Node $node The node |
||
| 347 | * @param mixed $parent The parent |
||
| 348 | * @todo implement if requested |
||
| 349 | */ |
||
| 350 | private function buildDirective(Node $node, $parent) |
||
| 354 | } |
||
| 355 |
Loading history...
This check examines a number of code elements and verifies that they conform to the given naming conventions.
You can set conventions for local variables, abstract classes, utility classes, constant, properties, methods, parameters, interfaces, classes, exceptions and special methods.