File exceptions.php | ICanBoogie/Common v1.2.2.1

  1   2   3   4   5   6   7   8   9  10  11  12  13  14  15  16  17  18  19  20  21  22  23  24  25  26  27  28  29  30  31  32  33  34  35  36  37  38  39  40  41  42  43  44  45  46  47  48  49  50  51  52  53  54  55  56  57  58  59  60  61  62  63  64  65  66  67  68  69  70  71  72  73  74  75  76  77  78  79  80  81  82  83  84  85  86  87  88  89  90  91  92  93  94  95  96  97  98  99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331

<?php

/*
 * This file is part of the ICanBoogie package.
 *
 * (c) Olivier Laviale <olivier.laviale@gmail.com>
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */

namespace ICanBoogie;

/**
 * Exception thrown when there is something wrong with an array offset.
 *
 * This is the base class for offset exceptions, one should rather use the
 * {@link OffsetNotReadable} or {@link OffsetNotWritable} exceptions.
 */
class OffsetError extends \RuntimeException
{

}

/**
 * Exception thrown when an array offset is not defined.
 *
 * For example, this could be triggered by an offset out of bounds while setting an array value.
 */
class OffsetNotDefined extends OffsetError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($offset, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'Undefined offset %offset for object of class %class.', array
                    (
                        '%offset' => $offset,
                        '%class' => get_class($container)
                    )
                );
            }
            else if (is_array($container))
            {
                $message = format
                (
                    'Undefined offset %offset for the array: !array', array
                    (
                        '%offset' => $offset,
                        '!array' => $container
                    )
                );
            }
            else
            {
                $message = format
                (
                    'Undefined offset %offset.', array
                    (
                        '%offset' => $offset
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when an array offset is not readable.
 */
class OffsetNotReadable extends OffsetError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($offset, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'The offset %offset for object of class %class is not readable.', array
                    (
                        'offset' => $offset,
                        'class' => get_class($container)
                    )
                );
            }
            else if (is_array($container))
            {
                $message = format
                (
                    'The offset %offset is not readable for the array: !array', array
                    (
                        'offset' => $offset,
                        'array' => $container
                    )
                );
            }
            else
            {
                $message = format
                (
                    'The offset %offset is not readable.', array
                    (
                        'offset' => $offset
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when an array offset is not writable.
 */
class OffsetNotWritable extends OffsetError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($offset, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'The offset %offset for object of class %class is not writable.', array
                    (
                        'offset' => $offset,
                        'class' => get_class($container)
                    )
                );
            }
            else if (is_array($container))
            {
                $message = format
                (
                    'The offset %offset is not writable for the array: !array', array
                    (
                        'offset' => $offset,
                        'array' => $container
                    )
                );
            }
            else
            {
                $message = format
                (
                    'The offset %offset is not writable.', array
                    (
                        'offset' => $offset
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when there is something wrong with an object property.
 *
 * This is the base class for property exceptions, one should rather use the
 * {@link PropertyNotDefined}, {@link PropertyNotReadable} or {@link PropertyNotWritable}
 * exceptions.
 */
class PropertyError extends \RuntimeException
{

}

/**
 * Exception thrown when a property is not defined.
 *
 * For example, this could be triggered by getting the value of an undefined property.
 */
class PropertyNotDefined extends PropertyError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($property, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'Undefined property %property for object of class %class.', array
                    (
                        '%property' => $property,
                        '%class' => get_class($container)
                    )
                );
            }
            else
            {
                $message = format
                (
                    'Undefined property %property.', array
                    (
                        '%property' => $property
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when a property is not readable.
 *
 * For example, this could be triggered when a private property is read from a public scope.
 */
class PropertyNotReadable extends PropertyError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($property, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'The property %property for object of class %class is not readable.', array
                    (
                        '%property' => $property,
                        '%class' => get_class($container)
                    )
                );
            }
            else
            {
                $message = format
                (
                    'The property %property is not readable.', array
                    (
                        '%property' => $property
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when a property is not writable.
 *
 * For example, this could be triggered when a private property is written from a public scope.
 */
class PropertyNotWritable extends PropertyError
{
    public function __construct($message, $code=500, \Exception $previous=null)
    {
        if (is_array($message))
        {
            list($property, $container) = $message + array(1 => null);

            if (is_object($container))
            {
                $message = format
                (
                    'The property %property for object of class %class is not writable.', array
                    (
                        '%property' => $property,
                        '%class' => get_class($container)
                    )
                );
            }
            else
            {
                $message = format
                (
                    'The property %property is not writable.', array
                    (
                        '%property' => $property
                    )
                );
            }
        }

        parent::__construct($message, $code, $previous);
    }
}

/**
 * Exception thrown when a property has a reserved name.
 *
 * @property-read string $property Name of the reserved property.
 */
class PropertyIsReserved extends PropertyError
{
    private $property;

    public function __construct($property, $code=500, \Exception $previous=null)
    {
        $this->property = $property;

        parent::__construct(format('Property %property is reserved.', array('%property' => $property)), $code, $previous);
    }

    public function __get($property)
    {
        if ($property === 'property')
        {
            return $this->property;
        }

        throw new PropertyNotDefined(array($property, $this));
    }
}

Namespaces

Classes

Interfaces

Traits

Exceptions

Functions