/
RepositoryInterface.php
211 lines (196 loc) · 6.95 KB
/
RepositoryInterface.php
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
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
<?php
/**
* CakePHP(tm) : Rapid Development Framework (http://cakephp.org)
* Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
*
* Licensed under The MIT License
* For full copyright and license information, please see the LICENSE.txt
* Redistributions of files must retain the above copyright notice.
*
* @copyright Copyright (c) Cake Software Foundation, Inc. (http://cakefoundation.org)
* @link http://cakephp.org CakePHP(tm) Project
* @since CakePHP(tm) v 3.0.0
* @license MIT License (http://www.opensource.org/licenses/mit-license.php)
*/
namespace Cake\Datasource;
use Cake\Datasource\EntityInterface;
/**
* Describes the methods that any class representing a data storage should
* comply with.
*/
interface RepositoryInterface {
/**
* Creates a new Query for this repository and applies some defaults based on the
* type of search that was selected.
*
* ### Model.beforeFind event
*
* Each find() will trigger a `Model.beforeFind` event for all attached
* listeners. Any listener can set a valid result set using $query
*
* @param string $type the type of query to perform
* @param array $options An array that will be passed to Query::applyOptions
* @return \Cake\ORM\Query
*/
public function find($type = 'all', $options = []);
/**
* Returns a single record after finding it by its primary key, if no record is
* found this method throws an exception.
*
* ###Example:
*
* {{{
* $id = 10;
* $article = $articles->get($id);
*
* $article = $articles->get($id, ['contain' => ['Comments]]);
* }}}
*
* @param mixed primary key value to find
* @param array $options options accepted by `Table::find()`
* @throws \Cake\ORM\Error\RecordNotFoundException if the record with such id
* could not be found
* @return \Cake\Datasource\EntityInterface
* @see RepositoryInterface::find()
*/
public function get($primaryKey, $options = []);
/**
* Creates a new Query instance for this repository
*
* @return \Cake\ORM\Query
*/
public function query();
/**
* Update all matching records.
*
* Sets the $fields to the provided values based on $conditions.
* This method will *not* trigger beforeSave/afterSave events. If you need those
* first load a collection of records and update them.
*
* @param array $fields A hash of field => new value.
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
*/
public function updateAll($fields, $conditions);
/**
* Delete all matching records.
*
* Deletes all records matching the provided conditions.
*
* This method will *not* trigger beforeDelete/afterDelete events. If you
* need those first load a collection of records and delete them.
*
* This method will *not* execute on associations `cascade` attribute. You should
* use database foreign keys + ON CASCADE rules if you need cascading deletes combined
* with this method.
*
* @param array $conditions An array of conditions, similar to those used with find()
* @return boolean Success Returns true if one or more rows are effected.
* @see RepositoryInterface::delete()
*/
public function deleteAll($conditions);
/**
* Returns true if there is any record in this repository matching the specified
* conditions.
*
* @param array $conditions list of conditions to pass to the query
* @return boolean
*/
public function exists(array $conditions);
/**
* Persists an entity based on the fields that are marked as dirty and
* returns the same entity after a successful save or false in case
* of any error.
*
* @param \Cake\Datasource\EntityInterface the entity to be saved
* @param array $options
* @return \Cake\Datasource\EntityInterface|boolean
*/
public function save(EntityInterface $entity, array $options = []);
/**
* Delete a single entity.
*
* Deletes an entity and possibly related associations from the database
* based on the 'dependent' option used when defining the association.
*
* @param \Cake\Datasource\EntityInterface $entity The entity to remove.
* @param array $options The options fo the delete.
* @return boolean success
*/
public function delete(EntityInterface $entity, array $options = []);
/**
* Create a new entity + associated entities from an array.
*
* This is most useful when hydrating request data back into entities.
* For example, in your controller code:
*
* {{{
* $article = $this->Articles->newEntity($this->request->data());
* }}}
*
* The hydrated entity will correctly do an insert/update based
* on the primary key data existing in the database when the entity
* is saved. Until the entity is saved, it will be a detached record.
*
* @param array $data The data to build an entity with.
* @param array $associations A whitelist of associations
* to hydrate. Defaults to all associations
* @return \Cake\Datasource\EntityInterface
*/
public function newEntity(array $data = [], $associations = null);
/**
* Create a list of entities + associated entities from an array.
*
* This is most useful when hydrating request data back into entities.
* For example, in your controller code:
*
* {{{
* $articles = $this->Articles->newEntities($this->request->data());
* }}}
*
* The hydrated entities can then be iterated and saved.
*
* @param array $data The data to build an entity with.
* @param array $associations A whitelist of associations
* to hydrate. Defaults to all associations
* @return array An array of hydrated records.
*/
public function newEntities(array $data, $associations = null);
/**
* Merges the passed `$data` into `$entity` respecting the accessible
* fields as configured for it. Returns the same entity after being
* altered.
*
* This is most useful when editing an existing entity using request data:
*
* {{{
* $article = $this->Articles->patchEntity($article, $this->request->data());
* }}}
*
* @param \Cake\Datasource\EntityInterface $entity the entity that will get the
* data merged in
* @param array $data key value list of fields to be merged into the entity
* @param array $include The list of associations to be merged
* @return \Cake\Datasource\EntityInterface
*/
public function patchEntity(EntityInterface $entity, array $data, $associations = null);
/**
* Merges the each for the elements passed in `$data` into each of the entities
* found in `$entities` respecting the accessible fields as configured for it.
* Merging is done by matching the primary key in each of the elements in `$data`
* and `$entities`.
*
* This is most useful when editing a list of existing entities using request data:
*
* {{{
* $article = $this->Articles->patchEntities($articles, $this->request->data());
* }}}
*
* @param array|\Traversable $entities the entities that will get the
* data merged in
* @param array $data list of arrays to be merged into the entities
* @param array $include The list of associations to be merged
* @return array
*/
public function patchEntities($entities, array $data, $associations = null);
}