Project::getApi() - Code Metrics - Inspection of "Simplify ApiHelper::setup to use Project" - x-tools/xtools - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 050bb3...76bbec )

by Sam

created 2017-06-06 07:51 UTC

Project::getApi() A

↳ Parent: Project

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
c	0
b	0
f	0
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

namespace Xtools;

use Mediawiki\Api\MediawikiApi;

/**
 * A Project is a single wiki that Xtools is querying.
 */
class Project extends Model
{

    /** @var string The project name as supplied by the user. */
    protected $nameUnnormalized;

    /** @var string[] Basic metadata about the project */
    protected $metadata;

    public function __construct($nameOrUrl)
    {
        $this->nameUnnormalized = $nameOrUrl;
    }

    protected function getMetadata()
    {
        if (!$this->metadata) {

            $this->metadata = $this->getRepository()->getOne($this->nameUnnormalized);
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.
    }
}
        }
        return $this->metadata;
    }

    /**
     * Does this project exist?
     * @return bool
     */
    public function exists()
    {
        return !empty($this->getDomain());
    }

    /**
     * The unique domain name of this project, without protocol or path components.
     * This should be used as the canonical project identifier.
     *
     * @return string
     */
    public function getDomain()
    {
        $url = isset($this->getMetadata()['url']) ? $this->getMetadata()['url'] : '';
        return parse_url($url, PHP_URL_HOST);
    }

    /**
     * The name of the database for this project.
     *
     * @return string
     */
    public function getDatabaseName()
    {
        return isset($this->getMetadata()['dbname']) ? $this->getMetadata()['dbname'] : '';
    }

    /**
     * The project URL is the fully-qualified domain name, with protocol and trailing slash.
     *
     * @return string
     */
    public function getUrl()
    {
        return rtrim($this->getMetadata()['url'], '/') . '/';
    }

    /**
     * Get a MediawikiApi object for this Project.
     *
     * @return MediawikiApi
     */
    public function getApi()
    {
        return $this->getRepository()->getMediawikiApi($this);
    }

    /**
     * The base URL path of this project (that page titles are appended to).
     *
     * @link https://www.mediawiki.org/wiki/Manual:$wgArticlePath
     *
     * @return string
     */
    public function getArticlePath()

    {
        $metadata = $this->getRepository()->getMetadata($this->getUrl());
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.
    }
}
        return isset($metadata['general']['articlePath'])
            ? $metadata['general']['articlePath']
            : '/wiki/';
    }

    /**
     * The URL path to index.php
     *
     * @link https://www.mediawiki.org/wiki/Manual:$wgScriptPath
     *
     * @return string
     */
    public function getScriptPath()

    {
        $metadata = $this->getRepository()->getMetadata($this->getUrl());
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.
    }
}
        return isset($metadata['general']['scriptPath'])
            ? $metadata['general']['scriptPath']
            : '/w/index.php';
    }

    /**
     * Get this project's title, the human-language full title of the wiki (e.g. "English
     * Wikipedia" or
     */
    public function getTitle()
    {
        $metadata = $this->getRepository()->getMetadata($this->getUrl());
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.
    }
}
        return $metadata['general']['wikiName'].' ('.$this->getDomain().')';
    }

    /**
     * Get an array of this project's namespaces and their IDs.
     *
     * @return string[] Keys are IDs, values are names.
     */
    public function getNamespaces()
    {
        $metadata = $this->getRepository()->getMetadata($this->getUrl());
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.
    }
}
        return $metadata['namespaces'];
    }
}


