Comment::content() - Code Metrics - anrw/classy - Measure and Improve Code Quality continuously with Scrutinizer

Comment::content() A
last analyzed 2016-08-22 10:54 UTC

↳ Parent: Comment

Complexity

Conditions	1
Paths	1

Size

Total Lines	3
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	3
Bugs	0	Features	1

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

<?php
/**
 * Wrapper and helper for WP_Comment class.
 *
 * @package Classy
 */

namespace Classy;

/**
 * Class Comment.
 */
class Comment extends Basis {

	/**
	 * Comment ID.
	 *
	 * @var int
	 */
	public $comment_ID;

	/**
	 * Comment post ID.
	 *
	 * @var int
	 */
	public $comment_post_ID;

	/**
	 * Comment Author name.
	 *
	 * @var string
	 */
	public $comment_author;

	/**
	 * Comment author email.
	 *
	 * @var string
	 */
	public $comment_author_email;

	/**
	 * Comment author link.
	 *
	 * @var string
	 */
	public $comment_author_url;

	/**
	 * Comment.
	 *
	 * @var string
	 */
	public $comment_content;

	/**
	 * Comment approved.
	 *
	 * @var boolean
	 */
	public $comment_approved;

	/**
	 * Comment date.
	 *
	 * @var string
	 */
	public $comment_date;

	/**
	 * User ID.
	 *
	 * @var int
	 */
	public $user_id;

	/**
	 * Comment nested level.
	 *
	 * @var int
	 */
	public $level;

	/**
	 * Comment Parent ID.
	 *
	 * @var int
	 */
	public $comment_parent;

	/**
	 * Child comments.
	 *
	 * @var array
	 */
	protected $children = array();

	/**
	 * Checks if provided arg is instance of WP_Comment and init it.
	 *
	 * @param \WP_Comment $item WP_Comment object.
	 */
	public function __construct( $item ) {
		if ( is_a( $item, '\WP_Comment' ) ) {
			$this->import( $item );
		}
	}

	/**
	 * Returns User object of comment author.
	 *
	 * @return \Classy\Models\User
	 */
	public function author() {
		if ( ! $this->user_id ) {

			$author = new Models\User( 0 );

			if ( isset( $this->comment_author ) && $this->comment_author ) {
				$author->name = $this->comment_author;
			}

			return $author;
		}

		return new Models\User( $this->user_id );
	}

	/**
	 * Returns comment content.
	 *
	 * @return string
	 */
	public function content() {
		return apply_filters( 'get_comment_text ', $this->comment_content );
	}

	/**
	 * Return true if comment is approved.
	 *
	 * @return boolean
	 */
	public function approved() {
		return $this->comment_approved;
	}

	/**
	 * Returns comment date.
	 *
	 * @param string $date_format Optional. PHP date format defaults to the date_format option if not specified.
	 *
	 * @return string
	 */
	public function date( $date_format = '' ) {
		$df = $date_format ? $date_format : get_option( 'date_format' );
		$the_date = (string) mysql2date( $df, $this->comment_date );

		return apply_filters( 'get_comment_date ', $the_date, $df );
	}

	/**
	 * Returns true if comment has parent.
	 *
	 * @return boolean
	 */
	public function has_parent() {
		return $this->comment_parent > 0;
	}

	/**
	 * Shows gravatar.
	 *
	 * @param integer $size    avatar image size
	 * @param string  $default
	 *
	 * @return string
	 */
	public function avatar( $size = 92, $default = '' ) {
		if ( ! get_option( 'show_avatars' ) ) {
			return false;
		}

		if ( ! is_numeric( $size ) ) { $size = '92'; }

		$email = $this->get_avatar_email();
		$email_hash = '';

		if ( ! empty( $email ) ) {
			$email_hash = md5( strtolower( trim( $email ) ) );
		}

		$host = $this->get_avatar_host( $email_hash );
		$default = $this->get_default_avatar( $default, $email, $size, $host );

		if ( ! empty( $email ) ) {
			$avatar = $this->get_avatar_url( $default, $host, $email_hash, $size );
		} else {
			$avatar = $default;
		}

		return $avatar;
	}

