AbstractSkiDataParser::encodeDate() - Code Metrics - webeweb/skidata-library - Measure and Improve Code Quality continuously with Scrutinizer

AbstractSkiDataParser::encodeDate() A
last analyzed 2018-08-07 08:40 UTC

↳ Parent: AbstractSkiDataParser

Complexity

Conditions	2
Paths	2

Size

Total Lines	2
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php

/**
 * This file is part of the skidata-library package.
 *
 * (c) 2017 WEBEWEB
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace WBW\Library\SkiData\Parser;

use DateTime;
use WBW\Library\SkiData\Entity\SkiDataStartRecordFormat;
use WBW\Library\SkiData\Exception\SkiDataMissingStartRecordFormatException;
use WBW\Library\SkiData\Exception\SkiDataTooLongDataException;

/**
 * Abstract SkiData parser.
 *
 * @author webeweb <https://github.com/webeweb/>
 * @package WBW\Library\SkiData\Parser
 * @abstract
 */
abstract class AbstractSkiDataParser implements SkiDataParserInterface {

    /**
     * Start record format.
     *
     * @var SkiDataStartRecordFormat
     */
    private $startRecordFormat;

    /**
     * Constructor.
     */
    protected function __construct() {
        // NOTHING TO DO.
    }

    /**
     * Decode a date string.
     *
     * @param string $str The string.
     * @return DateTime Returns the decoded string into DateTime.
     */
    final protected function decodeDate($str) {
        return "" === $str ? null : DateTime::createFromFormat("!" . self::DATE_FORMAT, $str);

    }

    /**
     * Decode a datetime string.
     *
     * @param string $str The string.
     * @return DateTime Returns the decoded string into DateTime.
     */
    final protected function decodeDateTime($str) {
        return "" === $str ? null : DateTime::createFromFormat(self::DATETIME_FORMAT, $str);

    }

    /**
     * Decode a integer string.
     *
     * @param string $str The string.
     * @return integer Returns the decoded string into integer.
     */
    final protected function decodeInteger($str) {
        return "" === $str ? null : intval($str);
    }

    /**
     * Decode a string.
     *
     * @param string $str The string.
     * @return string Returns the decoded string into string.
     */
    final protected function decodeString($str) {
        return ("" === $str || 2 === strlen($str)) ? "" : substr($str, 1, strlen($str) - 2);
    }

    /**
     * Encode a boolean value.
     *
     * @param boolean $value The value.
     * @return string Returns the encoded boolean value.
     */
    final protected function encodeBoolean($value) {
        return true === $value ? "1" : "0";
    }

    /**
     * Encode a date value.
     *
     * @param DateTime $value The value.
     * @return string Returns the encoded datetime value.
     */
    final protected function encodeDate(DateTime $value = null) {
        return null !== $value ? $value->format(self::DATE_FORMAT) : "";
    }

    /**
     * Encode a datetime value.
     *
     * @param DateTime $value The value.
     * @return string Returns the encoded datetime value.
     */
    final protected function encodeDateTime(DateTime $value = null) {
        return null !== $value ? $value->format(self::DATETIME_FORMAT) : "";
    }

    /**
     * Encode an integer value.
     *
     * @param integer $value The value.
     * @param integer $length The length.
     * @return string Returns the encoded integer.
     * @throws SkiDataTooLongDataException Throws a SkiData too long data exception if the value exceeds the length.
     */
    final protected function encodeInteger($value, $length) {
        if (null === $value) {

            return "";
        }
        $format = "%'.0" . $length . "d";
        $output = sprintf($format, $value);
        if ($length < strlen($output)) {
            throw new SkiDataTooLongDataException($value, $length);
        }
        return $output;
    }

    /**
     * Encode a string value.
     *
     * @param string $value The value.
     * @param integer $length The length.
     * @return string Returns the encoded string.
     * @throws SkiDataTooLongDataException Throws a SkiData too long data exception if the value exceeds the length.
     */
    final protected function encodeString($value, $length = -1) {
        if (-1 !== $length && $length < strlen($value)) {
            throw new SkiDataTooLongDataException($value, $length);
        }
        return "\"" . substr($value, 0, (-1 === $length ? strlen($value) : $length)) . "\"";
    }

