ProfilerOutputDump::canUse() - Code Metrics - wikimedia/mediawiki - Measure and Improve Code Quality continuously with Scrutinizer

ProfilerOutputDump::canUse() A
last analyzed 2016-11-13 17:42 UTC

↳ Parent: ProfilerOutputDump

Complexity

Conditions	2
Paths	2

Size

Total Lines	6
Code Lines	4

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
cc	2
eloc	4
nc	2
nop	0
dl	0
loc	6
rs	9.4285
c	0
b	0
f	0

<?php
/**
 * Profiler dumping output in xhprof dump file
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License along
 * with this program; if not, write to the Free Software Foundation, Inc.,
 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 * http://www.gnu.org/copyleft/gpl.html
 *
 * @file
 * @ingroup Profiler
 */

/**
 * Profiler dumping output in xhprof dump file
 * @ingroup Profiler
 *
 * @since 1.25
 */
class ProfilerOutputDump extends ProfilerOutput {

	protected $suffix = ".xhprof";

	/**
	 * Can this output type be used?
	 *
	 * @return bool
	 */
	public function canUse() {
		if ( empty( $this->params['outputDir'] ) ) {
			return false;
		}
		return true;
	}

	public function log( array $stats ) {
		$data = $this->collector->getRawData();
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.
    }
}
		$filename = sprintf( "%s/%s.%s%s",
			$this->params['outputDir'],
			uniqid(),
			$this->collector->getProfileID(),
			$this->suffix );
		file_put_contents( $filename, serialize( $data ) );
	}
}


1			<?php
2			/**
3			* Profiler dumping output in xhprof dump file
4			*
5			* This program is free software; you can redistribute it and/or modify
6			* it under the terms of the GNU General Public License as published by
7			* the Free Software Foundation; either version 2 of the License, or
8			* (at your option) any later version.
9			*
10			* This program is distributed in the hope that it will be useful,
11			* but WITHOUT ANY WARRANTY; without even the implied warranty of
12			* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
13			* GNU General Public License for more details.
14			*
15			* You should have received a copy of the GNU General Public License along
16			* with this program; if not, write to the Free Software Foundation, Inc.,
17			* 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
18			* http://www.gnu.org/copyleft/gpl.html
19			*
20			* @file
21			* @ingroup Profiler
22			*/
23
24			/**
25			* Profiler dumping output in xhprof dump file
26			* @ingroup Profiler
27			*
28			* @since 1.25
29			*/
30			class ProfilerOutputDump extends ProfilerOutput {
31
32			protected $suffix = ".xhprof";
33
34			/**
35			* Can this output type be used?
36			*
37			* @return bool
38			*/
39			public function canUse() {
40			if ( empty( $this->params['outputDir'] ) ) {
41			return false;
42			}
43			return true;
44			}
45
46			public function log( array $stats ) {
47			$data = $this->collector->getRawData();
			0 ignored issues – show Bug introduced 2016-01-16 18:00 UTC by Report Bug Copy Issue Report It seems like you code against a specific sub-type and not the parent class `Profiler` as the method `getRawData()` does only exist in the following sub-classes of `Profiler`: `ProfilerXhprof`. 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...
48			$filename = sprintf( "%s/%s.%s%s",
49			$this->params['outputDir'],
50			uniqid(),
51			$this->collector->getProfileID(),
52			$this->suffix );
53			file_put_contents( $filename, serialize( $data ) );
54			}
55			}
56

wikimedia / mediawiki

ProfilerOutputDump::canUse() A last analyzed 2016-11-13 17:42 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

ProfilerOutputDump::canUse() A
last analyzed 2016-11-13 17:42 UTC