EveApiPreserverInterface::preserveEveApi() - Code Metrics - Yapeal/yapeal-ng - Measure and Improve Code Quality continuously with Scrutinizer

EveApiPreserverInterface::preserveEveApi()
last analyzed 2017-01-23 23:44 UTC

↳ Parent: EveApiPreserverInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

Metric	Value
dl	0
loc	1
c	0
b	0
f	0

<?php
declare(strict_types = 1);
/**
 * Contains EveApiPreserverInterface Interface.
 *
 * PHP version 7.0+
 *
 * LICENSE:
 * This file is part of Yet Another Php Eve Api Library also know as Yapeal
 * which can be used to access the Eve Online API data and place it into a
 * database.
 * Copyright (C) 2014-2017 Michael Cummings
 *
 * This program is free software: you can redistribute it and/or modify it
 * under the terms of the GNU Lesser General Public License as published by the
 * Free Software Foundation, either version 3 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 Lesser General Public License
 * for more details.
 *
 * You should have received a copy of the GNU Lesser General Public License
 * along with this program. If not, see
 * <http://spdx.org/licenses/LGPL-3.0.html>.
 *
 * You should be able to find a copy of this license in the COPYING-LESSER.md
 * file. A copy of the GNU GPL should also be available in the COPYING.md file.
 *
 * @copyright 2014-2017 Michael Cummings
 * @license   LGPL-3.0+
 * @author    Michael Cummings <[email protected]>
 */
namespace Yapeal\Event;

/**
 * Common interface for any class that would preserve (save / cache) the Eve Api
 * data in some way.
 */
interface EveApiPreserverInterface
{
    /**
     * @param EveApiEventInterface $event
     * @param string               $eventName
     * @param MediatorInterface    $yem
     *
     * @return EveApiEventInterface
     *
     */
    public function preserveEveApi(EveApiEventInterface $event, string $eventName, MediatorInterface $yem): EveApiEventInterface;

    /**
     * Turn on or off preserving of Eve API data by this preserver.
     *
     * Allows class to stay registered for events but be enabled or disabled during runtime.
     *
     * @param boolean $value
     */
    public function setPreserve(bool $value = true);

}


1			<?php
2			declare(strict_types = 1);
3			/**
4			* Contains EveApiPreserverInterface Interface.
5			*
6			* PHP version 7.0+
7			*
8			* LICENSE:
9			* This file is part of Yet Another Php Eve Api Library also know as Yapeal
10			* which can be used to access the Eve Online API data and place it into a
11			* database.
12			* Copyright (C) 2014-2017 Michael Cummings
13			*
14			* This program is free software: you can redistribute it and/or modify it
15			* under the terms of the GNU Lesser General Public License as published by the
16			* Free Software Foundation, either version 3 of the License, or (at your
17			* option) any later version.
18			*
19			* This program is distributed in the hope that it will be useful, but WITHOUT
20			* ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
21			* FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License
22			* for more details.
23			*
24			* You should have received a copy of the GNU Lesser General Public License
25			* along with this program. If not, see
26			* <http://spdx.org/licenses/LGPL-3.0.html>.
27			*
28			* You should be able to find a copy of this license in the COPYING-LESSER.md
29			* file. A copy of the GNU GPL should also be available in the COPYING.md file.
30			*
31			* @copyright 2014-2017 Michael Cummings
32			* @license LGPL-3.0+
33			* @author Michael Cummings <[email protected]>
34			*/
35			namespace Yapeal\Event;
36
37			/**
38			* Common interface for any class that would preserve (save / cache) the Eve Api
39			* data in some way.
40			*/
41			interface EveApiPreserverInterface
42			{
43			/**
44			* @param EveApiEventInterface $event
45			* @param string $eventName
46			* @param MediatorInterface $yem
47			*
48			* @return EveApiEventInterface
49			*
50			*/
51			public function preserveEveApi(EveApiEventInterface $event, string $eventName, MediatorInterface $yem): EveApiEventInterface;
			0 ignored issues – show Coding Style introduced 2016-08-03 01:05 UTC by Report Bug Copy Issue Report This line exceeds maximum limit of 120 characters; contains 129 characters Overly long lines are hard to read on any screen. Most code styles therefor impose a maximum limit on the number of characters in a line. Loading history...
52			/**
53			* Turn on or off preserving of Eve API data by this preserver.
54			*
55			* Allows class to stay registered for events but be enabled or disabled during runtime.
56			*
57			* @param boolean $value
58			*/
59			public function setPreserve(bool $value = true);
			0 ignored issues – show Documentation introduced 2016-12-13 00:05 UTC by Report Bug Copy Issue Report For interfaces and abstract methods it is generally a good practice to add a `@return` annotation even if it is just `@return void` or `@return null`, so that implementors know what to do in the overridden method. For interface and abstract methods, it is impossible to infer the return type from the immediate code. In these cases, it is generally advisible to explicitly annotate these methods with a `@return` doc comment to communicate to implementors of these methods what they are expected to return. Loading history...
60			}
61

Yapeal / yapeal-ng

EveApiPreserverInterface::preserveEveApi() last analyzed 2017-01-23 23:44 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

EveApiPreserverInterface::preserveEveApi()
last analyzed 2017-01-23 23:44 UTC