AssertStringTrait::assertString() - Code Metrics - Inspection of "Updated CHANGELOG.md" - TextControl/txtextcontrol-reportingcloud-php - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Push — master ( 315e77...e369d0 )

by Jonathan

created 2019-03-11 14:28 UTC

AssertStringTrait::assertString() A

↳ Parent: AssertStringTrait

Complexity

Conditions	3
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	5
CRAP Score	3

Importance

Changes

Metric	Value
eloc	4
dl	0
loc	6
ccs	5
cts	5
cp	1
rs	10
c	0
b	0
f	0
cc	3
nc	2
nop	2
crap	3

<?php
declare(strict_types=1);

/**
 * ReportingCloud PHP SDK
 *
 * PHP SDK for ReportingCloud Web API. Authored and supported by Text Control GmbH.
 *
 * @link      https://www.reporting.cloud to learn more about ReportingCloud
 * @link      https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
 * @license   https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
 * @copyright © 2019 Text Control GmbH
 */

namespace TxTextControl\ReportingCloud\Assert;

use TxTextControl\ReportingCloud\Exception\InvalidArgumentException;

/**
 * Trait AssertStringTrait
 *
 * @package TxTextControl\ReportingCloud
 * @author  Jonathan Maron (@JonathanMaron)
 */
trait AssertStringTrait
{
    /**
     * @param mixed $value
     *
     * @return string
     */
    abstract protected static function valueToString($value): string;

    /**
     * Check value is a string
     *
     * @param mixed  $value
     * @param string $message
     */
    public static function assertString($value, string $message = ''): void
    {
        if (!is_string($value)) {
            $format  = $message ?: 'Expected a string. Got: %1$s';
            $message = sprintf($format, self::valueToString($value));
            throw new InvalidArgumentException($message);
        }
    }
}


1		<?php
2		declare(strict_types=1);
3
4		/**
5		* ReportingCloud PHP SDK
6		*
7		* PHP SDK for ReportingCloud Web API. Authored and supported by Text Control GmbH.
8		*
9		* @link https://www.reporting.cloud to learn more about ReportingCloud
10		* @link https://github.com/TextControl/txtextcontrol-reportingcloud-php for the canonical source repository
11		* @license https://raw.githubusercontent.com/TextControl/txtextcontrol-reportingcloud-php/master/LICENSE.md
12		* @copyright © 2019 Text Control GmbH
13		*/
14
15		namespace TxTextControl\ReportingCloud\Assert;
16
17		use TxTextControl\ReportingCloud\Exception\InvalidArgumentException;
18
19		/**
20		* Trait AssertStringTrait
21		*
22		* @package TxTextControl\ReportingCloud
23		* @author Jonathan Maron (@JonathanMaron)
24		*/
25		trait AssertStringTrait
26		{
27		/**
28		* @param mixed $value
29		*
30		* @return string
31		*/
32		abstract protected static function valueToString($value): string;
33
34		/**
35		* Check value is a string
36		*
37		* @param mixed $value
38		* @param string $message
39		*/
40	12	public static function assertString($value, string $message = ''): void
41		{
42	12	if (!is_string($value)) {
43	9	$format = $message ?: 'Expected a string. Got: %1$s';
44	9	$message = sprintf($format, self::valueToString($value));
45	9	throw new InvalidArgumentException($message);
46		}
47	3	}
48		}
49

TextControl / txtextcontrol-reportingcloud-php

Push — master ( 315e77...e369d0 )

AssertStringTrait::assertString() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like