WordPoints_Entity_Attr::get_field() - Code Metrics - Inspection of "Use a single method to get entity storage info" - WordPoints/hooks-api - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 226003...873ec4 )

by J.D.

created 2016-05-02 12:58 UTC

WordPoints_Entity_Attr::get_field() A

↳ Parent: WordPoints_Entity_Attr

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Metric	Value
dl	0
loc	3
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php

/**
 * Entity attribute class.
 *
 * @package wordpoints-hooks-api
 * @since 1.0.0
 */

/**
 * Represents an Entity attribute.
 *
 * Using a Post as an example type of entity, an example of an attribute would be the
 * title.
 *
 * Each attribute is represented by a child of this class.
 *
 * @since 1.0.0
 */
abstract class WordPoints_Entity_Attr
	extends WordPoints_Entityish
	implements WordPoints_Entity_ChildI {

	/**
	 * The data type of the values of this attribute.
	 *
	 * @since 1.0.0
	 *
	 * @var string
	 */
	protected $data_type;

	/**
	 * Get the value of this attribute from an entity.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Entity $entity The entity.
	 *
	 * @return mixed The attribute value.
	 */
	abstract protected function get_attr_value_from_entity( WordPoints_Entity $entity );

	/**
	 * Get the data type of this attribute's values.
	 *
	 * @since 1.0.0
	 *
	 * @return string The data type of this attribute's values.
	 */
	public function get_data_type() {
		return $this->data_type;
	}

	/**
	 * Set the value of this attribute from an entity.
	 *
	 * This class can represent either a type of attribute generically (e.g., Post
	 * title) or a specific value of that attribute (the title of a specific Post).
	 * This method is used to set a specific value for the attribute this object
	 * should represent.
	 *
	 * @since 1.0.0
	 *
	 * @param WordPoints_Entity $entity An entity object.
	 *
	 * @return bool Whether the value was set correctly.
	 */
	public function set_the_value_from_entity( WordPoints_Entity $entity ) {

		$this->the_value = $this->get_attr_value_from_entity( $entity );

		return true;
	}
}

// EOF


1			<?php
2
3			/**
4			* Entity attribute class.
5			*
6			* @package wordpoints-hooks-api
7			* @since 1.0.0
8			*/
9
10			/**
11			* Represents an Entity attribute.
12			*
13			* Using a Post as an example type of entity, an example of an attribute would be the
14			* title.
15			*
16			* Each attribute is represented by a child of this class.
17			*
18			* @since 1.0.0
19			*/
20			abstract class WordPoints_Entity_Attr
21			extends WordPoints_Entityish
22			implements WordPoints_Entity_ChildI {
23
24			/**
25			* The data type of the values of this attribute.
26			*
27			* @since 1.0.0
28			*
29			* @var string
30			*/
31			protected $data_type;
32
33			/**
34			* Get the value of this attribute from an entity.
35			*
36			* @since 1.0.0
37			*
38			* @param WordPoints_Entity $entity The entity.
39			*
40			* @return mixed The attribute value.
41			*/
42			abstract protected function get_attr_value_from_entity( WordPoints_Entity $entity );
43
44			/**
45			* Get the data type of this attribute's values.
46			*
47			* @since 1.0.0
48			*
49			* @return string The data type of this attribute's values.
50			*/
51			public function get_data_type() {
52			return $this->data_type;
53			}
54
55			/**
56			* Set the value of this attribute from an entity.
57			*
58			* This class can represent either a type of attribute generically (e.g., Post
59			* title) or a specific value of that attribute (the title of a specific Post).
60			* This method is used to set a specific value for the attribute this object
61			* should represent.
62			*
63			* @since 1.0.0
64			*
65			* @param WordPoints_Entity $entity An entity object.
66			*
67			* @return bool Whether the value was set correctly.
68			*/
69			public function set_the_value_from_entity( WordPoints_Entity $entity ) {
70
71			$this->the_value = $this->get_attr_value_from_entity( $entity );
72
73			return true;
74			}
75			}
76
77			// EOF
78

WordPoints / hooks-api

Push — master ( 226003...873ec4 )

WordPoints_Entity_Attr::get_field() A

Complexity

Size

Duplication

Duplication Side-by-Side

Filter issues like