1		<?php
2
3		namespace Xtools;
4
5		use Mediawiki\Api\MediawikiApi;
6
7		/**
8		* A Project is a single wiki that Xtools is querying.
9		*/
10		class Project extends Model
11		{
12
13		/** @var string The project name as supplied by the user. */
14		protected $nameUnnormalized;
15
16		/** @var string[] Basic metadata about the project */
17		protected $metadata;
18
19		public function __construct($nameOrUrl)
20		{
21		$this->nameUnnormalized = $nameOrUrl;
22		}
23
24		protected function getMetadata()
25		{
26		if (!$this->metadata) {
		0 ignored issues – show Bug Best Practice introduced 2017-05-01 09:11 UTC by Report Bug Copy Issue Report The expression `$this->metadata` of type `string[]` is implicitly converted to a boolean; are you sure this is intended? If so, consider using `empty($expr)` instead to make it clear that you intend to check for an array without elements. This check marks implicit conversions of arrays to boolean values in a comparison. While in PHP an empty array is considered to be equal (but not identical) to false, this is not always apparent. Consider making the comparison explicit by using `empty(..)` or `! empty(...)` instead. Loading history...
27		$this->metadata = $this->getRepository()->getOne($this->nameUnnormalized);
		1 ignored issue – show Bug introduced 2017-05-02 01:55 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getOne()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\ProjectRepository`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
28		}
29		return $this->metadata;
30		}
31
32		/**
33		* Does this project exist?
34		* @return bool
35		*/
36		public function exists()
37		{
38		return !empty($this->getDomain());
39		}
40
41		/**
42		* The unique domain name of this project, without protocol or path components.
43		* This should be used as the canonical project identifier.
44		*
45		* @return string
46		*/
47		public function getDomain()
48		{
49		$url = isset($this->getMetadata()['url']) ? $this->getMetadata()['url'] : '';
50		return parse_url($url, PHP_URL_HOST);
51		}
52
53		/**
54		* The name of the database for this project.
55		*
56		* @return string
57		*/
58		public function getDatabaseName()
59		{
60		return isset($this->getMetadata()['dbname']) ? $this->getMetadata()['dbname'] : '';
61		}
62
63		/**
64		* The project URL is the fully-qualified domain name, with protocol and trailing slash.
65		*
66		* @return string
67		*/
68		public function getUrl()
69		{
70		return rtrim($this->getMetadata()['url'], '/') . '/';
71		}
72
73		/**
74		* Get a MediawikiApi object for this Project.
75		*
76		* @return MediawikiApi
77		*/
78		public function getApi()
79		{
80		return $this->getRepository()->getMediawikiApi($this);
81		}
82
83		/**
84		* The base URL path of this project (that page titles are appended to).
85		*
86		* @link https://www.mediawiki.org/wiki/Manual:$wgArticlePath
87		*
88		* @return string
89		*/
90	View Code Duplication	public function getArticlePath()
		0 ignored issues – show Duplication introduced 2017-05-02 07:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
91		{
92		$metadata = $this->getRepository()->getMetadata($this->getUrl());
		1 ignored issue – show Bug introduced 2017-05-02 02:38 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getMetadata()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\ProjectRepository`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
93		return isset($metadata['general']['articlePath'])
94		? $metadata['general']['articlePath']
95		: '/wiki/';
96		}
97
98		/**
99		* The URL path to index.php
100		*
101		* @link https://www.mediawiki.org/wiki/Manual:$wgScriptPath
102		*
103		* @return string
104		*/
105	View Code Duplication	public function getScriptPath()
		0 ignored issues – show Duplication introduced 2017-05-02 07:27 UTC by Report Bug Copy Issue Report This method seems to be duplicated in your project. Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation. You can also find more detailed suggestions in the “Code” section of your repository. Loading history...
106		{
107		$metadata = $this->getRepository()->getMetadata($this->getUrl());
		1 ignored issue – show Bug introduced 2017-05-02 07:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getMetadata()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\ProjectRepository`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
108		return isset($metadata['general']['scriptPath'])
109		? $metadata['general']['scriptPath']
110		: '/w/index.php';
111		}
112
113		/**
114		* Get this project's title, the human-language full title of the wiki (e.g. "English
115		* Wikipedia" or
116		*/
117		public function getTitle()
118		{
119		$metadata = $this->getRepository()->getMetadata($this->getUrl());
		1 ignored issue – show Bug introduced 2017-05-02 07:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getMetadata()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\ProjectRepository`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
120		return $metadata['general']['wikiName'].' ('.$this->getDomain().')';
121		}
122
123		/**
124		* Get an array of this project's namespaces and their IDs.
125		*
126		* @return string[] Keys are IDs, values are names.
127		*/
128		public function getNamespaces()
129		{
130		$metadata = $this->getRepository()->getMetadata($this->getUrl());
		1 ignored issue – show Bug introduced 2017-05-02 07:27 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Xtools\Repository` as the method `getMetadata()` does only exist in the following sub-classes of `Xtools\Repository`: `Xtools\ProjectRepository`. 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 Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } 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. Add the method to the parent class: abstract class User { /** @return string / abstract public function getPassword(); /* @return string */ abstract public function getDisplayName(); } Loading history...
131		return $metadata['namespaces'];
132		}
133		}
134

x-tools / xtools

Push — master ( 050bb3...76bbec )

Project::getApi() A

Complexity

Size

Duplication

Importance

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Available Fixes

Duplication Side-by-Side

Filter issues like