-
Notifications
You must be signed in to change notification settings - Fork 1
/
source-class-FloatingPoint.Grapevine.Modules.Forums.Services.ForumService.html
180 lines (161 loc) · 9.66 KB
/
source-class-FloatingPoint.Grapevine.Modules.Forums.Services.ForumService.html
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
<!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 Modules/Forums/Services/ForumService.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><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><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 class="active"><a href="namespace-FloatingPoint.Grapevine.Modules.html">Modules<span></span></a>
<ul>
<li class="active"><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 class="active"><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 class="active"><a href="class-FloatingPoint.Grapevine.Modules.Forums.Services.ForumService.html">ForumService</a></li>
<li><a href="class-FloatingPoint.Grapevine.Modules.Forums.Services.TopicService.html">TopicService</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.Modules.Forums.Services.html" title="Summary of FloatingPoint\Grapevine\Modules\Forums\Services"><span>Namespace</span></a>
</li>
<li>
<a href="class-FloatingPoint.Grapevine.Modules.Forums.Services.ForumService.html" title="Summary of FloatingPoint\Grapevine\Modules\Forums\Services\ForumService"><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"><?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\Modules\Forums\Services;
</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">use</span> Event;
</span><span id="6" class="l"><a class="l" href="#6"> 6: </a><span class="php-keyword1">use</span> FloatingPoint\Grapevine\Modules\Forums\Commands\CreateForum;
</span><span id="7" class="l"><a class="l" href="#7"> 7: </a>
</span><span id="8" class="l"><a class="l" href="#8"> 8: </a><span class="php-comment">/**
</span></span><span id="9" class="l"><a class="l" href="#9"> 9: </a><span class="php-comment"> * Class ForumService
</span></span><span id="10" class="l"><a class="l" href="#10">10: </a><span class="php-comment"> * Manages the functionality specific to actions relating to forums. CRUD operations,
</span></span><span id="11" class="l"><a class="l" href="#11">11: </a><span class="php-comment"> * as well as moving, archiving, deletions, subscriptions.etc.
</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-comment"> * @package FloatingPoint\Grapevine\Modules\Forums\Services
</span></span><span id="14" class="l"><a class="l" href="#14">14: </a><span class="php-comment"> */</span>
</span><span id="15" class="l"><a class="l" href="#15">15: </a><span class="php-keyword1">class</span> <a id="ForumService" href="#ForumService">ForumService</a>
</span><span id="16" class="l"><a class="l" href="#16">16: </a>{
</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"> * Execute the create forum command and return the response.
</span></span><span id="19" class="l"><a class="l" href="#19">19: </a><span class="php-comment"> *
</span></span><span id="20" class="l"><a class="l" href="#20">20: </a><span class="php-comment"> * @param array $input
</span></span><span id="21" class="l"><a class="l" href="#21">21: </a><span class="php-comment"> * @return mixed
</span></span><span id="22" class="l"><a class="l" href="#22">22: </a><span class="php-comment"> */</span>
</span><span id="23" class="l"><a class="l" href="#23">23: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_createForum" href="#_createForum">createForum</a>(<span class="php-keyword1">array</span> <span class="php-var">$input</span> = [])
</span><span id="24" class="l"><a class="l" href="#24">24: </a> {
</span><span id="25" class="l"><a class="l" href="#25">25: </a> <span class="php-keyword1">return</span> <span class="php-var">$this</span>->execute(CreateForum::fromInput(<span class="php-var">$input</span>));
</span><span id="26" class="l"><a class="l" href="#26">26: </a> }
</span><span id="27" class="l"><a class="l" href="#27">27: </a>
</span><span id="28" class="l"><a class="l" href="#28">28: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_updateForum" href="#_updateForum">updateForum</a>(<span class="php-keyword1">array</span> <span class="php-var">$input</span> = [])
</span><span id="29" class="l"><a class="l" href="#29">29: </a> {
</span><span id="30" class="l"><a class="l" href="#30">30: </a> }
</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-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_deleteForum" href="#_deleteForum">deleteForum</a>(<span class="php-var">$forumId</span>)
</span><span id="33" class="l"><a class="l" href="#33">33: </a> {
</span><span id="34" class="l"><a class="l" href="#34">34: </a> }
</span><span id="35" class="l"><a class="l" href="#35">35: </a>
</span><span id="36" class="l"><a class="l" href="#36">36: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getForum" href="#_getForum">getForum</a>(<span class="php-var">$forumId</span>)
</span><span id="37" class="l"><a class="l" href="#37">37: </a> {
</span><span id="38" class="l"><a class="l" href="#38">38: </a> }
</span><span id="39" class="l"><a class="l" href="#39">39: </a>
</span><span id="40" class="l"><a class="l" href="#40">40: </a> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> <a id="_getForumList" href="#_getForumList">getForumList</a>(<span class="php-keyword1">array</span> <span class="php-var">$params</span> = [])
</span><span id="41" class="l"><a class="l" href="#41">41: </a> {
</span><span id="42" class="l"><a class="l" href="#42">42: </a> }
</span><span id="43" class="l"><a class="l" href="#43">43: </a>}
</span><span id="44" class="l"><a class="l" href="#44">44: </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>