Skip to content

Commit 16abe2b

Browse files
MarwanAlsoltanyMarwanAlsoltany
committed
Rebuild documentation
1 parent 93245e5 commit 16abe2b

File tree

157 files changed

+9076
-620
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

157 files changed

+9076
-620
lines changed

‎docs/classes.html

+82
Original file line numberDiff line numberDiff line change
@@ -135,6 +135,14 @@ <h2 id="MAKS_AmqpAgent_Config">\MAKS\AmqpAgent\Config</h2>
135135
<td class="testresult-EMPTY">EMPTY
136136
</td>
137137
</tr>
138+
<tr>
139+
<td>
140+
<a href="classes/MAKS_AmqpAgent_Config_RPCEndpointParameters.html">RPCEndpointParameters</a>
141+
</td>
142+
<td>A subset of AmqpAgentParameters class for RPC Endpoints class.</td>
143+
<td class="testresult-EMPTY">EMPTY
144+
</td>
145+
</tr>
138146
</tbody>
139147
</table>
140148
</div>
@@ -196,6 +204,14 @@ <h2 id="MAKS_AmqpAgent_Exception">\MAKS\AmqpAgent\Exception</h2>
196204
<td class="testresult-EMPTY">EMPTY
197205
</td>
198206
</tr>
207+
<tr>
208+
<td>
209+
<a href="classes/MAKS_AmqpAgent_Exception_RPCEndpointException.html">RPCEndpointException</a>
210+
</td>
211+
<td>Endpoint violation exception.</td>
212+
<td class="testresult-EMPTY">EMPTY
213+
</td>
214+
</tr>
199215
<tr>
200216
<td>
201217
<a href="classes/MAKS_AmqpAgent_Exception_SerializerViolationException.html">SerializerViolationException</a>
@@ -226,13 +242,44 @@ <h2 id="MAKS_AmqpAgent_Helper">\MAKS\AmqpAgent\Helper</h2>
226242
</tr>
227243
</thead>
228244
<tbody>
245+
<tr>
246+
<td>
247+
<a href="classes/MAKS_AmqpAgent_Helper_ArrayProxy.html">ArrayProxy</a>
248+
</td>
249+
<td>A class containing methods for for manipulating and working arrays.</td>
250+
<td class="testresult-EMPTY">EMPTY
251+
</td>
252+
</tr>
253+
<tr>
254+
<td>
255+
<a href="classes/MAKS_AmqpAgent_Helper_ClassProxy.html">ClassProxy</a>
256+
</td>
257+
<td>A class containing methods for proxy methods calling, properties manipulation, and class utilities.</td>
258+
<td class="testresult-EMPTY">EMPTY
259+
</td>
260+
</tr>
261+
<tr>
262+
<td>
263+
<a href="classes/MAKS_AmqpAgent_Helper_Event.html">Event</a>
264+
</td>
265+
<td>A simple class for handling events (dispatching and listening).</td>
266+
<td class="testresult-EMPTY">EMPTY
267+
</td>
268+
</tr>
229269
<tr>
230270
<td>
231271
<a href="classes/MAKS_AmqpAgent_Helper_Example.html">Example</a>
232272
</td>
233273
<td>An abstract class used as a default callback for the consumer.</td>
234274
<td class="testresult-PASSED">PASSED</td>
235275
</tr>
276+
<tr>
277+
<td>
278+
<a href="classes/MAKS_AmqpAgent_Helper_IDGenerator.html">IDGenerator</a>
279+
</td>
280+
<td>A class containing functions for generating unique IDs and Tokens.</td>
281+
<td class="testresult-PASSED">PASSED</td>
282+
</tr>
236283
<tr>
237284
<td>
238285
<a href="classes/MAKS_AmqpAgent_Helper_Logger.html">Logger</a>
@@ -264,6 +311,41 @@ <h2 id="MAKS_AmqpAgent_Helper">\MAKS\AmqpAgent\Helper</h2>
264311
</tbody>
265312
</table>
266313
</div>
314+
<div class="container">
315+
<h2 id="MAKS_AmqpAgent_RPC">\MAKS\AmqpAgent\RPC</h2>
316+
<table class="styled">
317+
<thead>
318+
<tr>
319+
<th>Name</th>
320+
<th>Description</th>
321+
<th/>
322+
</tr>
323+
</thead>
324+
<tbody>
325+
<tr>
326+
<td>
327+
<a href="classes/MAKS_AmqpAgent_RPC_AbstractEndpoint.html">AbstractEndpoint</a>
328+
</td>
329+
<td>An abstract class implementing the basic functionality of an endpoint.</td>
330+
<td class="testresult-PASSED">PASSED</td>
331+
</tr>
332+
<tr>
333+
<td>
334+
<a href="classes/MAKS_AmqpAgent_RPC_ClientEndpoint.html">ClientEndpoint</a>
335+
</td>
336+
<td>A class specialized in requesting. Implementing only the methods needed for a client.</td>
337+
<td class="testresult-PASSED">PASSED</td>
338+
</tr>
339+
<tr>
340+
<td>
341+
<a href="classes/MAKS_AmqpAgent_RPC_ServerEndpoint.html">ServerEndpoint</a>
342+
</td>
343+
<td>A class specialized in responding. Implementing only the methods needed for a server.</td>
344+
<td class="testresult-PASSED">PASSED</td>
345+
</tr>
346+
</tbody>
347+
</table>
348+
</div>
267349
<div class="container">
268350
<h2 id="MAKS_AmqpAgent_Worker">\MAKS\AmqpAgent\Worker</h2>
269351
<table class="styled">