    /**
     * Get the start record format.
     *
     * @return SkiDataStartRecordFormat Returns the start record format.
     */
    final public function getStartRecordFormat() {
        return $this->startRecordFormat;
    }

    /**
     * Determines if the version of record structure is less or equal than $versionRecordStructure.
     *
     * @param integer $versionRecordStructure The version of record structure.
     * @return boolean Returns true in case of success, false otherwise.
     * @throws SkiDataMissingStartRecordFormatException Throws a SkiData missing start record format exception if the start record format is missing.
     */
    final protected function isVersionRecordStructure($versionRecordStructure) {
        if (null === $this->startRecordFormat) {
            throw new SkiDataMissingStartRecordFormatException();
        }
        return $versionRecordStructure <= $this->startRecordFormat->getVersionRecordStructure();
    }

    /**
     * Set the start record format.
     *
     * @param SkiDataStartRecordFormat $startRecordFormat The start record format.
     * @return AbstractSkiDataParser Returns the SkiData parser.
     */
    final public function setStartRecordFormat(SkiDataStartRecordFormat $startRecordFormat) {
        $this->startRecordFormat = $startRecordFormat;
        return $this;
    }

}


1			<?php
2
3			/**
4			* This file is part of the skidata-library package.
5			*
6			* (c) 2017 WEBEWEB
7			*
8			* For the full copyright and license information, please view the LICENSE
9			* file that was distributed with this source code.
10			*/
11
12			namespace WBW\Library\SkiData\Parser;
13
14			use DateTime;
15			use WBW\Library\SkiData\Entity\SkiDataStartRecordFormat;
16			use WBW\Library\SkiData\Exception\SkiDataMissingStartRecordFormatException;
17			use WBW\Library\SkiData\Exception\SkiDataTooLongDataException;
18
19			/**
20			* Abstract SkiData parser.
21			*
22			* @author webeweb <https://github.com/webeweb/>
23			* @package WBW\Library\SkiData\Parser
24			* @abstract
25			*/
26			abstract class AbstractSkiDataParser implements SkiDataParserInterface {
27
28			/**
29			* Start record format.
30			*
31			* @var SkiDataStartRecordFormat
32			*/
33			private $startRecordFormat;
34
35			/**
36			* Constructor.
37			*/
38			protected function __construct() {
39			// NOTHING TO DO.
40			}
41
42			/**
43			* Decode a date string.
44			*
45			* @param string $str The string.
46			* @return DateTime Returns the decoded string into DateTime.
47			*/
48			final protected function decodeDate($str) {
49			return "" === $str ? null : DateTime::createFromFormat("!" . self::DATE_FORMAT, $str);
			1 ignored issue – show Bug Best Practice introduced 2018-03-12 17:27 UTC by Report Bug Copy Issue Report The expression `return '' === $str ? nul...elf::DATE_FORMAT, $str)` could also return `false` which is incompatible with the documented return type `DateTime`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
50			}
51
52			/**
53			* Decode a datetime string.
54			*
55			* @param string $str The string.
56			* @return DateTime Returns the decoded string into DateTime.
57			*/
58			final protected function decodeDateTime($str) {
59			return "" === $str ? null : DateTime::createFromFormat(self::DATETIME_FORMAT, $str);
			1 ignored issue – show Bug Best Practice introduced 2018-03-12 17:27 UTC by Report Bug Copy Issue Report The expression `return '' === $str ? nul...:DATETIME_FORMAT, $str)` could also return `false` which is incompatible with the documented return type `DateTime`. Did you maybe forget to handle an error condition? If the returned type also contains false, it is an indicator that maybe an error condition leading to the specific return statement remains unhandled. Loading history...
60			}
61
62			/**
63			* Decode a integer string.
64			*
65			* @param string $str The string.
66			* @return integer Returns the decoded string into integer.
67			*/
68			final protected function decodeInteger($str) {
69			return "" === $str ? null : intval($str);
70			}
71
72			/**
73			* Decode a string.
74			*
75			* @param string $str The string.
76			* @return string Returns the decoded string into string.
77			*/
78			final protected function decodeString($str) {
79			return ("" === $str \|\| 2 === strlen($str)) ? "" : substr($str, 1, strlen($str) - 2);
80			}
81
82			/**
83			* Encode a boolean value.
84			*
85			* @param boolean $value The value.
86			* @return string Returns the encoded boolean value.
87			*/
88			final protected function encodeBoolean($value) {
89			return true === $value ? "1" : "0";
90			}
91
92			/**
93			* Encode a date value.
94			*
95			* @param DateTime $value The value.
96			* @return string Returns the encoded datetime value.
97			*/
98			final protected function encodeDate(DateTime $value = null) {
99			return null !== $value ? $value->format(self::DATE_FORMAT) : "";
100			}
101
102			/**
103			* Encode a datetime value.
104			*
105			* @param DateTime $value The value.
106			* @return string Returns the encoded datetime value.
107			*/
108			final protected function encodeDateTime(DateTime $value = null) {
109			return null !== $value ? $value->format(self::DATETIME_FORMAT) : "";
110			}
111
112			/**
113			* Encode an integer value.
114			*
115			* @param integer $value The value.
116			* @param integer $length The length.
117			* @return string Returns the encoded integer.
118			* @throws SkiDataTooLongDataException Throws a SkiData too long data exception if the value exceeds the length.
119			*/
120			final protected function encodeInteger($value, $length) {
121			if (null === $value) {
			1 ignored issue – show introduced 2018-03-12 17:27 UTC by Report Bug Copy Issue Report The condition `null === $value` is always `false`. Loading history...
122			return "";
123			}
124			$format = "%'.0" . $length . "d";
125			$output = sprintf($format, $value);
126			if ($length < strlen($output)) {
127			throw new SkiDataTooLongDataException($value, $length);
128			}
129			return $output;
130			}
131
132			/**
133			* Encode a string value.
134			*
135			* @param string $value The value.
136			* @param integer $length The length.
137			* @return string Returns the encoded string.
138			* @throws SkiDataTooLongDataException Throws a SkiData too long data exception if the value exceeds the length.
139			*/
140			final protected function encodeString($value, $length = -1) {
141			if (-1 !== $length && $length < strlen($value)) {
142			throw new SkiDataTooLongDataException($value, $length);
143			}
144			return "\"" . substr($value, 0, (-1 === $length ? strlen($value) : $length)) . "\"";
145			}
146
147			/**
148			* Get the start record format.
149			*
150			* @return SkiDataStartRecordFormat Returns the start record format.
151			*/
152			final public function getStartRecordFormat() {
153			return $this->startRecordFormat;
154			}
155
156			/**
157			* Determines if the version of record structure is less or equal than $versionRecordStructure.
158			*
159			* @param integer $versionRecordStructure The version of record structure.
160			* @return boolean Returns true in case of success, false otherwise.
161			* @throws SkiDataMissingStartRecordFormatException Throws a SkiData missing start record format exception if the start record format is missing.
162			*/
163			final protected function isVersionRecordStructure($versionRecordStructure) {
164			if (null === $this->startRecordFormat) {
165			throw new SkiDataMissingStartRecordFormatException();
166			}
167			return $versionRecordStructure <= $this->startRecordFormat->getVersionRecordStructure();
168			}
169
170			/**
171			* Set the start record format.
172			*
173			* @param SkiDataStartRecordFormat $startRecordFormat The start record format.
174			* @return AbstractSkiDataParser Returns the SkiData parser.
175			*/
176			final public function setStartRecordFormat(SkiDataStartRecordFormat $startRecordFormat) {
177			$this->startRecordFormat = $startRecordFormat;
178			return $this;
179			}
180
181			}
182

webeweb / skidata-library

AbstractSkiDataParser::encodeDate() A last analyzed 2018-08-07 08:40 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

AbstractSkiDataParser::encodeDate() A
last analyzed 2018-08-07 08:40 UTC