ConversationHistory::find() - Code Metrics - Inspection of "Return text transcript" - LivePersonInc/LiveEngageLaravel - Measure and Improve Code Quality continuously with Scrutinizer

Passed

Branch — development (52f2c7)

by Robert

created 2018-07-03 17:42 UTC

ConversationHistory::find() A

↳ Parent: ConversationHistory

Complexity

Conditions	1
Paths	1

Size

Total Lines

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	2

Importance

Changes

Metric	Value
dl	0
loc	7
ccs	0
cts	4
cp	0
rs	10
c	0
b	0
f	0
cc	1
nc	1
nop	1
crap	2

<?php
/**
 * ConversationHistory
 *
 * @package LivePersonInc\LiveEngageLaravel\Collections
 */

namespace LivePersonInc\LiveEngageLaravel\Collections;

use Illuminate\Support\Collection;
use LivePersonInc\LiveEngageLaravel\Models\MetaData;
use LivePersonInc\LiveEngageLaravel\Models\Conversation;
use LivePersonInc\LiveEngageLaravel\Traits\Pageable;

/**
 * ConversationHistory class.
 * 
 * @extends Collection
 */
class ConversationHistory extends Collection
{
	use Pageable;

	
	/**
	 * metaData
	 * 
	 * @var \LivePersonInc\LiveEngageLaravel\Models\MetaData
	 * @access public
	 */
	public $metaData;
	
	/**
	 * historyFunction
	 * 
	 * Required for the Pageable trait (default value: 'retrieveMsgHistory')
	 * 
	 * @var string
	 * @access protected
	 */
	protected $historyFunction = 'retrieveMsgHistory';

	/**
	 * __construct function.
	 * 
	 * @access public
	 * @param array $models (default: [])
	 * @return void
	 */
	public function __construct($models = [])
	{
		$models = array_map(function($item) {
			return is_a($item, 'LivePersonInc\LiveEngageLaravel\Models\Conversation') ? $item : new Conversation((array) $item);
		}, $models ?: []);
		$this->metaData = new MetaData();
		parent::__construct($models);
	}
	
	/**
	 * find function.
	 * 
	 * @access public
	 * @param mixed $engagementID
	 * @return Conversation
	 */
	public function find($engagementID)
	{
		$result = $this->filter(function($value) use ($engagementID) {
			return $value->info->conversationId == $engagementID;
		});
		
		return $result->first();
	}
	
	/**
	 * merge function.
	 * 
	 * @access public
	 * @param mixed $collection
	 * @return ConversationHistory
	 */
	public function merge($collection) {
		
		$meta = $collection->metaData;
		$collection = parent::merge($collection);
		$this->metaData = $meta;
		$collection->metaData = $meta;
		
		return $collection;
		
	}
	
	public function toArray()
	{
		return $this->map(function($conversation) {
interface HasName {
    /** @return string */
    public function getName();
}

class Name {
    public $name;
}

class User implements HasName {
    /** @return string|Name */
    public function getName() {
        return new Name('foo'); // This is a violation of the ``HasName`` interface
                                // which only allows a string value to be returned.
    }
}
			return $conversation->export;
		});
	}
}


1		<?php
2		/**
3		* ConversationHistory
4		*
5		* @package LivePersonInc\LiveEngageLaravel\Collections
6		*/
7
8		namespace LivePersonInc\LiveEngageLaravel\Collections;
9
10		use Illuminate\Support\Collection;
11		use LivePersonInc\LiveEngageLaravel\Models\MetaData;
12		use LivePersonInc\LiveEngageLaravel\Models\Conversation;
13		use LivePersonInc\LiveEngageLaravel\Traits\Pageable;
14
15		/**
16		* ConversationHistory class.
17		*
18		* @extends Collection
19		*/
20		class ConversationHistory extends Collection
21		{
22		use Pageable;
		0 ignored issues – show introduced 2018-06-28 19:22 UTC by Report Bug Copy Issue Report The trait `LivePersonInc\LiveEngageLaravel\Traits\Pageable` requires some properties which are not provided by `LivePersonInc\LiveEngage...ons\ConversationHistory`: `$_metadata`, `$prev`, `$next`, `$records`, `$href` Loading history...
23
24		/**
25		* metaData
26		*
27		* @var \LivePersonInc\LiveEngageLaravel\Models\MetaData
28		* @access public
29		*/
30		public $metaData;
31
32		/**
33		* historyFunction
34		*
35		* Required for the Pageable trait (default value: 'retrieveMsgHistory')
36		*
37		* @var string
38		* @access protected
39		*/
40		protected $historyFunction = 'retrieveMsgHistory';
41
42		/**
43		* __construct function.
44		*
45		* @access public
46		* @param array $models (default: [])
47		* @return void
48		*/
49	1	public function __construct($models = [])
50		{
51		$models = array_map(function($item) {
52	1	return is_a($item, 'LivePersonInc\LiveEngageLaravel\Models\Conversation') ? $item : new Conversation((array) $item);
53	1	}, $models ?: []);
54	1	$this->metaData = new MetaData();
55	1	parent::__construct($models);
56	1	}
57
58		/**
59		* find function.
60		*
61		* @access public
62		* @param mixed $engagementID
63		* @return Conversation
64		*/
65		public function find($engagementID)
66		{
67		$result = $this->filter(function($value) use ($engagementID) {
68		return $value->info->conversationId == $engagementID;
69		});
70
71		return $result->first();
72		}
73
74		/**
75		* merge function.
76		*
77		* @access public
78		* @param mixed $collection
79		* @return ConversationHistory
80		*/
81		public function merge($collection) {
82
83		$meta = $collection->metaData;
84		$collection = parent::merge($collection);
85		$this->metaData = $meta;
86		$collection->metaData = $meta;
87
88		return $collection;
89
90		}
91
92		public function toArray()
93		{
94		return $this->map(function($conversation) {
		0 ignored issues – show Bug Best Practice introduced 2018-07-03 17:48 UTC by Report Bug Copy Issue Report The expression `return $this->map(function(...) { /* ... / })` returns the type `LivePersonInc\LiveEngage...ons\ConversationHistory` which is incompatible with the return type mandated by `Illuminate\Contracts\Support\Arrayable::toArray()` of `array`. In the issue above, the returned value is violating the contract defined by the mentioned interface. Let's take a look at an example: interface HasName { /* @return string / public function getName(); } class Name { public $name; } class User implements HasName { /* @return string\|Name */ public function getName() { return new Name('foo'); // This is a violation of the ``HasName`` interface // which only allows a string value to be returned. } } Loading history...
95		return $conversation->export;
96		});
97		}
98		}
99

LivePersonInc / LiveEngageLaravel

Branch — development (52f2c7)

ConversationHistory::find() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like