‎docs/classes/MAKS_AmqpAgent_Client.html

+17-3
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<a href="#methods">Methods</a>
6666
</li>
6767
<li>
68-
<a href="../source/Client.php.html#line33">Source</a>
68+
<a href="../source/Client.php.html#line35">Source</a>
6969
</li>
7070
</ul>
7171
</nav>
@@ -79,6 +79,8 @@ <h2 id="synopsis">Synopsis</h2>
7979
{<br/><ul class="none"><li>// members</li><li>protected <span title="MAKS\AmqpAgent\Config">Config</span> <a href="#members">$config</a>;
8080
</li><li>protected <span title="MAKS\AmqpAgent\Worker\Publisher">Publisher</span> <a href="#members">$publisher</a>;
8181
</li><li>protected <span title="MAKS\AmqpAgent\Worker\Consumer">Consumer</span> <a href="#members">$consumer</a>;
82+
</li><li>protected <span title="MAKS\AmqpAgent\RPC\ClientEndpoint">ClientEndpoint</span> <a href="#members">$clientEndpoint</a>;
83+
</li><li>protected <span title="MAKS\AmqpAgent\RPC\ServerEndpoint">ServerEndpoint</span> <a href="#members">$serverEndpoint</a>;
8284
</li><li>protected <span title="MAKS\AmqpAgent\Helper\Serializer">Serializer</span> <a href="#members">$serializer</a>;
8385
</li><li>protected <span title="MAKS\AmqpAgent\Helper\Logger">Logger</span> <a href="#members">$logger</a>;
8486
</li></ul><ul class="none"><li>// methods</li><li>public void <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/__construct.html">__construct</a>()
@@ -87,6 +89,8 @@ <h2 id="synopsis">Synopsis</h2>
8789
</li><li>public static array <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/gettable.html">gettable</a>()
8890
</li><li>public <span title="Publisher">Publisher</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getPublisher.html">getPublisher</a>()
8991
</li><li>public <span title="Consumer">Consumer</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getConsumer.html">getConsumer</a>()
92+
</li><li>public <span title="ClientEndpoint">ClientEndpoint</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getClientEndpoint.html">getClientEndpoint</a>()
93+
</li><li>public <span title="ServerEndpoint">ServerEndpoint</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getServerEndpoint.html">getServerEndpoint</a>()
9094
</li><li>public <span title="Serializer">Serializer</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getSerializer.html">getSerializer</a>()
9195
</li><li>public <span title="Logger">Logger</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getLogger.html">getLogger</a>()
9296
</li><li>public <span title="Config">Config</span> <a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getConfig.html">getConfig</a>()
@@ -98,18 +102,21 @@ <h2 id="coverage">Coverage</h2>
98102
<tr>
99103
<td>Methods</td>
100104
<td class="percent">100%</td>
101-
<td class="nummeric">9 / 9</td>
105+
<td class="nummeric">11 / 11</td>
102106
</tr>
103107
<tr>
104108
<td>Lines</td>
105109
<td class="percent">100%</td>
106-
<td class="nummeric">47 / 47</td>
110+
<td class="nummeric">57 / 57</td>
107111
</tr>
108112
</table>
109113
<h2 id="members">Members</h2>
110114
<div class="styled members">
111115
<h4>protected</h4>
112116
<ul class="members">
117+
<li id="clientEndpoint"><strong>$clientEndpoint</strong>
118+
—
119+
<a title="MAKS\AmqpAgent\RPC\ClientEndpoint" href="../classes/MAKS_AmqpAgent_RPC_ClientEndpoint.html">MAKS\AmqpAgent\RPC\ClientEndpoint</a><br/><span class="indent">An instance of the RPC Client class.</span></li>
113120
<li id="config"><strong>$config</strong>
114121
—
115122
<a title="MAKS\AmqpAgent\Config" href="../classes/MAKS_AmqpAgent_Config.html">MAKS\AmqpAgent\Config</a><br/><span class="indent">An instance of the configuration object.</span></li>
@@ -125,6 +132,9 @@ <h4>protected</h4>
125132
<li id="serializer"><strong>$serializer</strong>
126133
—
127134
<a title="MAKS\AmqpAgent\Helper\Serializer" href="../classes/MAKS_AmqpAgent_Helper_Serializer.html">MAKS\AmqpAgent\Helper\Serializer</a><br/><span class="indent">An instance of the Serializer class.</span></li>
135+
<li id="serverEndpoint"><strong>$serverEndpoint</strong>
136+
—
137+
<a title="MAKS\AmqpAgent\RPC\ServerEndpoint" href="../classes/MAKS_AmqpAgent_RPC_ServerEndpoint.html">MAKS\AmqpAgent\RPC\ServerEndpoint</a><br/><span class="indent">An instance of the RPC Server class.</span></li>
128138
</ul>
129139
</div>
130140
<h2 id="methods">Methods</h2>
@@ -137,6 +147,8 @@ <h4>public</h4>
137147
— Gets a class member via public property access notation.</li>
138148
<li id="get"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/get.html">get()</a>
139149
— Returns an instance of a class by its name (lowercase, UPPERCASE, PascalCase, camelCase, dot.case, kebab-case, or snake_case representation of class name).</li>
150+
<li id="getClientEndpoint"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getClientEndpoint.html">getClientEndpoint()</a>
151+
— Returns an instance of the Consumer class.</li>
140152
<li id="getConfig"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getConfig.html">getConfig()</a>
141153
— Returns the currently used config object.</li>
142154
<li id="getConsumer"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getConsumer.html">getConsumer()</a>
@@ -147,6 +159,8 @@ <h4>public</h4>
147159
— Returns an instance of the Publisher class.</li>
148160
<li id="getSerializer"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getSerializer.html">getSerializer()</a>
149161
— Returns an instance of the Serializer class.</li>
162+
<li id="getServerEndpoint"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/getServerEndpoint.html">getServerEndpoint()</a>
163+
— Returns an instance of the Consumer class.</li>
150164
<li id="gettable"><a title="MAKS\AmqpAgent\Client" href="../classes/MAKS_AmqpAgent_Client/gettable.html">gettable()</a>
151165
— Returns an array of available members that can be obtained via `self::get()`.</li>
152166
</ul>

‎docs/classes/MAKS_AmqpAgent_Client/__construct.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<a href="#tests">Tests</a>
6969
</li>
7070
<li>
71-
<a href="../../source/Client.php.html#line71">Source</a>
71+
<a href="../../source/Client.php.html#line85">Source</a>
7272
</li>
7373
</ul>
7474
</nav>
@@ -104,15 +104,17 @@ <h2 id="tests">Test Coverage</h2>
104104
<h3>Information</h3>
105105
<ul class="styled">
106106
<li>Coverage: 7/7 Lines (100%)</li>
107-
<li>Tests: 9</li>
108-
<li>Passed: 9 (100%)</li>
107+
<li>Tests: 11</li>
108+
<li>Passed: 11 (100%)</li>
109109
</ul>
110110
<h3>Tests</h3>
111111
<ul class="styled">
112112
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testAmqpAgentExceptionViaConstructorIsRaisedWhenUnSupportedArgumentIsProvided</li>
113113
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testInstantiatingAClientWithAPathToConfigFileAndGetingConfigInstanceBack</li>
114114
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetPublisherInstance</li>
115115
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetConsumerInstance</li>
116+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetServerEndpointInstance</li>
117+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetClientEndpointInstance</li>
116118
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetSerializerInstance</li>
117119
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetLoggerInstance</li>
118120
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetInstanceByName</li>

‎docs/classes/MAKS_AmqpAgent_Client/__get.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -68,7 +68,7 @@
6868
<a href="#tests">Tests</a>
6969
</li>
7070
<li>
71-
<a href="../../source/Client.php.html#line89">Source</a>
71+
<a href="../../source/Client.php.html#line103">Source</a>
7272
</li>
7373
</ul>
7474
</nav>
@@ -100,13 +100,15 @@ <h2 id="tests">Test Coverage</h2>
100100
<h3>Information</h3>
101101
<ul class="styled">
102102
<li>Coverage: 1/1 Lines (100%)</li>
103-
<li>Tests: 5</li>
104-
<li>Passed: 5 (100%)</li>
103+
<li>Tests: 7</li>
104+
<li>Passed: 7 (100%)</li>
105105
</ul>
106106
<h3>Tests</h3>
107107
<ul class="styled">
108108
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetPublisherInstance</li>
109109
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetConsumerInstance</li>
110+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetServerEndpointInstance</li>
111+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetClientEndpointInstance</li>
110112
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetSerializerInstance</li>
111113
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetLoggerInstance</li>
112114
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetInstanceByName</li>

‎docs/classes/MAKS_AmqpAgent_Client/get.html

+5-3
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
<a href="#tests">Tests</a>
7272
</li>
7373
<li>
74-
<a href="../../source/Client.php.html#line102">Source</a>
74+
<a href="../../source/Client.php.html#line116">Source</a>
7575
</li>
7676
</ul>
7777
</nav>
@@ -113,13 +113,15 @@ <h2 id="tests">Test Coverage</h2>
113113
<h3>Information</h3>
114114
<ul class="styled">
115115
<li>Coverage: 6/6 Lines (100%)</li>
116-
<li>Tests: 6</li>
117-
<li>Passed: 6 (100%)</li>
116+
<li>Tests: 8</li>
117+
<li>Passed: 8 (100%)</li>
118118
</ul>
119119
<h3>Tests</h3>
120120
<ul class="styled">
121121
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetPublisherInstance</li>
122122
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetConsumerInstance</li>
123+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetServerEndpointInstance</li>
124+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetClientEndpointInstance</li>
123125
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetSerializerInstance</li>
124126
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetLoggerInstance</li>
125127
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetInstanceByName</li>

‎docs/classes/MAKS_AmqpAgent_Client/getClientEndpoint.html

+107
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,107 @@
1+
<?xml version="1.0" encoding="UTF-8"?>
2+
<!DOCTYPE html SYSTEM "about:legacy-compat">
3+
<html xmlns="http://www.w3.org/1999/xhtml" lang="en">
4+
<head>
5+
<title>phpDox - MAKS\AmqpAgent\Client::getClientEndpoint</title>
6+
<link rel="stylesheet" type="text/css" href="../../css/style.css" media="screen"/>
7+
<meta http-equiv="content-type" content="text/html; charset=utf-8"/>
8+
</head>
9+
<body>
10+
<nav class="topnav">
11+
<ul>
12+
<li>
13+
<div class="logo"><span>/**</span>phpDox</div>
14+
</li>
15+
<li class="separator">
16+
<a href="../../index.html">Overview</a>
17+
</li>
18+
<li class="separator">
19+
<a href="../../namespaces.html">Namespaces</a>
20+
</li>
21+
<li>
22+
<a href="../../interfaces.html">Interfaces</a>
23+
</li>
24+
<li>
25+
<a href="../../classes.html">Classes</a>
26+
</li>
27+
<li>
28+
<a href="../../traits.html">Traits</a>
29+
</li>
30+
<li class="separator">
31+
<a href="../../source/index.html">Source</a>
32+
</li>
33+
</ul>
34+
</nav>
35+
<div id="mainstage">
36+
<div class="box">
37+
<ul class="breadcrumb">
38+
<li>
39+
<a href="../../index.html">Overview</a>
40+
</li>
41+
<li class="separator">
42+
<a href="../../classes.html">Classes</a>
43+
</li>
44+
<li class="separator">
45+
<a href="../../classes.html#MAKS_AmqpAgent">MAKS\AmqpAgent</a>
46+
</li>
47+
<li class="separator">
48+
<a title="MAKS\AmqpAgent\Client" href="../../classes/MAKS_AmqpAgent_Client.html">Client</a>
49+
</li>
50+
<li class="separator">getClientEndpoint</li>
51+
</ul>
52+
</div>
53+
<nav class="box">
54+
<ul>
55+
<li>
56+
<a href="#introduction">Introduction</a>
57+
</li>
58+
<li>
59+
<a href="#synopsis">Synopsis</a>
60+
</li>
61+
<li>
62+
<a href="#return">Return</a>
63+
</li>
64+
<li>
65+
<a href="#tests">Tests</a>
66+
</li>
67+
<li>
68+
<a href="../../source/Client.php.html#line198">Source</a>
69+
</li>
70+
</ul>
71+
</nav>
72+
<section>
73+
<h1><small>MAKS\AmqpAgent\Client::</small>getClientEndpoint</h1>
74+
<h4>Returns an instance of the Consumer class.</h4>
75+
<p/>
76+
<ul/>
77+
<h2 id="signature">Signature</h2>
78+
<div class="styled synopsis">
79+
<code>public function getClientEndpoint()
80+
</code>
81+
</div>
82+
<h2 id="return">Returns</h2>
83+
<dl class="styled">
84+
<dt>ClientEndpoint</dt>
85+
<dd><br/>
86+
</dd>
87+
</dl>
88+
<h2 id="tests">Test Coverage</h2>
89+
<div class="styled">
90+
<h3>Information</h3>
91+
<ul class="styled">
92+
<li>Coverage: 5/5 Lines (100%)</li>
93+
<li>Tests: 1</li>
94+
<li>Passed: 1 (100%)</li>
95+
</ul>
96+
<h3>Tests</h3>
97+
<ul class="styled">
98+
<li>[ <span class="testresult-PASSED">PASSED</span> ] — MAKS\AmqpAgent\Tests\ClientTest::testGetClientEndpointInstance</li>
99+
</ul>
100+
</div>
101+
</section>
102+
</div>
103+
<footer>
104+
<span>Generated using phpDox 0.12.0-dev - Copyright (C) 2010 - 2020 by Arne Blankerts and Contributors</span>
105+
</footer>
106+
</body>
107+
</html>

‎docs/classes/MAKS_AmqpAgent_Client/getConfig.html

+1-1
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@
6565
<a href="#tests">Tests</a>
6666
</li>
6767
<li>
68-
<a href="../../source/Client.php.html#line210">Source</a>
68+
<a href="../../source/Client.php.html#line256">Source</a>
6969
</li>
7070
</ul>
7171
</nav>

0 commit comments

Comments
 (0)