CollationInfo::setBinaryCollation() - Code Metrics - graze/morphism - Measure and Improve Code Quality continuously with Scrutinizer

CollationInfo::setBinaryCollation() A
last analyzed 2024-05-01 12:47 UTC

↳ Parent: CollationInfo

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	1

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	1
CRAP Score	1

Importance

Changes	1
Bugs	0	Features	0

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

<?php
namespace Graze\Morphism\Parse;

use LogicException;
use RuntimeException;

/**
 * Handles the specification of character set and collation.
 */
class CollationInfo
{
    // only bothering to detail the charsets + collations we're actually likely to use
    /** @var array */
    private static $data = [
        // In the list of collations for each charset, the entry
        // for the default collation must come first, and the
        // binary collation last:
        'latin1' => [
            'latin1_swedish_ci',
            'latin1_german1_ci',
            'latin1_german2_ci',
            'latin1_spanish_ci',
            'latin1_danish_ci',
            'latin1_general_ci',
            'latin1_general_cs',
            'latin1_bin',
        ],
        'utf8' => [
            'utf8_general_ci',
            'utf8_unicode_ci',
            'utf8_bin',
        ],
        'utf8mb3' => [
            'utf8mb3_general_ci',
            'utf8mb3_unicode_ci',
            'utf8mb3_bin',
        ],
        'utf8mb4' => [
            'utf8mb4_general_ci',
            'utf8mb4_unicode_ci',
            'utf8mb4_bin',
            'utf8mb4_0900_ai_ci',
        ],
        'binary' => [
            'binary',
        ],
    ];

    /** @var string|null */
    private $charset = null;
    /** @var string|null */
    private $collation = null;
    /** @var bool|null */
    private $isBinaryCollation = null;

    /**
     * If neither parameter is specified, creates an object representing an
     * unspecified collation.
     * If only $charset is provided, its default collation will be selected.
     * If only $collation is provided, the charset will be derived from it.
     * If both are provided, $collation must be a valid collation for the
     * charset.
     *
     * @param string|null $charset    name of a character set, e.g. latin1, utf8, binary
     * @param string|null $collation  name of a collation, e.g. latin1_general_ci, utf8_unicode_ci, binary
     */
    public function __construct($charset = null, $collation = null)
    {
        if (!is_null($charset)) {
            $this->setCharset($charset);
        }
        if (!is_null($collation)) {
            $this->setCollation($collation);
        }
    }

    /**
     * Returns true if a charset or collation has not yet been specified.
     *
     * @return bool
     */
    public function isSpecified()
    {
        return !is_null($this->charset);
    }

    /**
     * Returns the name of the character set.
     * Throws an exception if a charset or collation has not yet been specified.
     *
     * @throws LogicException
     * @return string
     */
    public function getCharset()
    {
        if (is_null($this->charset)) {
            throw new LogicException("getCharset called when charset is unspecified");
        }
        return $this->charset;
    }

    /**
     * Returns the name of the collation.
     * Throws an exception if a charset or collation has not yet been specified.
     *
     * @throws LogicException
     * @return string
     */
    public function getCollation()
    {
        if (is_null($this->charset)) {
            throw new LogicException("getCollation called when collation is unspecified");
        }
        if ($this->isBinaryCollation) {
            $collations = self::getCharsetCollations($this->charset);
            if (null !== $collations) {
                return $collations[count($collations) - 1];
            }
        }
        return $this->collation;
    }

    /**
     * Returns true if the selected charset is 'binary'.
     * Throws an exception if a charset or collation has not yet been specified.
     *
     * @throws LogicException
     * @return bool
     */
    public function isBinaryCharset()
    {
        if (is_null($this->charset)) {
            throw new LogicException("isBinaryCharset called when collation is unspecified");
        }
        return $this->charset === 'binary';
    }

    /**
     * Returns true if the selected collation is the default for the charset.
     * Throws an exception if a charset or collation has not yet been specified.
     *
     * @throws LogicException
     * @return bool
     */
    public function isDefaultCollation()
    {
        if (is_null($this->charset)) {
            throw new LogicException("isDefaultCollation called when collation is unspecified");
        }
        return $this->getCollation() === self::getCharsetDefaultCollation($this->charset);
    }

    /**
     * Sets the character set.
     *
     * Throws a RuntimeException if $charset is in conflict with an already
     * specified character set or collation.
     *
     * Hidden side effect: Also sets the collation. :(
     *
     * @param string $charset
     * @throws RuntimeException
     * @return void
     */
    public function setCharset($charset)
    {
        $charset = strtolower($charset);
        $defaultCollation = self::getCharsetDefaultCollation($charset);
        if (is_null($defaultCollation)) {
            throw new RuntimeException("unknown character set '$charset'");
        }
        if (!is_null($this->charset) &&
            $this->charset !== $charset
        ) {
            throw new RuntimeException("Conflicting CHARACTER SET declarations");
        }
        $this->charset = $charset;
        $this->collation = $defaultCollation;
    }

