These results are based on our legacy PHP analysis, consider migrating to our new PHP analysis engine instead. Learn more
1 | <?php |
||
2 | |||
3 | namespace SMW\DataValues\ValueFormatters; |
||
4 | |||
5 | use SMW\ApplicationFactory; |
||
6 | use SMW\Highlighter; |
||
7 | use SMW\Message; |
||
8 | use SMWDataValue as DataValue; |
||
9 | use SMWPropertyValue as PropertyValue; |
||
10 | use RuntimeException; |
||
11 | |||
12 | /** |
||
13 | * @license GNU GPL v2+ |
||
14 | * @since 2.5 |
||
15 | * |
||
16 | * @author mwjames |
||
17 | */ |
||
18 | class PropertyValueFormatter extends DataValueFormatter { |
||
19 | |||
20 | /** |
||
21 | * @since 2.5 |
||
22 | * |
||
23 | * {@inheritDoc} |
||
24 | */ |
||
25 | 155 | public function isFormatterFor( DataValue $dataValue ) { |
|
26 | 155 | return $dataValue instanceof PropertyValue; |
|
27 | } |
||
28 | |||
29 | /** |
||
30 | * @since 2.5 |
||
31 | * |
||
32 | * {@inheritDoc} |
||
33 | */ |
||
34 | 94 | public function format( $type, $linker = null ) { |
|
35 | |||
36 | 94 | if ( !$this->dataValue instanceof PropertyValue ) { |
|
37 | 1 | throw new RuntimeException( "The formatter is missing a valid PropertyValue object" ); |
|
38 | } |
||
39 | |||
40 | 93 | if ( !$this->dataValue->isVisible() ) { |
|
41 | 1 | return ''; |
|
42 | } |
||
43 | |||
44 | 92 | if ( $type === self::VALUE ) { |
|
45 | 73 | return $this->getWikiValue(); |
|
46 | } |
||
47 | |||
48 | 66 | $wikiPageValue = $this->prepareWikiPageValue( $linker ); |
|
49 | |||
50 | 66 | if ( $wikiPageValue === null ) { |
|
51 | return ''; |
||
52 | } |
||
53 | |||
54 | 66 | if ( $type === self::WIKI_SHORT ) { |
|
55 | 47 | $text = $this->doHighlightText( $wikiPageValue->getShortWikiText( $linker ) ); |
|
56 | } |
||
57 | |||
58 | 66 | if ( $type === self::HTML_SHORT ) { |
|
59 | 12 | $text = $this->doHighlightText( $wikiPageValue->getShortHTMLText( $linker ), $linker ); |
|
60 | } |
||
61 | |||
62 | 66 | if ( $type === self::WIKI_LONG ) { |
|
63 | 14 | $text = $this->doHighlightText( $wikiPageValue->getLongWikiText( $linker ) ); |
|
64 | } |
||
65 | |||
66 | 66 | if ( $type === self::HTML_LONG ) { |
|
67 | 2 | $text = $this->doHighlightText( $wikiPageValue->getLongHTMLText( $linker ), $linker ); |
|
68 | } |
||
69 | |||
70 | 66 | return $text . $this->hintPreferredLabelUse(); |
|
0 ignored issues
–
show
|
|||
71 | } |
||
72 | |||
73 | 73 | private function getWikiValue() { |
|
74 | |||
75 | 73 | if ( $this->dataValue->getPreferredLabel() !== '' ) { |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getPreferredLabel() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
76 | 22 | return $this->dataValue->getPreferredLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getPreferredLabel() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
77 | } |
||
78 | |||
79 | 61 | if ( $this->dataValue->getWikiPageValue() !== null && $this->dataValue->getWikiPageValue()->getDisplayTitle() !== '' ) { |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getWikiPageValue() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
80 | 1 | return $this->dataValue->getWikiPageValue()->getDisplayTitle(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getWikiPageValue() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
81 | } |
||
82 | |||
83 | 60 | return $this->dataValue->getDataItem()->getLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataItem as the method getLabel() does only exist in the following sub-classes of SMWDataItem : SMWDIProperty , SMW\DIProperty . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
84 | } |
||
85 | |||
86 | 66 | private function prepareWikiPageValue( $linker = null ) { |
|
0 ignored issues
–
show
|
|||
87 | |||
88 | 66 | $wikiPageValue = $this->dataValue->getWikiPageValue(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getWikiPageValue() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
89 | |||
90 | 66 | if ( $wikiPageValue === null ) { |
|
91 | return null; |
||
92 | } |
||
93 | |||
94 | 66 | $label = $this->dataValue->getDataItem()->getLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataItem as the method getLabel() does only exist in the following sub-classes of SMWDataItem : SMWDIProperty , SMW\DIProperty . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
95 | 66 | $preferredLabel = $this->dataValue->getPreferredLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getPreferredLabel() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
96 | 66 | $caption = $this->dataValue->getCaption(); |
|
97 | |||
98 | 66 | if ( $caption !== false && $caption !== '' ) { |
|
99 | 56 | $wikiPageValue->setCaption( $caption ); |
|
100 | 14 | } elseif ( $preferredLabel !== '' ) { |
|
101 | $wikiPageValue->setCaption( $preferredLabel ); |
||
102 | } else { |
||
103 | 14 | $wikiPageValue->setCaption( $label ); |
|
104 | } |
||
105 | |||
106 | 66 | return $wikiPageValue; |
|
107 | } |
||
108 | |||
109 | 66 | private function doHighlightText( $text, $linker = null ) { |
|
110 | |||
111 | 66 | $content = ''; |
|
112 | |||
113 | 66 | if ( !$this->canHighlight( $content, $linker ) ) { |
|
114 | 58 | return $text; |
|
115 | } |
||
116 | |||
117 | 17 | $highlighter = Highlighter::factory( |
|
118 | 17 | Highlighter::TYPE_PROPERTY, |
|
119 | 17 | $this->dataValue->getOptionBy( PropertyValue::OPT_USER_LANGUAGE ) |
|
0 ignored issues
–
show
|
|||
120 | ); |
||
121 | |||
122 | 17 | $highlighter->setContent( array ( |
|
123 | 17 | 'userDefined' => $this->dataValue->getDataItem()->isUserDefined(), |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataItem as the method isUserDefined() does only exist in the following sub-classes of SMWDataItem : SMWDIProperty , SMW\DIProperty . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
124 | 17 | 'caption' => $text, |
|
125 | 17 | 'content' => $content !== '' ? $content : Message::get( 'smw_isspecprop' ) |
|
126 | ) ); |
||
127 | |||
128 | 17 | return $highlighter->getHtml(); |
|
129 | } |
||
130 | |||
131 | 66 | private function canHighlight( &$propertyDescription, $linker ) { |
|
132 | |||
133 | 66 | if ( $this->dataValue->getOptionBy( PropertyValue::OPT_NO_HIGHLIGHT ) === true ) { |
|
134 | 2 | return false; |
|
135 | } |
||
136 | |||
137 | 66 | $dataItem = $this->dataValue->getDataItem(); |
|
138 | 66 | $propertySpecificationLookup = ApplicationFactory::getInstance()->getPropertySpecificationLookup(); |
|
139 | |||
140 | 66 | $propertyDescription = $propertySpecificationLookup->getPropertyDescriptionBy( |
|
141 | $dataItem, |
||
0 ignored issues
–
show
$dataItem of type object<SMWDataItem> is not a sub-type of object<SMW\DIProperty> . It seems like you assume a child class of the class SMWDataItem to be always present.
This check looks for parameters that are defined as one type in their type hint or doc comment but seem to be used as a narrower type, i.e an implementation of an interface or a subclass. Consider changing the type of the parameter or doing an instanceof check before assuming your parameter is of the expected type. ![]() |
|||
142 | $linker |
||
143 | ); |
||
144 | |||
145 | 66 | return !$dataItem->isUserDefined() || $propertyDescription !== ''; |
|
146 | } |
||
147 | |||
148 | 66 | private function hintPreferredLabelUse() { |
|
149 | |||
150 | 66 | $preferredLabel = $this->dataValue->getPreferredLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataValue as the method getPreferredLabel() does only exist in the following sub-classes of SMWDataValue : SMWPropertyValue . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
151 | 66 | $label = $this->dataValue->getDataItem()->getLabel(); |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataItem as the method getLabel() does only exist in the following sub-classes of SMWDataItem : SMWDIProperty , SMW\DIProperty . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
152 | |||
153 | 66 | if ( !$this->dataValue->isEnabledFeature( SMW_DV_PROV_LHNT ) || |
|
154 | 57 | $preferredLabel === $this->dataValue->getDataItem()->getCanonicalLabel() || |
|
0 ignored issues
–
show
It seems like you code against a specific sub-type and not the parent class
SMWDataItem as the method getCanonicalLabel() does only exist in the following sub-classes of SMWDataItem : SMWDIProperty , SMW\DIProperty . Maybe you want to instanceof check for one of these explicitly?
Let’s take a look at an example: abstract class User
{
/** @return string */
abstract public function getPassword();
}
class MyUser extends User
{
public function getPassword()
{
// return something
}
public function getDisplayName()
{
// return some name.
}
}
class AuthSystem
{
public function authenticate(User $user)
{
$this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
// do something.
}
}
In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different sub-classes of User which does not have a getDisplayName() method, the code will break. Available Fixes
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types
inside the if block in such a case.
![]() |
|||
155 | 66 | $preferredLabel === '' ) { |
|
156 | 60 | return ''; |
|
157 | } |
||
158 | |||
159 | 7 | $preferredLabelMarker = ''; |
|
160 | |||
161 | 7 | if ( $preferredLabel !== $label ) { |
|
162 | 7 | $preferredLabelMarker = ' ' . \Html::rawElement( 'span', array( 'title' => $label ), '<sup>ᵖ</sup>' ); |
|
163 | } |
||
164 | |||
165 | 7 | return $preferredLabelMarker; |
|
166 | } |
||
167 | |||
168 | } |
||
169 |
If you define a variable conditionally, it can happen that it is not defined for all execution paths.
Let’s take a look at an example:
In the above example, the variable $x is defined if you pass “foo” or “bar” as argument for $a. However, since the switch statement has no default case statement, if you pass any other value, the variable $x would be undefined.
Available Fixes
Check for existence of the variable explicitly:
Define a default value for the variable:
Add a value for the missing path: