SMGeoPolygonsValue   A
last analyzed

Complexity

Total Complexity 12

Size/Duplication

Total Lines 94
Duplicated Lines 0 %

Coupling/Cohesion

Components 1
Dependencies 3

Test Coverage

Coverage 0%

Importance

Changes 0
Metric Value
dl 0
loc 94
rs 10
c 0
b 0
f 0
ccs 0
cts 40
cp 0
wmc 12
lcom 1
cbo 3

8 Methods

Rating   Name   Duplication   Size   Complexity  
A loadDataItem() 0 8 2
A parseUserValue() 0 10 3
A getShortWikiText() 0 7 2
A getShortHTMLText() 0 3 1
A getLongWikiText() 0 3 1
A getLongHTMLText() 0 3 1
A getWikiValue() 0 3 1
A getExportData() 0 3 1
1
<?php
2
3
/**
4
 * Implementation of datavalues that are geographic shapes.
5
 *
6
 * @since 2.0
7
 *
8
 * @file SM_GeoPolgonValue.php
9
 * @ingroup SemanticMaps
10
 * @ingroup SMWDataValues
11
 *
12
 * @author Nischay Nahata
13
 */
14
class SMGeoPolygonsValue extends SMWDataValue {
15
16
	/**
17
	 * @see SMWDataValue::setDataItem()
18
	 *
19
	 * @param $dataitem SMWDataItem
20
	 *
21
	 * @return boolean
22
	 */
23
	protected function loadDataItem( SMWDataItem $dataItem ) {
24
		if ( $dataItem instanceof SMWDIBlob ) {
25
			$this->m_dataitem = $dataItem;
26
			return true;
27
		} else {
28
			return false;
29
		}
30
	}
31
32
	/**
33
	 * NOTE: Do param validation.
34
	 * TODO: Stores as a Blob, use better data structure
35
	 * @see SMWDataValue::parseUserValue
36
	 *
37
	 * @since 2.0
38
	 */
39
	protected function parseUserValue( $value ) {
40
		if ( $value === '' ) {
41
			$this->addError( wfMessage( 'smw_emptystring' )->inContentLanguage()->text() );
42
		}
43
		$polyHandler = new PolygonHandler ( $value );
44
		foreach( $polyHandler->getValidationErrors() as $errMsg ) {
45
			$this->addError( $errMsg );
46
		}
47
		$this->m_dataitem = new SMWDIBlob( $value, $this->m_typeid );
0 ignored issues
show
Unused Code introduced by
The call to SMWDIBlob::__construct() has too many arguments starting with $this->m_typeid.

This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.

If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.

In this case you can add the @ignore PhpDoc annotation to the duplicate definition and it will be ignored.

Loading history...
48
	}
49
50
	/**
51
	 * @see SMWDataValue::getShortWikiText
52
	 *
53
	 * @since 2.0
54
	 */
55
	public function getShortWikiText( $linked = null ) {
56
		if ( $this->isValid() ) {
57
			return $this->m_dataitem->getString();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class SMWDataItem as the method getString() does only exist in the following sub-classes of SMWDataItem: SMWDIBlob, SMWDIError, SMWDIString. 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
58
		} else {
59
			return $this->getErrorText();
60
		}
61
	}
62
63
	/**
64
	 * @see SMWDataValue::getShortHTMLText
65
	 *
66
	 * @since 2.0
67
	 */
68
	public function getShortHTMLText( $linker = null ) {
69
		return $this->getShortWikiText( $linker );
70
	}
71
72
	/**
73
	 * @see SMWDataValue::getLongWikiText
74
	 *
75
	 * @since 2.0
76
	 */
77
	public function getLongWikiText( $linker = null ) {
78
		return $this->getShortWikiText( $linker );
79
	}
80
81
	/**
82
	 * @see SMWDataValue::getLongHTMLText
83
	 *
84
	 * @since 2.0
85
	 */
86
	public function getLongHTMLText( $linker = null ) {
87
		return $this->getLongWikiText( $linker );
88
	}
89
90
	/**
91
	 * @see SMWDataValue::getWikiValue
92
	 *
93
	 * @since 2.0
94
	 */
95
	public function getWikiValue() {
96
		return $this->m_dataitem->getString();
0 ignored issues
show
Bug introduced by
It seems like you code against a specific sub-type and not the parent class SMWDataItem as the method getString() does only exist in the following sub-classes of SMWDataItem: SMWDIBlob, SMWDIError, SMWDIString. 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

  1. Change the type-hint for the parameter:

    class AuthSystem
    {
        public function authenticate(MyUser $user) { /* ... */ }
    }
    
  2. Add an additional type-check:

    class AuthSystem
    {
        public function authenticate(User $user)
        {
            if ($user instanceof MyUser) {
                $this->logger->info(/** ... */);
            }
    
            // or alternatively
            if ( ! $user instanceof MyUser) {
                throw new \LogicException(
                    '$user must be an instance of MyUser, '
                   .'other instances are not supported.'
                );
            }
    
        }
    }
    
Note: PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case.
  1. Add the method to the parent class:

    abstract class User
    {
        /** @return string */
        abstract public function getPassword();
    
        /** @return string */
        abstract public function getDisplayName();
    }
    
Loading history...
97
	}
98
99
	/**
100
	 * @see SMWDataValue::getExportData
101
	 *
102
	 * @since 2.0
103
	 */
104
	public function getExportData() {
105
		return null;
106
	}
107
}
108