Chris@13: 'info', Chris@13: 'var' => 'strong', Chris@13: ]; Chris@13: Chris@13: /** Chris@13: * Format a docblock. Chris@13: * Chris@13: * @param \Reflector $reflector Chris@13: * Chris@13: * @return string Formatted docblock Chris@13: */ Chris@13: public static function format(\Reflector $reflector) Chris@13: { Chris@13: $docblock = new Docblock($reflector); Chris@13: $chunks = []; Chris@13: Chris@13: if (!empty($docblock->desc)) { Chris@13: $chunks[] = 'Description:'; Chris@13: $chunks[] = self::indent(OutputFormatter::escape($docblock->desc), ' '); Chris@13: $chunks[] = ''; Chris@13: } Chris@13: Chris@13: if (!empty($docblock->tags)) { Chris@13: foreach ($docblock::$vectors as $name => $vector) { Chris@13: if (isset($docblock->tags[$name])) { Chris@17: $chunks[] = \sprintf('%s:', self::inflect($name)); Chris@13: $chunks[] = self::formatVector($vector, $docblock->tags[$name]); Chris@13: $chunks[] = ''; Chris@13: } Chris@13: } Chris@13: Chris@17: $tags = self::formatTags(\array_keys($docblock::$vectors), $docblock->tags); Chris@13: if (!empty($tags)) { Chris@13: $chunks[] = $tags; Chris@13: $chunks[] = ''; Chris@13: } Chris@13: } Chris@13: Chris@17: return \rtrim(\implode("\n", $chunks)); Chris@13: } Chris@13: Chris@13: /** Chris@13: * Format a docblock vector, for example, `@throws`, `@param`, or `@return`. Chris@13: * Chris@13: * @see DocBlock::$vectors Chris@13: * Chris@13: * @param array $vector Chris@13: * @param array $lines Chris@13: * Chris@13: * @return string Chris@13: */ Chris@13: private static function formatVector(array $vector, array $lines) Chris@13: { Chris@13: $template = [' ']; Chris@13: foreach ($vector as $type) { Chris@13: $max = 0; Chris@13: foreach ($lines as $line) { Chris@13: $chunk = $line[$type]; Chris@17: $cur = empty($chunk) ? 0 : \strlen($chunk) + 1; Chris@13: if ($cur > $max) { Chris@13: $max = $cur; Chris@13: } Chris@13: } Chris@13: Chris@13: $template[] = self::getVectorParamTemplate($type, $max); Chris@13: } Chris@17: $template = \implode(' ', $template); Chris@13: Chris@17: return \implode("\n", \array_map(function ($line) use ($template) { Chris@17: $escaped = \array_map(['Symfony\Component\Console\Formatter\OutputFormatter', 'escape'], $line); Chris@13: Chris@17: return \rtrim(\vsprintf($template, $escaped)); Chris@13: }, $lines)); Chris@13: } Chris@13: Chris@13: /** Chris@13: * Format docblock tags. Chris@13: * Chris@13: * @param array $skip Tags to exclude Chris@13: * @param array $tags Tags to format Chris@13: * Chris@13: * @return string formatted tags Chris@13: */ Chris@13: private static function formatTags(array $skip, array $tags) Chris@13: { Chris@13: $chunks = []; Chris@13: Chris@13: foreach ($tags as $name => $values) { Chris@17: if (\in_array($name, $skip)) { Chris@13: continue; Chris@13: } Chris@13: Chris@13: foreach ($values as $value) { Chris@17: $chunks[] = \sprintf('%s%s %s', self::inflect($name), empty($value) ? '' : ':', OutputFormatter::escape($value)); Chris@13: } Chris@13: Chris@13: $chunks[] = ''; Chris@13: } Chris@13: Chris@17: return \implode("\n", $chunks); Chris@13: } Chris@13: Chris@13: /** Chris@13: * Get a docblock vector template. Chris@13: * Chris@13: * @param string $type Vector type Chris@13: * @param int $max Pad width Chris@13: * Chris@13: * @return string Chris@13: */ Chris@13: private static function getVectorParamTemplate($type, $max) Chris@13: { Chris@13: if (!isset(self::$vectorParamTemplates[$type])) { Chris@17: return \sprintf('%%-%ds', $max); Chris@13: } Chris@13: Chris@17: return \sprintf('<%s>%%-%ds', self::$vectorParamTemplates[$type], $max, self::$vectorParamTemplates[$type]); Chris@13: } Chris@13: Chris@13: /** Chris@13: * Indent a string. Chris@13: * Chris@13: * @param string $text String to indent Chris@13: * @param string $indent (default: ' ') Chris@13: * Chris@13: * @return string Chris@13: */ Chris@13: private static function indent($text, $indent = ' ') Chris@13: { Chris@17: return $indent . \str_replace("\n", "\n" . $indent, $text); Chris@13: } Chris@13: Chris@13: /** Chris@13: * Convert underscored or whitespace separated words into sentence case. Chris@13: * Chris@13: * @param string $text Chris@13: * Chris@13: * @return string Chris@13: */ Chris@13: private static function inflect($text) Chris@13: { Chris@17: $words = \trim(\preg_replace('/[\s_-]+/', ' ', \preg_replace('/([a-z])([A-Z])/', '$1 $2', $text))); Chris@13: Chris@17: return \implode(' ', \array_map('ucfirst', \explode(' ', $words))); Chris@13: } Chris@13: }