    /**
     * Sets the collation.
     *
     * Throws a RuntimeException if a character set has already been specified,
     * but $collation is not compatible with it.
     *
     * Hidden side effect: Also sets the character set. :(
     *
     * @param string $collation
     * @throws RuntimeException
     * @return void
     */
    public function setCollation($collation)
    {
        $collation = strtolower($collation);
        if (str_contains($collation, 'utf8mb3')) {
            $collation = str_replace('utf8mb3', 'utf8', $collation);
            $this->charset =  str_replace('utf8mb3', 'utf8', $this->charset);
        }

        $charset = self::getCollationCharset($collation);
        if (is_null($charset)) {
            throw new RuntimeException("unknown collation '$collation'");
        }
        if (!is_null($this->charset) &&
            $this->charset !== $charset
        ) {
            throw new RuntimeException("COLLATION '$collation' is not valid for CHARACTER SET '$charset'");
        }
        $this->charset = $charset;
        $this->collation = $collation;
    }

    /**
     * Ensures that the character set's binary collation will be returned
     * by getCollation() in future (on this object), regardless of any prior
     * or subsequent call to setCollation().
     *
     * @return void
     */
    public function setBinaryCollation()
    {
        $this->isBinaryCollation = true;
    }

    /**
     * Get all the available collations for the given character set.
     *
     * @param string $charset
     * @return array|null
     */
    private static function getCharsetCollations($charset)
    {
        return array_key_exists($charset, self::$data)
            ? self::$data[$charset]
            : null;
    }

    /**
     * Get the default collation for the given character set.
     *
     * @param string $charset
     * @return string|null
     */
    private static function getCharsetDefaultCollation($charset)
    {
        $collations = self::getCharsetCollations($charset);
        if (null !== $collations) {
            return $collations[0];
        }
        return null;
    }

    /**
     * @param string $collation
     * @return string|null
     */
    private static function getCollationCharset($collation)
    {
        foreach (self::$data as $charset => $collations) {
            if (in_array($collation, $collations)) {
                return $charset;
            }
        }
        return null;
    }
}


