AbstractValueType::getValue() - Code Metrics - Inspection of "Create type-classes for all xsd-types" - simplesamlphp/xml-common - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Pull Request — master (#55)

by Tim

created 2025-01-16 09:21 UTC

AbstractValueType::getValue() A

↳ Parent: AbstractValueType

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	0

Metric	Value
eloc	1
c	1
b	0
f	0
dl	0
loc	3
rs	10
cc	1
nc	1
nop	0

<?php

declare(strict_types=1);

namespace SimpleSAML\XML\Type;

/**
 * Abstract class to be implemented by all types
 *
 * @package simplesamlphp/xml-common
 */
abstract class AbstractValueType implements ValueTypeInterface
{
    /**
     * Set the value for this type.
     *
     * @param string $value
     */
    final protected function __construct(
        protected string $value,
    ) {
        $this->validateValue($value);
    }


    /**
     * Get the value.
     *
     * @return string
     */
    public function getValue(): string
    {
        return $this->sanitizeValue($this->getRawValue());
    }


    /**
     * Get the raw unsanitized value.
     *
     * @return string
     */
    public function getRawValue(): string
    {
        return $this->value;
    }


    /**
     * Sanitize the value.
     *
     * @param string $value  The value
     * @throws \Exception on failure
     * @return string
     */
    protected function sanitizeValue(string $value): string
    {
        /**
         * Perform no sanitation by default.
         * Override this method on the implementing class to perform content sanitation.
         */
        return $value;
    }


    /**
     * Validate the value.
     *
     * @param string $value  The value
     * @throws \Exception on failure
     * @return void
     */
    protected function validateValue(/** @scrutinizer ignore-unused */ string $value): void
    {
        /**
         * Perform no validation by default.
         * Override this method on the implementing class to perform validation.
         */
    }


    /**
     * @param string $value
     * @return static
     */
    public static function fromString(string $value): static
    {
        return new static($value);
    }


    /**
     * Output the value as a string
     *
     * @return string
     */
    public function __toString(): string
    {
        return $this->getValue();
    }
}


1			<?php
2
3			declare(strict_types=1);
4
5			namespace SimpleSAML\XML\Type;
6
7			/**
8			* Abstract class to be implemented by all types
9			*
10			* @package simplesamlphp/xml-common
11			*/
12			abstract class AbstractValueType implements ValueTypeInterface
13			{
14			/**
15			* Set the value for this type.
16			*
17			* @param string $value
18			*/
19			final protected function __construct(
20			protected string $value,
21			) {
22			$this->validateValue($value);
23			}
24
25
26			/**
27			* Get the value.
28			*
29			* @return string
30			*/
31			public function getValue(): string
32			{
33			return $this->sanitizeValue($this->getRawValue());
34			}
35
36
37			/**
38			* Get the raw unsanitized value.
39			*
40			* @return string
41			*/
42			public function getRawValue(): string
43			{
44			return $this->value;
45			}
46
47
48			/**
49			* Sanitize the value.
50			*
51			* @param string $value The value
52			* @throws \Exception on failure
53			* @return string
54			*/
55			protected function sanitizeValue(string $value): string
56			{
57			/**
58			* Perform no sanitation by default.
59			* Override this method on the implementing class to perform content sanitation.
60			*/
61			return $value;
62			}
63
64
65			/**
66			* Validate the value.
67			*
68			* @param string $value The value
69			* @throws \Exception on failure
70			* @return void
71			*/
72			protected function validateValue(/** @scrutinizer ignore-unused */ string $value): void
73			{
74			/**
75			* Perform no validation by default.
76			* Override this method on the implementing class to perform validation.
77			*/
78			}
79
80
81			/**
82			* @param string $value
83			* @return static
84			*/
85			public static function fromString(string $value): static
86			{
87			return new static($value);
88			}
89
90
91			/**
92			* Output the value as a string
93			*
94			* @return string
95			*/
96			public function __toString(): string
97			{
98			return $this->getValue();
99			}
100			}
101

simplesamlphp / xml-common

Pull Request — master (#55)

AbstractValueType::getValue() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like