ModelInterface::getId() - Code Metrics - allejo/bzion - Measure and Improve Code Quality continuously with Scrutinizer

ModelInterface::getId()
last analyzed 2018-04-10 03:56 UTC

↳ Parent: ModelInterface

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Importance

Changes

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

<?php
/**
 * This file contains the skeleton for all of the database objects
 *
 * @package    BZiON\Models
 * @license    https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
 */

/**
 * A base database object interface
 * @package    BZiON\Models
 */
interface ModelInterface
{
    /**
     * Delete the object
     *
     * Please note that this does not delete the object entirely from the database,
     * it only hides it from users. You should overload this function if your object
     * does not have a 'status' column which can be set to 'deleted'.
     * @return void
     */
    public function delete();

    /**
     * Undo the deletion of a model marked as "deleted" in the database
     * @return void
     */
    public function restore();

    /**
     * Permanently delete the object from the database
     * @return void
     */
    public function wipe();

    /**
     * Get an object's database ID
     * @return int The ID
     */
    public function getId();

    /**
     * See if an object is valid
     * @return bool
     */
    public function isValid();

    /**
     * Check if a status of the object is 'deleted'
     * @return bool
     */
    public function isDeleted();

    /**
     * Gets an entity from the supplied slug, which can either be an alias or an ID
     * @param  string|int $slug The object's slug
     * @return Model
     */
    public static function fetchFromSlug($slug);

    /**
     * Generate an invalid object
     *
     * <code>
     *     <?php
     *     $object = Team::invalid();
     *
     *     get_class($object); // Team
     *     $object->isValid(); // false
     * </code>
     * @return Model
     */
    public static function invalid();
}


1			<?php
2			/**
3			* This file contains the skeleton for all of the database objects
4			*
5			* @package BZiON\Models
6			* @license https://github.com/allejo/bzion/blob/master/LICENSE.md GNU General Public License Version 3
7			*/
8
9			/**
10			* A base database object interface
11			* @package BZiON\Models
12			*/
13			interface ModelInterface
14			{
15			/**
16			* Delete the object
17			*
18			* Please note that this does not delete the object entirely from the database,
19			* it only hides it from users. You should overload this function if your object
20			* does not have a 'status' column which can be set to 'deleted'.
21			* @return void
22			*/
23			public function delete();
24
25			/**
26			* Undo the deletion of a model marked as "deleted" in the database
27			* @return void
28			*/
29			public function restore();
30
31			/**
32			* Permanently delete the object from the database
33			* @return void
34			*/
35			public function wipe();
36
37			/**
38			* Get an object's database ID
39			* @return int The ID
40			*/
41			public function getId();
42
43			/**
44			* See if an object is valid
45			* @return bool
46			*/
47			public function isValid();
48
49			/**
50			* Check if a status of the object is 'deleted'
51			* @return bool
52			*/
53			public function isDeleted();
54
55			/**
56			* Gets an entity from the supplied slug, which can either be an alias or an ID
57			* @param string\|int $slug The object's slug
58			* @return Model
59			*/
60			public static function fetchFromSlug($slug);
61
62			/**
63			* Generate an invalid object
64			*
65			* <code>
66			* <?php
67			* $object = Team::invalid();
68			*
69			* get_class($object); // Team
70			* $object->isValid(); // false
71			* </code>
72			* @return Model
73			*/
74			public static function invalid();
75			}
76

allejo / bzion

ModelInterface::getId() last analyzed 2018-04-10 03:56 UTC

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

ModelInterface::getId()
last analyzed 2018-04-10 03:56 UTC