composer.json - move tests-related classes to "autoload-dev" section (used for development purposes only and avoid polluting the autoloader in production)

src/Exception/Base/UnknownTypeException.php

@@ -0,0 +1,41 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Base;
+
+use Exception;
+use Meritoo\Common\Type\Base\BaseType;
+use Meritoo\Common\Utilities\Arrays;
+
+/**
+ * An exception used while type of something is unknown
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+abstract class UnknownTypeException extends Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string|int $unknownType  The unknown type of something (value of constant)
+     * @param BaseType   $typeInstance An instance of class that contains type of the something
+     * @param string     $typeName     Name of the something
+     */
+    public function __construct($unknownType, BaseType $typeInstance, $typeName)
+    {
+        $allTypes = $typeInstance->getAll();
+        $types = Arrays::values2string($allTypes, '', ', ');
+
+        $template = 'The \'%s\' type of %s is unknown. Probably doesn\'t exist or there is a typo. You should use one'
+            . ' of these types: %s.';
+
+        $message = sprintf(sprintf($template, $unknownType, $typeName, $types));
+        parent::__construct($message);
+    }
+}

src/Exception/Date/UnknownDatePartTypeException.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Date;
+
+use Meritoo\Common\Exception\Base\UnknownTypeException;
+use Meritoo\Common\Type\DatePartType;
+
+/**
+ * An exception used while type of date part, e.g. "year", is unknown
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class UnknownDatePartTypeException extends UnknownTypeException
+{
+    /**
+     * Class constructor
+     *
+     * @param string $unknownDatePart Type of date part, e.g. "year". One of DatePartType class constants.
+     * @param string $value           Incorrect value
+     */
+    public function __construct($unknownDatePart, $value)
+    {
+        parent::__construct($unknownDatePart, new DatePartType(), sprintf('date part (with value %s)', $value));
+    }
+}

src/Exception/File/EmptyFileException.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while file with given path is empty (has no content)
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class EmptyFileException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $emptyFilePath Path of the empty file
+     */
+    public function __construct($emptyFilePath)
+    {
+        $template = 'File with path \'%s\' is empty (has no content). Did you provide path of proper file?';
+        $message = sprintf($template, $emptyFilePath);
+
+        parent::__construct($message);
+    }
+}

src/Exception/File/EmptyFilePathException.php

@@ -0,0 +1,26 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while path of given file is empty
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class EmptyFilePathException extends \Exception
+{
+    /**
+     * Class constructor
+     */
+    public function __construct()
+    {
+        parent::__construct('Path of the file is empty. Did you provide path of proper file?');
+    }
+}

src/Exception/File/NotExistingFileException.php

@@ -0,0 +1,31 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\File;
+
+/**
+ * An exception used while file with given path does not exist
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class NotExistingFileException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $notExistingFilePath Path of not existing (or not readable) file
+     */
+    public function __construct($notExistingFilePath)
+    {
+        $template = 'File with path \'%s\' does not exist (or is not readable). Did you provide path of proper file?';
+        $message = sprintf($template, $notExistingFilePath);
+
+        parent::__construct($message);
+    }
+}

src/Exception/Method/DisabledMethodException.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Method;
+
+use Exception;
+
+/**
+ * An exception used while method cannot be called, because is disabled
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class DisabledMethodException extends Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $disabledMethod    Name of the disabled method
+     * @param string $alternativeMethod (optional) Name of the alternative method
+     */
+    public function __construct($disabledMethod, $alternativeMethod = '')
+    {
+        $template = 'Method %s() cannot be called, because is disabled.';
+
+        if (!empty($alternativeMethod)) {
+            $template .= ' Use %s() instead.';
+        }
+
+        $message = sprintf($template, $disabledMethod, $alternativeMethod);
+        parent::__construct($message);
+    }
+}

src/Exception/Reflection/CannotResolveClassNameException.php

@@ -0,0 +1,47 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Reflection;
+
+use Exception;
+
+/**
+ * An exception used while name of class or trait cannot be resolved
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class CannotResolveClassNameException extends Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param array|object|string $source   Source of the class's / trait's name. It can be an array of objects,
+     *                                      namespaces, object or namespace.
+     * @param bool                $forClass (optional) If is set to true, message of this exception for class is
+     *                                      prepared. Otherwise - for trait.
+     */
+    public function __construct($source, $forClass = true)
+    {
+        $forWho = 'trait';
+        $value = '';
+
+        if ($forClass) {
+            $forWho = 'class';
+        }
+
+        if (is_scalar($source)) {
+            $value = sprintf(' %s', (string)$source);
+        }
+
+        $template = 'Name of %s from given \'%s\'%s cannot be resolved. Is there everything ok?';
+        $message = sprintf($template, $forWho, gettype($source), $value);
+
+        parent::__construct($message);
+    }
+}