	/**
	 * Returns email address that will be used for generating avatar.
	 *
	 * @return string
	 */
	protected function get_avatar_email() {
		$id = (int) $this->user_id;
		$user = get_userdata( $id );

		if ( $user ) {
			$email = $user->user_email;
		} else {
			$email = $this->comment_author_email;
		}

		return $email;
	}

	/**
	 * Returns default avatar url.
	 *
	 * @param  string $default
	 * @param  string $email
	 * @param  int $size
	 * @param  string $host
	 * @return string
	 */
	protected function get_default_avatar( $default, $email, $size, $host ) {
		if ( '/' === substr( $default, 0, 1 ) ) {
			$default = home_url() . $default;
		}

		if ( empty( $default ) ) {
			$avatar_default = get_option( 'avatar_default' );
			if ( empty( $avatar_default ) ) {
				$default = 'mystery';
			} else {
				$default = $avatar_default;
			}
		}

		if ( 'mystery' === $default ) {
			$default = $host . '/avatar/ad516503a11cd5ca435acc9bb6523536?s=' . $size;
			// ad516503a11cd5ca435acc9bb6523536 == md5('[email protected]')
		} else if ( 'blank' === $default ) {
			$default = $email ? 'blank' : includes_url( 'images/blank.gif' );
		} else if ( ! empty( $email ) && 'gravatar_default' === $default ) {
			$default = '';
		} else if ( 'gravatar_default' === $default ) {
			$default = $host . '/avatar/?s=' . $size;
		} else if ( empty( $email ) && ! strstr( $default, 'http://' ) ) {
			$default = $host . '/avatar/?d=' . $default . '&amp;s=' . $size;
		}

		return $default;
	}

	/**
	 * Returns gravatar host.
	 *
	 * @param  string $email_hash
	 * @return string
	 */
	protected function get_avatar_host( $email_hash ) {

		if ( is_ssl() ) {
			$host = 'https://secure.gravatar.com';
		} else {
			if ( ! empty( $email_hash ) ) {
				$host = sprintf( 'http://%d.gravatar.com', (hexdec( $email_hash[0] ) % 2) );
			} else {
				$host = 'http://0.gravatar.com';
			}
		}

		return $host;
	}

	/**
	 * Returns avatar url
	 *
	 * @param  string $default
	 * @param  string $host
	 * @param  string $email_hash
	 * @param  int $size
	 * @return string
	 */
	protected function get_avatar_url( $default, $host, $email_hash, $size ) {
		$_return = $host . '/avatar/' . $email_hash . '?s=' . $size . '&amp;d=' . urlencode( $default );
		$rating = get_option( 'avatar_rating' );

		if ( ! empty( $rating ) ) {
			$_return .= '&amp;r=' . $rating;
		}

		return str_replace( '&#038;', '&amp;', esc_url( $_return ) );
	}

	/**
	 * Adds child to current Comment
	 *
	 * @param Comment $comment
	 */
	public function add_child( $comment ) {
		$this->children[] = $comment;
		$item->level = $this->level + 1;


		if ( $item->children ) {
			$this->update_child_levels();
		}
	}

	/**
	 * Updates children nesting level param
	 *
	 * @return boolean
	 */
	protected function update_child_levels() {

		if ( is_array( $this->children ) ) {
			foreach ( $this->children as $child ) {
				$child->level = $this->level + 1;
				$child->update_child_levels();
			}

			return true;
		}

		return false;
	}
}


