Completed
Pull Request — master (#4)
by Jérémy
02:00
created

InvalidFeedException::invalidAuthorProperty()   A

Complexity

Conditions 1
Paths 1

Size

Total Lines 4
Code Lines 2

Duplication

Lines 0
Ratio 0 %

Importance

Changes 0
Metric Value
dl 0
loc 4
rs 10
c 0
b 0
f 0
cc 1
eloc 2
nc 1
nop 1
1
<?php
2
3
namespace JDecool\JsonFeed\Exceptions;
4
5
use RuntimeException;
0 ignored issues
show
Bug introduced by
This use statement conflicts with another class in this namespace, JDecool\JsonFeed\Exceptions\RuntimeException.

Let’s assume that you have a directory layout like this:

.
|-- OtherDir
|   |-- Bar.php
|   `-- Foo.php
`-- SomeDir
    `-- Foo.php

and let’s assume the following content of Bar.php:

// Bar.php
namespace OtherDir;

use SomeDir\Foo; // This now conflicts the class OtherDir\Foo

If both files OtherDir/Foo.php and SomeDir/Foo.php are loaded in the same runtime, you will see a PHP error such as the following:

PHP Fatal error:  Cannot use SomeDir\Foo as Foo because the name is already in use in OtherDir/Foo.php

However, as OtherDir/Foo.php does not necessarily have to be loaded and the error is only triggered if it is loaded before OtherDir/Bar.php, this problem might go unnoticed for a while. In order to prevent this error from surfacing, you must import the namespace with a different alias:

// Bar.php
namespace OtherDir;

use SomeDir\Foo as SomeDirFoo; // There is no conflict anymore.
Loading history...
6
7
class InvalidFeedException extends RuntimeException
8
{
9
    /**
10
     * @return InvalidFeedException
11
     */
12
    public static function invalidJsonException()
13
    {
14
        return new self('Invalid JSONFeed string');
15
    }
16
17
    /**
18
     * @return InvalidFeedException
19
     */
20
    public static function undefinedVersionException()
21
    {
22
        return new self('Undefined JSONFeed version');
23
    }
24
25
    /**
26
     * @param string $property
27
     * @return InvalidFeedException
28
     */
29
    public static function invalidFeedProperty($property)
30
    {
31
        return new self(sprintf('Invalid feed property "%s"', $property));
32
    }
33
34
    /**
35
     * @param string $property
36
     * @return InvalidFeedException
37
     */
38
    public static function invalidItemProperty($property)
39
    {
40
        return new self(sprintf('Invalid item property "%s"', $property));
41
    }
42
43
    /**
44
     * @param string $property
45
     * @return InvalidFeedException
46
     */
47
    public static function invalidAuthorProperty($property)
48
    {
49
        return new self(sprintf('Invalid author property "%s"', $property));
50
    }
51
}
52