1		<?php
2		namespace Graze\Morphism\Parse;
3
4		use LogicException;
5		use RuntimeException;
6
7		/**
8		* Handles the specification of character set and collation.
9		*/
10		class CollationInfo
11		{
12		// only bothering to detail the charsets + collations we're actually likely to use
13		/** @var array */
14		private static $data = [
15		// In the list of collations for each charset, the entry
16		// for the default collation must come first, and the
17		// binary collation last:
18		'latin1' => [
19		'latin1_swedish_ci',
20		'latin1_german1_ci',
21		'latin1_german2_ci',
22		'latin1_spanish_ci',
23		'latin1_danish_ci',
24		'latin1_general_ci',
25		'latin1_general_cs',
26		'latin1_bin',
27		],
28		'utf8' => [
29		'utf8_general_ci',
30		'utf8_unicode_ci',
31		'utf8_bin',
32		],
33		'utf8mb3' => [
34		'utf8mb3_general_ci',
35		'utf8mb3_unicode_ci',
36		'utf8mb3_bin',
37		],
38		'utf8mb4' => [
39		'utf8mb4_general_ci',
40		'utf8mb4_unicode_ci',
41		'utf8mb4_bin',
42		'utf8mb4_0900_ai_ci',
43		],
44		'binary' => [
45		'binary',
46		],
47		];
48
49		/** @var string\|null */
50		private $charset = null;
51		/** @var string\|null */
52		private $collation = null;
53		/** @var bool\|null */
54		private $isBinaryCollation = null;
55
56		/**
57		* If neither parameter is specified, creates an object representing an
58		* unspecified collation.
59		* If only $charset is provided, its default collation will be selected.
60		* If only $collation is provided, the charset will be derived from it.
61		* If both are provided, $collation must be a valid collation for the
62	473	* charset.
63		*
64	473	* @param string\|null $charset name of a character set, e.g. latin1, utf8, binary
65	26	* @param string\|null $collation name of a collation, e.g. latin1_general_ci, utf8_unicode_ci, binary
66		*/
67	472	public function __construct($charset = null, $collation = null)
68	18	{
69		if (!is_null($charset)) {
70	471	$this->setCharset($charset);
71		}
72		if (!is_null($collation)) {
73		$this->setCollation($collation);
74		}
75		}
76
77	217	/**
78		* Returns true if a charset or collation has not yet been specified.
79	217	*
80		* @return bool
81		*/
82		public function isSpecified()
83		{
84		return !is_null($this->charset);
85		}
86
87		/**
88		* Returns the name of the character set.
89	33	* Throws an exception if a charset or collation has not yet been specified.
90		*
91	33	* @throws LogicException
92	1	* @return string
93		*/
94	32	public function getCharset()
95		{
96		if (is_null($this->charset)) {
97		throw new LogicException("getCharset called when charset is unspecified");
98		}
99		return $this->charset;
100		}
101
102		/**
103		* Returns the name of the collation.
104	45	* Throws an exception if a charset or collation has not yet been specified.
105		*
106	45	* @throws LogicException
107	1	* @return string
108		*/
109	44	public function getCollation()
110	2	{
111	2	if (is_null($this->charset)) {
112	2	throw new LogicException("getCollation called when collation is unspecified");
113		}
114		if ($this->isBinaryCollation) {
115	43	$collations = self::getCharsetCollations($this->charset);
116		if (null !== $collations) {
117		return $collations[count($collations) - 1];
118		}
119		}
120		return $this->collation;
121		}
122
123		/**
124		* Returns true if the selected charset is 'binary'.
125	10	* Throws an exception if a charset or collation has not yet been specified.
126		*
127	10	* @throws LogicException
128	1	* @return bool
129		*/
130	9	public function isBinaryCharset()
131		{
132		if (is_null($this->charset)) {
133		throw new LogicException("isBinaryCharset called when collation is unspecified");
134		}
135		return $this->charset === 'binary';
136		}
137
138		/**
139		* Returns true if the selected collation is the default for the charset.
140	17	* Throws an exception if a charset or collation has not yet been specified.
141		*
142	17	* @throws LogicException
143	1	* @return bool
144		*/
145	16	public function isDefaultCollation()
146		{
147		if (is_null($this->charset)) {
148		throw new LogicException("isDefaultCollation called when collation is unspecified");
149		}
150		return $this->getCollation() === self::getCharsetDefaultCollation($this->charset);
151		}
152
153		/**
154		* Sets the character set.
155		*
156		* Throws a RuntimeException if $charset is in conflict with an already
157		* specified character set or collation.
158		*
159		* Hidden side effect: Also sets the collation. :(
160	37	*
161		* @param string $charset
162	37	* @throws RuntimeException
163	37	* @return void
164	37	*/
165	1	public function setCharset($charset)
166		{
167	36	$charset = strtolower($charset);
168	36	$defaultCollation = self::getCharsetDefaultCollation($charset);
169		if (is_null($defaultCollation)) {
170	1	throw new RuntimeException("unknown character set '$charset'");
171		}
172	36	if (!is_null($this->charset) &&
173	36	$this->charset !== $charset
174	36	) {
175		throw new RuntimeException("Conflicting CHARACTER SET declarations");
176		}
177		$this->charset = $charset;
178		$this->collation = $defaultCollation;
179		}
180
181		/**
182		* Sets the collation.
183		*
184		* Throws a RuntimeException if a character set has already been specified,
185		* but $collation is not compatible with it.
186		*
187		* Hidden side effect: Also sets the character set. :(
188	34	*
189		* @param string $collation
190	34	* @throws RuntimeException
191	34	* @return void
192	34	*/
193	1	public function setCollation($collation)
194		{
195	33	$collation = strtolower($collation);
196	33	if (str_contains($collation, 'utf8mb3')) {
197		$collation = str_replace('utf8mb3', 'utf8', $collation);
198	1	$this->charset = str_replace('utf8mb3', 'utf8', $this->charset);
199		}
200	32
201	32	$charset = self::getCollationCharset($collation);
202	32	if (is_null($charset)) {
203		throw new RuntimeException("unknown collation '$collation'");
204		}
205		if (!is_null($this->charset) &&
206		$this->charset !== $charset
207		) {
208		throw new RuntimeException("COLLATION '$collation' is not valid for CHARACTER SET '$charset'");
209		}
210		$this->charset = $charset;
211	3	$this->collation = $collation;
212		}
213	3
214	3	/**
215		* Ensures that the character set's binary collation will be returned
216		* by getCollation() in future (on this object), regardless of any prior
217		* or subsequent call to setCollation().
218		*
219		* @return void
220		*/
221		public function setBinaryCollation()
222	45	{
223		$this->isBinaryCollation = true;
224	45	}
225	44
226	45	/**
227		* Get all the available collations for the given character set.
228		*
229		* @param string $charset
230		* @return array\|null
231		*/
232		private static function getCharsetCollations($charset)
233		{
234		return array_key_exists($charset, self::$data)
235	44	? self::$data[$charset]
236		: null;
237	44	}
238	44
239	43	/**
240		* Get the default collation for the given character set.
241	1	*
242		* @param string $charset
243		* @return string\|null
244		*/
245		private static function getCharsetDefaultCollation($charset)
246		{
247		$collations = self::getCharsetCollations($charset);
248	34	if (null !== $collations) {
249		return $collations[0];
250	34	}
251	34	return null;
252	33	}
253
254		/**
255	1	* @param string $collation
256		* @return string\|null
257		*/
258		private static function getCollationCharset($collation)
259		{
260		foreach (self::$data as $charset => $collations) {
261		if (in_array($collation, $collations)) {
262		return $charset;
263		}
264		}
265		return null;
266		}
267		}
268

graze / morphism

GitHub Access Token became invalid

CollationInfo::setBinaryCollation() A last analyzed 2024-05-01 12:47 UTC

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like

CollationInfo::setBinaryCollation() A
last analyzed 2024-05-01 12:47 UTC