blob: 35fb6fb0668667fe93216a7cb237e514e06b134a (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
|
<?php
/*
+--------------------------------------------------------------------+
| CiviCRM version 4.7 |
+--------------------------------------------------------------------+
| Copyright CiviCRM LLC (c) 2004-2015 |
+--------------------------------------------------------------------+
| This file is a part of CiviCRM. |
| |
| CiviCRM is free software; you can copy, modify, and distribute it |
| under the terms of the GNU Affero General Public License |
| Version 3, 19 November 2007 and the CiviCRM Licensing Exception. |
| |
| CiviCRM 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 Affero General Public License for more details. |
| |
| You should have received a copy of the GNU Affero General Public |
| License and the CiviCRM Licensing Exception along |
| with this program; if not, contact CiviCRM LLC |
| at info[AT]civicrm[DOT]org. If you have questions about the |
| GNU Affero General Public License or the licensing of CiviCRM, |
| see the CiviCRM license FAQ at http://civicrm.org/licensing |
+--------------------------------------------------------------------+
*/
namespace Civi\Api4\Generic;
/**
* Container for api results.
*/
class Result extends \ArrayObject {
/**
* @var string
*/
public $entity;
/**
* @var string
*/
public $action;
/**
* Api version
* @var int
*/
public $version = 4;
/**
* Return first result.
* @return array|null
*/
public function first() {
foreach ($this as $values) {
return $values;
}
return NULL;
}
/**
* Return last result.
* @return array|null
*/
public function last() {
$items = $this->getArrayCopy();
return array_pop($items);
}
/**
* @param int $index
* @return array|null
*/
public function itemAt($index) {
$length = $index < 0 ? 0 - $index : $index + 1;
if ($length > count($this)) {
return NULL;
}
return array_slice(array_values($this->getArrayCopy()), $index, 1)[0];
}
/**
* Re-index the results array (which by default is non-associative)
*
* Drops any item from the results that does not contain the specified key
*
* @param string $key
* @return $this
* @throws \API_Exception
*/
public function indexBy($key) {
if (count($this)) {
$newResults = [];
foreach ($this as $values) {
if (isset($values[$key])) {
$newResults[$values[$key]] = $values;
}
}
if (!$newResults) {
throw new \API_Exception("Key $key not found in api results");
}
$this->exchangeArray($newResults);
}
return $this;
}
}
|