src/Exception/Reflection/MissingChildClassesException.php

@@ -0,0 +1,38 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Reflection;
+
+use Exception;
+use Meritoo\Common\Utilities\Reflection;
+
+/**
+ * An exception used while given class has no child classes
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class MissingChildClassesException extends Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param array|object|string $parentClass Class that hasn't child classes, but it should. An array of objects,
+     *                                         strings, object or string.
+     */
+    public function __construct($parentClass)
+    {
+        $template = 'The \'%s\' class requires one child class at least who will extend her (maybe is an abstract'
+            . ' class), but the child classes are missing. Did you forget to extend this class?';
+
+        $parentClassName = Reflection::getClassName($parentClass);
+        $message = sprintf($template, $parentClassName);
+
+        parent::__construct($message);
+    }
+}

src/Exception/Reflection/TooManyChildClassesException.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Reflection;
+
+use Exception;
+use Meritoo\Common\Utilities\Reflection;
+
+/**
+ * An exception used while given class has more than one child class
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class TooManyChildClassesException extends Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param array|object|string $parentClass  Class that has more than one child class, but it shouldn't. An array
+     *                                          of objects, strings, object or string.
+     * @param array               $childClasses Child classes
+     */
+    public function __construct($parentClass, array $childClasses)
+    {
+        $template = "The '%s' class requires one child class at most who will extend her, but more than one child"
+            . " class was found:\n- %s\n\nWhy did you create more than one classes that extend '%s' class?";
+
+        $parentClassName = Reflection::getClassName($parentClass);
+        $message = sprintf($template, $parentClassName, implode("\n- ", $childClasses), $parentClassName);
+
+        parent::__construct($message);
+    }
+}

src/Exception/Regex/IncorrectColorHexLengthException.php

@@ -0,0 +1,32 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Regex;
+
+/**
+ * An exception used while length of given hexadecimal value of color is incorrect
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class IncorrectColorHexLengthException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $color Incorrect hexadecimal value of color
+     */
+    public function __construct($color)
+    {
+        $template = 'Length of hexadecimal value of color \'%s\' is incorrect. It\'s %d, but it should be 3 or 6.'
+            . ' Is there everything ok?';
+
+        $message = sprintf($template, $color, strlen($color));
+        parent::__construct($message);
+    }
+}

src/Exception/Regex/InvalidColorHexValueException.php

@@ -0,0 +1,29 @@
+<?php
+
+/**
+ * (c) Meritoo.pl, http://www.meritoo.pl
+ * For the full copyright and license information, please view the LICENSE
+ * file that was distributed with this source code.
+ */
+
+namespace Meritoo\Common\Exception\Regex;
+
+/**
+ * An exception used while given hexadecimal value of color is invalid
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class InvalidColorHexValueException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $color Invalid hexadecimal value of color
+     */
+    public function __construct($color)
+    {
+        $message = sprintf('Hexadecimal value of color \'%s\' is invalid. Is there everything ok?', $color);
+        parent::__construct($message);
+    }
+}

src/Exception/Regex/InvalidUrlException.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Meritoo\Common\Exception\Regex;
+
+/**
+ * An exception used while url is invalid
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class InvalidUrlException extends \Exception
+{
+    /**
+     * Class constructor
+     *
+     * @param string $url Invalid url
+     */
+    public function __construct($url)
+    {
+        $message = sprintf('Url \'%s\' is invalid. Is there everything ok?', $url);
+        parent::__construct($message);
+    }
+}

src/Exception/Type/UnknownOopVisibilityTypeException.php

@@ -0,0 +1,23 @@
+<?php
+
+namespace Meritoo\Common\Exception\Type;
+
+use Meritoo\Common\Exception\Base\UnknownTypeException;
+use Meritoo\Common\Type\OopVisibilityType;
+
+/**
+ * An exception used while the visibility of a property, a method or (as of PHP 7.1.0) a constant is unknown
+ *
+ * @author    Krzysztof Niziol <krzysztof.niziol@meritoo.pl>
+ * @copyright Meritoo.pl
+ */
+class UnknownOopVisibilityTypeException extends UnknownTypeException
+{
+    /**
+     * {@inheritdoc}
+     */
+    public function __construct($unknownType)
+    {
+        parent::__construct($unknownType, new OopVisibilityType(), 'OOP-related visibility');
+    }
+}