grapevine-api-docs/source-class-FloatingPoint.Grapevine.Library.Database.RepositoryInterface.html at master · floatingpointsoftware/grapevine-api-docs · GitHub

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
<!DOCTYPE html>
<html>
<head>
	<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
	<meta name="generator" content="ApiGen 2.8.0" />
	<meta name="robots" content="noindex" />

	<title>File Library/Database/RepositoryInterface.php | Grapevine by Floating Point Software</title>

	<script type="text/javascript" src="resources/combined.js?657771206"></script>
	<script type="text/javascript" src="elementlist.js?1472664112"></script>
	<link rel="stylesheet" type="text/css" media="all" href="resources/style.css?3505392360" />

</head>

<body>
<div id="left">
	<div id="menu">
		<a href="index.html" title="Overview"><span>Overview</span></a>


		<div id="groups">
			<h3>Namespaces</h3>
			<ul>
				<li class="active"><a href="namespace-FloatingPoint.html">FloatingPoint<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Domain.html">Domain<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Domain.Forums.html">Forums<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Domain.Forums.Commands.html">Commands</a>
						</li>
				<li><a href="namespace-FloatingPoint.Domain.Forums.Handlers.html">Handlers</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="namespace-FloatingPoint.Grapevine.html">Grapevine<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Http.html">Http<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Http.Requests.html">Requests<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Http.Requests.Forums.html">Forums</a>
						</li>
							</ul></li></ul></li>
				<li class="active"><a href="namespace-FloatingPoint.Grapevine.Library.html">Library<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Library.Commands.html">Commands</a>
						</li>
				<li class="active"><a href="namespace-FloatingPoint.Grapevine.Library.Database.html">Database</a>
						</li>
				<li><a href="namespace-FloatingPoint.Grapevine.Library.Support.html">Support</a>
						</li>
							</ul></li>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.html">Modules<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.html">Forums<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Commands.html">Commands</a>
						</li>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Handlers.html">Handlers</a>
						</li>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Models.html">Models</a>
						</li>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Repositories.html">Repositories</a>
						</li>
				<li><a href="namespace-FloatingPoint.Grapevine.Modules.Forums.Services.html">Services</a>
						</li>
							</ul></li></ul></li></ul></li>
				<li><a href="namespace-FloatingPoint.Http.html">Http<span></span></a>
						<ul>
				<li><a href="namespace-FloatingPoint.Http.Controllers.html">Controllers</a>
						</li>
							</ul></li></ul></li>
				<li><a href="namespace-PHP.html">PHP</a>
						</li>
			</ul>
		</div>

		<hr />


		<div id="elements">
			<h3>Classes</h3>
			<ul>
				<li><a href="class-FloatingPoint.Grapevine.Library.Database.EloquentRepository.html">EloquentRepository</a></li>
			</ul>

			<h3>Interfaces</h3>
			<ul>
				<li class="active"><a href="class-FloatingPoint.Grapevine.Library.Database.RepositoryInterface.html">RepositoryInterface</a></li>
			</ul>


		</div>
	</div>
</div>

<div id="splitter"></div>

<div id="right">
<div id="rightInner">
	<form id="search">
		<input type="hidden" name="cx" value="" />
		<input type="hidden" name="ie" value="UTF-8" />
		<input type="text" name="q" class="text" />
		<input type="submit" value="Search" />
	</form>

	<div id="navigation">
		<ul>
			<li>
				<a href="index.html" title="Overview"><span>Overview</span></a>
			</li>
			<li>
				<a href="namespace-FloatingPoint.Grapevine.Library.Database.html" title="Summary of FloatingPoint\Grapevine\Library\Database"><span>Namespace</span></a>
			</li>
			<li>
				<a href="class-FloatingPoint.Grapevine.Library.Database.RepositoryInterface.html" title="Summary of FloatingPoint\Grapevine\Library\Database\RepositoryInterface"><span>Class</span></a>
			</li>
		</ul>
		<ul>
			<li>
				<a href="tree.html" title="Tree view of classes, interfaces, traits and exceptions"><span>Tree</span></a>
			</li>
		</ul>
		<ul>
		</ul>
	</div>