1		<?php
2		/**
3		* Wrapper and helper for WP_Comment class.
4		*
5		* @package Classy
6		*/
7
8		namespace Classy;
9
10		/**
11		* Class Comment.
12		*/
13		class Comment extends Basis {
14
15		/**
16		* Comment ID.
17		*
18		* @var int
19		*/
20		public $comment_ID;
21
22		/**
23		* Comment post ID.
24		*
25		* @var int
26		*/
27		public $comment_post_ID;
28
29		/**
30		* Comment Author name.
31		*
32		* @var string
33		*/
34		public $comment_author;
35
36		/**
37		* Comment author email.
38		*
39		* @var string
40		*/
41		public $comment_author_email;
42
43		/**
44		* Comment author link.
45		*
46		* @var string
47		*/
48		public $comment_author_url;
49
50		/**
51		* Comment.
52		*
53		* @var string
54		*/
55		public $comment_content;
56
57		/**
58		* Comment approved.
59		*
60		* @var boolean
61		*/
62		public $comment_approved;
63
64		/**
65		* Comment date.
66		*
67		* @var string
68		*/
69		public $comment_date;
70
71		/**
72		* User ID.
73		*
74		* @var int
75		*/
76		public $user_id;
77
78		/**
79		* Comment nested level.
80		*
81		* @var int
82		*/
83		public $level;
84
85		/**
86		* Comment Parent ID.
87		*
88		* @var int
89		*/
90		public $comment_parent;
91
92		/**
93		* Child comments.
94		*
95		* @var array
96		*/
97		protected $children = array();
98
99		/**
100		* Checks if provided arg is instance of WP_Comment and init it.
101		*
102		* @param \WP_Comment $item WP_Comment object.
103		*/
104		public function __construct( $item ) {
105		if ( is_a( $item, '\WP_Comment' ) ) {
106		$this->import( $item );
107		}
108		}
109
110		/**
111		* Returns User object of comment author.
112		*
113		* @return \Classy\Models\User
114		*/
115		public function author() {
116		if ( ! $this->user_id ) {
117
118		$author = new Models\User( 0 );
119
120		if ( isset( $this->comment_author ) && $this->comment_author ) {
121		$author->name = $this->comment_author;
122		}
123
124		return $author;
125		}
126
127		return new Models\User( $this->user_id );
128		}
129
130		/**
131		* Returns comment content.
132		*
133		* @return string
134		*/
135		public function content() {
136		return apply_filters( 'get_comment_text ', $this->comment_content );
137		}
138
139		/**
140		* Return true if comment is approved.
141		*
142		* @return boolean
143		*/
144		public function approved() {
145		return $this->comment_approved;
146		}
147
148		/**
149		* Returns comment date.
150		*
151		* @param string $date_format Optional. PHP date format defaults to the date_format option if not specified.
152		*
153		* @return string
154		*/
155		public function date( $date_format = '' ) {
156		$df = $date_format ? $date_format : get_option( 'date_format' );
157		$the_date = (string) mysql2date( $df, $this->comment_date );
158
159		return apply_filters( 'get_comment_date ', $the_date, $df );
160		}
161
162		/**
163		* Returns true if comment has parent.
164		*
165		* @return boolean
166		*/
167		public function has_parent() {
168		return $this->comment_parent > 0;
169		}
170
171		/**
172		* Shows gravatar.
173		*
174		* @param integer $size avatar image size
175		* @param string $default
176		*
177		* @return string
178		*/
179		public function avatar( $size = 92, $default = '' ) {
180		if ( ! get_option( 'show_avatars' ) ) {
181		return false;
182		}
183
184		if ( ! is_numeric( $size ) ) { $size = '92'; }
185
186		$email = $this->get_avatar_email();
187		$email_hash = '';
188
189		if ( ! empty( $email ) ) {
190		$email_hash = md5( strtolower( trim( $email ) ) );
191		}
192
193		$host = $this->get_avatar_host( $email_hash );
194		$default = $this->get_default_avatar( $default, $email, $size, $host );
195
196		if ( ! empty( $email ) ) {
197		$avatar = $this->get_avatar_url( $default, $host, $email_hash, $size );
198		} else {
199		$avatar = $default;
200		}
201
202		return $avatar;
203		}
204
205		/**
206		* Returns email address that will be used for generating avatar.
207		*
208		* @return string
209		*/
210		protected function get_avatar_email() {
211		$id = (int) $this->user_id;
212		$user = get_userdata( $id );
213
214		if ( $user ) {
215		$email = $user->user_email;
216		} else {
217		$email = $this->comment_author_email;
218		}
219
220		return $email;
221		}
222
223		/**
224		* Returns default avatar url.
225		*
226		* @param string $default
227		* @param string $email
228		* @param int $size
229		* @param string $host
230		* @return string
231		*/
232		protected function get_default_avatar( $default, $email, $size, $host ) {
233		if ( '/' === substr( $default, 0, 1 ) ) {
234		$default = home_url() . $default;
235		}
236
237		if ( empty( $default ) ) {
238		$avatar_default = get_option( 'avatar_default' );
239		if ( empty( $avatar_default ) ) {
240		$default = 'mystery';
241		} else {
242		$default = $avatar_default;
243		}
244		}
245
246		if ( 'mystery' === $default ) {
247		$default = $host . '/avatar/ad516503a11cd5ca435acc9bb6523536?s=' . $size;
248		// ad516503a11cd5ca435acc9bb6523536 == md5('[email protected]')
249		} else if ( 'blank' === $default ) {
250		$default = $email ? 'blank' : includes_url( 'images/blank.gif' );
251		} else if ( ! empty( $email ) && 'gravatar_default' === $default ) {
252		$default = '';
253		} else if ( 'gravatar_default' === $default ) {
254		$default = $host . '/avatar/?s=' . $size;
255		} else if ( empty( $email ) && ! strstr( $default, 'http://' ) ) {
256		$default = $host . '/avatar/?d=' . $default . '&s=' . $size;
257		}
258
259		return $default;
260		}
261
262		/**
263		* Returns gravatar host.
264		*
265		* @param string $email_hash
266		* @return string
267		*/
268		protected function get_avatar_host( $email_hash ) {
269
270		if ( is_ssl() ) {
271		$host = 'https://secure.gravatar.com';
272		} else {
273		if ( ! empty( $email_hash ) ) {
274		$host = sprintf( 'http://%d.gravatar.com', (hexdec( $email_hash[0] ) % 2) );
275		} else {
276		$host = 'http://0.gravatar.com';
277		}
278		}
279
280		return $host;
281		}
282
283		/**
284		* Returns avatar url
285		*
286		* @param string $default
287		* @param string $host
288		* @param string $email_hash
289		* @param int $size
290		* @return string
291		*/
292		protected function get_avatar_url( $default, $host, $email_hash, $size ) {
293		$_return = $host . '/avatar/' . $email_hash . '?s=' . $size . '&d=' . urlencode( $default );
294		$rating = get_option( 'avatar_rating' );
295
296		if ( ! empty( $rating ) ) {
297		$_return .= '&r=' . $rating;
298		}
299
300		return str_replace( '&', '&', esc_url( $_return ) );
301		}
302
303		/**
304		* Adds child to current Comment
305		*
306		* @param Comment $comment
307		*/
308		public function add_child( $comment ) {
309		$this->children[] = $comment;
310		$item->level = $this->level + 1;
		0 ignored issues – show Bug introduced 2016-06-27 09:33 UTC by Report Bug Copy Issue Report The variable `$item` does not exist. Did you forget to declare it? This check marks access to variables or properties that have not been declared yet. While PHP has no explicit notion of declaring a variable, accessing it before a value is assigned to it is most likely a bug. Loading history...
311
312		if ( $item->children ) {
313		$this->update_child_levels();
314		}
315		}
316
317		/**
318		* Updates children nesting level param
319		*
320		* @return boolean
321		*/
322	View Code Duplication	protected function update_child_levels() {
		0 ignored issues – show Duplication introduced 2016-05-13 12:23 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...
323		if ( is_array( $this->children ) ) {
324		foreach ( $this->children as $child ) {
325		$child->level = $this->level + 1;
326		$child->update_child_levels();
327		}
328
329		return true;
330		}
331
332		return false;
333		}
334		}
335

anrw / classy

Comment::content() A last analyzed 2016-08-22 10:54 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

Comment::content() A
last analyzed 2016-08-22 10:54 UTC