3 +--------------------------------------------------------------------+
4 | Copyright CiviCRM LLC. All rights reserved. |
6 | This work is published under the GNU AGPLv3 license with some |
7 | permitted exceptions and without any warranty. For full license |
8 | and copyright information, see https://civicrm.org/licensing |
9 +--------------------------------------------------------------------+
12 namespace Civi\Api4\Utils
;
15 * Just another place to put static functions...
17 class ReflectionUtils
{
20 * @param \Reflector|\ReflectionClass $reflection
22 * If we are not reflecting the class itself, specify "Method", "Property", etc.
26 public static function getCodeDocs($reflection, $type = NULL) {
27 $docs = self
::parseDocBlock($reflection->getDocComment());
29 // Recurse into parent functions
30 if (isset($docs['inheritDoc']) ||
isset($docs['inheritdoc'])) {
31 unset($docs['inheritDoc'], $docs['inheritdoc']);
32 $newReflection = NULL;
35 $name = $reflection->getName();
36 $reflectionClass = $reflection->getDeclaringClass()->getParentClass();
37 if ($reflectionClass) {
38 $getItem = "get$type";
39 $newReflection = $reflectionClass->$getItem($name);
43 $newReflection = $reflection->getParentClass();
46 catch (\ReflectionException
$e) {
50 $additionalDocs = self
::getCodeDocs($newReflection, $type);
51 if (!empty($docs['comment']) && !empty($additionalDocs['comment'])) {
52 $docs['comment'] .= "\n\n" . $additionalDocs['comment'];
54 $docs +
= $additionalDocs;
61 * @param string $comment
64 public static function parseDocBlock($comment) {
66 foreach (preg_split("/((\r?\n)|(\r\n?))/", $comment) as $num => $line) {
67 if (!$num ||
strpos($line, '*/') !== FALSE) {
70 $line = ltrim(trim($line), '* ');
71 if (strpos($line, '@') === 0) {
72 $words = explode(' ', $line);
73 $key = substr($words[0], 1);
75 $info['type'] = explode('|', $words[1]);
77 elseif ($key == 'options') {
78 $val = str_replace(', ', ',', implode(' ', array_slice($words, 1)));
79 $info['options'] = explode(',', $val);
82 // Unrecognized annotation, but we'll duly add it to the info array
83 $val = implode(' ', array_slice($words, 1));
84 $info[$key] = strlen($val) ?
$val : TRUE;
88 $info['description'] = $line;
91 if (isset($info['comment'])) {
92 $info['comment'] .= "\n";
96 $info['comment'] = isset($info['comment']) ?
"{$info['comment']}\n$line" : $line;
99 if (isset($info['comment'])) {
100 $info['comment'] = trim($info['comment']);
106 * List all traits used by a class and its parents.
108 * @param object|string $class
111 public static function getTraits($class) {
113 // Get traits of this class + parent classes
115 $traits = array_merge(class_uses($class), $traits);
116 } while ($class = get_parent_class($class));
117 // Get traits of traits
118 foreach ($traits as $trait => $same) {
119 $traits = array_merge(class_uses($trait), $traits);