DocBlockParamHelpers::parseParamDescription() - Code Metrics - Inspection of "First implementation of plugin architecture" - mpociot/laravel-apidoc-generator - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#570)

by Marcel

created 2019-09-07 14:44 UTC

DocBlockParamHelpers::parseParamDescription() A

↳ Parent: DocBlockParamHelpers

Complexity

Conditions	2
Paths	2

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	12
rs	9.8666
c	0
b	0
f	0
cc	2
nc	2
nop	2

<?php

namespace Mpociot\ApiDoc\Tools\Traits;

use Mpociot\Reflection\DocBlock\Tag;

trait DocBlockParamHelpers
{
    use ParamHelpers;

    /**
     * Allows users to specify that we shouldn't generate an example for the parameter
     * by writing 'No-example'.
     *
     * @param Tag $tag
     *
     * @return bool Whether no example should be generated
     */
    protected function shouldExcludeExample(Tag $tag)
    {
        return strpos($tag->getContent(), ' No-example') !== false;
    }

    /**
     * Allows users to specify an example for the parameter by writing 'Example: the-example',
     * to be used in example requests and response calls.
     *
     * @param string $description
     * @param string $type The type of the parameter. Used to cast the example provided, if any.
     *
     * @return array The description and included example.
     */
    protected function parseParamDescription(string $description, string $type)
    {
        $example = null;
        if (preg_match('/(.*)\s+Example:\s*(.*)\s*/', $description, $content)) {
            $description = $content[1];

            // examples are parsed as strings by default, we need to cast them properly
            $example = $this->castToType($content[2], $type);
        }

        return [$description, $example];
    }
}


1			<?php
2
3			namespace Mpociot\ApiDoc\Tools\Traits;
4
5			use Mpociot\Reflection\DocBlock\Tag;
6
7			trait DocBlockParamHelpers
8			{
9			use ParamHelpers;
10
11			/**
12			* Allows users to specify that we shouldn't generate an example for the parameter
13			* by writing 'No-example'.
14			*
15			* @param Tag $tag
16			*
17			* @return bool Whether no example should be generated
18			*/
19			protected function shouldExcludeExample(Tag $tag)
20			{
21			return strpos($tag->getContent(), ' No-example') !== false;
22			}
23
24			/**
25			* Allows users to specify an example for the parameter by writing 'Example: the-example',
26			* to be used in example requests and response calls.
27			*
28			* @param string $description
29			* @param string $type The type of the parameter. Used to cast the example provided, if any.
30			*
31			* @return array The description and included example.
32			*/
33			protected function parseParamDescription(string $description, string $type)
34			{
35			$example = null;
36			if (preg_match('/(.)\s+Example:\s(.)\s/', $description, $content)) {
37			$description = $content[1];
38
39			// examples are parsed as strings by default, we need to cast them properly
40			$example = $this->castToType($content[2], $type);
41			}
42
43			return [$description, $example];
44			}
45			}
46

mpociot / laravel-apidoc-generator

Pull Request — master (#570)

DocBlockParamHelpers::parseParamDescription() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like