<pre><code><span id="1" class="l"><a class="l" href="#1"> 1: </a><span class="xlang">&lt;?php</span>
</span><span id="2" class="l"><a class="l" href="#2"> 2: </a>
</span><span id="3" class="l"><a class="l" href="#3"> 3: </a><span class="php-keyword1">namespace</span> FloatingPoint\Grapevine\Library\Database;
</span><span id="4" class="l"><a class="l" href="#4"> 4: </a>
</span><span id="5" class="l"><a class="l" href="#5"> 5: </a><span class="php-keyword1">interface</span> <a id="RepositoryInterface" href="#RepositoryInterface">RepositoryInterface</a>
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a>{
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>    <span class="php-comment">/**
</span></span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">     * Create a resource based on the data provided.
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment">     *
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment">     * @param array $data Optional
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment">     * @return Resource
</span></span><span id="12" class="l"><a class="l" href="#12">12: </a><span class="php-comment">     */</span>
</span><span id="13" class="l"><a class="l" href="#13">13: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getNew" href="#_getNew">getNew</a>(<span class="php-keyword1">array</span> <span class="php-var">$data</span> = []);
</span><span id="14" class="l"><a class="l" href="#14">14: </a>
</span><span id="15" class="l"><a class="l" href="#15">15: </a>    <span class="php-comment">/**
</span></span><span id="16" class="l"><a class="l" href="#16">16: </a><span class="php-comment">     * Delete a specific resource. Returns the resource that was deleted.
</span></span><span id="17" class="l"><a class="l" href="#17">17: </a><span class="php-comment">     *
</span></span><span id="18" class="l"><a class="l" href="#18">18: </a><span class="php-comment">     * @param object  $resource
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment">     * @param boolean $permanent
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment">     * @return Resource
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment">     */</span>
</span><span id="22" class="l"><a class="l" href="#22">22: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <span class="php-keyword2">delete</span>(<span class="php-var">$resource</span>, <span class="php-var">$permanent</span> = <span class="php-keyword1">false</span>);
</span><span id="23" class="l"><a class="l" href="#23">23: </a>
</span><span id="24" class="l"><a class="l" href="#24">24: </a>    <span class="php-comment">/**
</span></span><span id="25" class="l"><a class="l" href="#25">25: </a><span class="php-comment">     * Get a specific resource.
</span></span><span id="26" class="l"><a class="l" href="#26">26: </a><span class="php-comment">     *
</span></span><span id="27" class="l"><a class="l" href="#27">27: </a><span class="php-comment">     * @param integer $id
</span></span><span id="28" class="l"><a class="l" href="#28">28: </a><span class="php-comment">     * @return Resource
</span></span><span id="29" class="l"><a class="l" href="#29">29: </a><span class="php-comment">     */</span>
</span><span id="30" class="l"><a class="l" href="#30">30: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getById" href="#_getById">getById</a>(<span class="php-var">$id</span>);
</span><span id="31" class="l"><a class="l" href="#31">31: </a>
</span><span id="32" class="l"><a class="l" href="#32">32: </a>    <span class="php-comment">/**
</span></span><span id="33" class="l"><a class="l" href="#33">33: </a><span class="php-comment">     * Acts as a generic method for retrieving a record by a given field/value pair.
</span></span><span id="34" class="l"><a class="l" href="#34">34: </a><span class="php-comment">     *
</span></span><span id="35" class="l"><a class="l" href="#35">35: </a><span class="php-comment">     * @param $field
</span></span><span id="36" class="l"><a class="l" href="#36">36: </a><span class="php-comment">     * @param $value
</span></span><span id="37" class="l"><a class="l" href="#37">37: </a><span class="php-comment">     * @return mixed
</span></span><span id="38" class="l"><a class="l" href="#38">38: </a><span class="php-comment">     */</span>
</span><span id="39" class="l"><a class="l" href="#39">39: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getBy" href="#_getBy">getBy</a>(<span class="php-var">$field</span>, <span class="php-var">$value</span>);
</span><span id="40" class="l"><a class="l" href="#40">40: </a>
</span><span id="41" class="l"><a class="l" href="#41">41: </a>    <span class="php-comment">/**
</span></span><span id="42" class="l"><a class="l" href="#42">42: </a><span class="php-comment">     * Similar to getById, but should raise an EntityNotFoundException.
</span></span><span id="43" class="l"><a class="l" href="#43">43: </a><span class="php-comment">     *
</span></span><span id="44" class="l"><a class="l" href="#44">44: </a><span class="php-comment">     * @param $id
</span></span><span id="45" class="l"><a class="l" href="#45">45: </a><span class="php-comment">     * @return mixed
</span></span><span id="46" class="l"><a class="l" href="#46">46: </a><span class="php-comment">     */</span>
</span><span id="47" class="l"><a class="l" href="#47">47: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_requireById" href="#_requireById">requireById</a>(<span class="php-var">$id</span>);
</span><span id="48" class="l"><a class="l" href="#48">48: </a>
</span><span id="49" class="l"><a class="l" href="#49">49: </a>    <span class="php-comment">/**
</span></span><span id="50" class="l"><a class="l" href="#50">50: </a><span class="php-comment">     * @param       $resource
</span></span><span id="51" class="l"><a class="l" href="#51">51: </a><span class="php-comment">     * @param array $data
</span></span><span id="52" class="l"><a class="l" href="#52">52: </a><span class="php-comment">     * @return Resource
</span></span><span id="53" class="l"><a class="l" href="#53">53: </a><span class="php-comment">     */</span>
</span><span id="54" class="l"><a class="l" href="#54">54: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_update" href="#_update">update</a>(<span class="php-var">$resource</span>, <span class="php-var">$data</span> = []);
</span><span id="55" class="l"><a class="l" href="#55">55: </a>
</span><span id="56" class="l"><a class="l" href="#56">56: </a>    <span class="php-comment">/**
</span></span><span id="57" class="l"><a class="l" href="#57">57: </a><span class="php-comment">     * Saves the provided resource.
</span></span><span id="58" class="l"><a class="l" href="#58">58: </a><span class="php-comment">     *
</span></span><span id="59" class="l"><a class="l" href="#59">59: </a><span class="php-comment">     * @param $resource
</span></span><span id="60" class="l"><a class="l" href="#60">60: </a><span class="php-comment">     * @return mixed
</span></span><span id="61" class="l"><a class="l" href="#61">61: </a><span class="php-comment">     */</span>
</span><span id="62" class="l"><a class="l" href="#62">62: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_save" href="#_save">save</a>(<span class="php-var">$resource</span>);
</span><span id="63" class="l"><a class="l" href="#63">63: </a>
</span><span id="64" class="l"><a class="l" href="#64">64: </a>    <span class="php-comment">/**
</span></span><span id="65" class="l"><a class="l" href="#65">65: </a><span class="php-comment">     * Save 1-n resources.
</span></span><span id="66" class="l"><a class="l" href="#66">66: </a><span class="php-comment">     *
</span></span><span id="67" class="l"><a class="l" href="#67">67: </a><span class="php-comment">     * @param $resources
</span></span><span id="68" class="l"><a class="l" href="#68">68: </a><span class="php-comment">     * @return mixed
</span></span><span id="69" class="l"><a class="l" href="#69">69: </a><span class="php-comment">     */</span>
</span><span id="70" class="l"><a class="l" href="#70">70: </a>    <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_saveAll" href="#_saveAll">saveAll</a>();
</span><span id="71" class="l"><a class="l" href="#71">71: </a>}
</span><span id="72" class="l"><a class="l" href="#72">72: </a></span></code></pre>

	<div id="footer">
		Grapevine by Floating Point Software API documentation generated by <a href="http://apigen.org">ApiGen 2.8.0</a>
	</div>
</div>
</div>
</body>
</html>