Skip to content

Commit 3c7bce8

Browse files
therouvtherouv
committed
[+FEATURE] Added generated files by phpDox
1 parent 6a39b30 commit 3c7bce8

File tree

50 files changed

+5307
-0
lines changed

Some content is hidden

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

50 files changed

+5307
-0
lines changed

‎docs/api/html/classes/FireGento_AdminMonitoring_Adminhtml_HistoryController.xhtml‎

Lines changed: 78 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,78 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!DOCTYPE html PUBLIC "html" "">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<title>FireGento_AdminMonitoring - FireGento_AdminMonitoring_Adminhtml_HistoryController - API Documentation</title>
7+
<link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
8+
<link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
9+
</head>
10+
<body>
11+
<div class="wrapper clearfix">
12+
<div class="topbar clearfix">
13+
<h1>
14+
<a class="brand" href="../index.xhtml">FireGento_AdminMonitoring - API Documentation</a>
15+
</h1>
16+
<ul class="nav">
17+
<li class="active">
18+
<a href="../index.xhtml">Overview</a>
19+
</li>
20+
</ul>
21+
</div>
22+
<div class="navigation">
23+
<h3>Methods</h3>
24+
<ul>
25+
<li>
26+
<a href="#_initAction">_initAction</a>
27+
</li>
28+
<li>
29+
<a href="#indexAction">indexAction</a>
30+
</li>
31+
<li>
32+
<a href="#revertAction">revertAction</a>
33+
</li>
34+
</ul>
35+
</div>
36+
<div class="content">
37+
<h2><span style="font-size:60%">\</span>FireGento_AdminMonitoring_Adminhtml_HistoryController</h2>
38+
<div class="file-notice">
39+
<p>History controller</p>
40+
</div>
41+
<ul class="fileinfos">
42+
<li><b>Author: </b>FireGento Team &lt;team@firegento.com&gt;</li>
43+
</ul>
44+
<h3>Methods</h3>
45+
<ul class="varlist">
46+
<li>
47+
<a name="indexAction"/>
48+
<h4><span class="label public">public</span>indexAction<span style="font-size:90%;">( )</span></h4>
49+
<p style="font-size:110%; padding-top:5px;">
50+
<li>Shows the history grid</li>
51+
</p>
52+
</li>
53+
<li>
54+
<a name="revertAction"/>
55+
<h4><span class="label public">public</span>revertAction<span style="font-size:90%;">( )</span></h4>
56+
<p style="font-size:110%; padding-top:5px;">
57+
<li>Reverts a history entry</li>
58+
</p>
59+
</li>
60+
<li>
61+
<a name="_initAction"/>
62+
<h4><span class="label protected">protected</span>_initAction<span style="font-size:90%;">( )</span></h4>
63+
<p style="font-size:110%; padding-top:5px;">
64+
<li>Inits the layout, the active menu tab and the breadcrumbs</li>
65+
</p>
66+
<ul>
67+
<h4 class="return">Returns:</h4>
68+
<ul class="return">
69+
<li/>
70+
</ul>
71+
</ul>
72+
</li>
73+
</ul>
74+
<div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
75+
</div>
76+
</div>
77+
</body>
78+
</html>

‎docs/api/html/classes/FireGento_AdminMonitoring_Block_Adminhtml_History.xhtml‎

Lines changed: 52 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,52 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!DOCTYPE html PUBLIC "html" "">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<title>FireGento_AdminMonitoring - FireGento_AdminMonitoring_Block_Adminhtml_History - API Documentation</title>
7+
<link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
8+
<link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
9+
</head>
10+
<body>
11+
<div class="wrapper clearfix">
12+
<div class="topbar clearfix">
13+
<h1>
14+
<a class="brand" href="../index.xhtml">FireGento_AdminMonitoring - API Documentation</a>
15+
</h1>
16+
<ul class="nav">
17+
<li class="active">
18+
<a href="../index.xhtml">Overview</a>
19+
</li>
20+
</ul>
21+
</div>
22+
<div class="navigation">
23+
<h3>Methods</h3>
24+
<ul>
25+
<li>
26+
<a href="#__construct">__construct</a>
27+
</li>
28+
</ul>
29+
</div>
30+
<div class="content">
31+
<h2><span style="font-size:60%">\</span>FireGento_AdminMonitoring_Block_Adminhtml_History</h2>
32+
<div class="file-notice">
33+
<p>Displays the logging history grid container</p>
34+
</div>
35+
<ul class="fileinfos">
36+
<li><b>Author: </b>FireGento Team &lt;team@firegento.com&gt;</li>
37+
</ul>
38+
<h3>Constructor</h3>
39+
<ul class="varlist">
40+
<li>
41+
<a name="__construct"/>
42+
<h4><span class="label public">public</span>__construct<span style="font-size:90%;">( )</span></h4>
43+
<p style="font-size:110%; padding-top:5px;">
44+
<li>Constructor of the grid container</li>
45+
</p>
46+
</li>
47+
</ul>
48+
<div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
49+
</div>
50+
</div>
51+
</body>
52+
</html>

‎docs/api/html/classes/FireGento_AdminMonitoring_Block_Adminhtml_History_Grid.xhtml‎

Lines changed: 261 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,261 @@
1+
<?xml version="1.0" encoding="utf-8"?>
2+
<!DOCTYPE html PUBLIC "html" "">
3+
<html xmlns="http://www.w3.org/1999/xhtml" class="no-js" lang="en">
4+
<head>
5+
<meta charset="utf-8"/>
6+
<title>FireGento_AdminMonitoring - FireGento_AdminMonitoring_Block_Adminhtml_History_Grid - API Documentation</title>
7+
<link href="../css/normalize.css" rel="stylesheet" type="text/css" media="all"/>
8+
<link href="../css/styles.css" rel="stylesheet" type="text/css" media="all"/>
9+
</head>
10+
<body>
11+
<div class="wrapper clearfix">
12+
<div class="topbar clearfix">
13+
<h1>
14+
<a class="brand" href="../index.xhtml">FireGento_AdminMonitoring - API Documentation</a>
15+
</h1>
16+
<ul class="nav">
17+
<li class="active">
18+
<a href="../index.xhtml">Overview</a>
19+
</li>
20+
</ul>
21+
</div>
22+
<div class="navigation">
23+
<h3>Methods</h3>
24+
<ul>
25+
<li>
26+
<a href="#__construct">__construct</a>
27+
</li>
28+
<li>
29+
<a href="#_prepareCollection">_prepareCollection</a>
30+
</li>
31+
<li>
32+
<a href="#_prepareColumns">_prepareColumns</a>
33+
</li>
34+
<li>
35+
<a href="#decodeContent">decodeContent</a>
36+
</li>
37+
<li>
38+
<a href="#entities">entities</a>
39+
</li>
40+
<li>
41+
<a href="#formatCellContent">formatCellContent</a>
42+
</li>
43+
<li>
44+
<a href="#getMonitoringHelper">getMonitoringHelper</a>
45+
</li>
46+
<li>
47+
<a href="#getRowUrl">getRowUrl</a>
48+
</li>
49+
<li>
50+
<a href="#showNewContent">showNewContent</a>
51+
</li>
52+
<li>
53+
<a href="#showOldContent">showOldContent</a>
54+
</li>
55+
<li>
56+
<a href="#wrapColor">wrapColor</a>
57+
</li>
58+
</ul>
59+
</div>
60+
<div class="content">
61+
<h2><span style="font-size:60%">\</span>FireGento_AdminMonitoring_Block_Adminhtml_History_Grid</h2>
62+
<div class="file-notice">
63+
<p>Displays the logging history grid</p>
64+
</div>
65+
<ul class="fileinfos">
66+
<li><b>Author: </b>FireGento Team &lt;team@firegento.com&gt;</li>
67+
</ul>
68+
<h3>Constructor</h3>
69+
<ul class="varlist">
70+
<li>
71+
<a name="__construct"/>
72+
<h4><span class="label public">public</span>__construct<span style="font-size:90%;">( )</span></h4>
73+
<p style="font-size:110%; padding-top:5px;">
74+
<li>Grid constructor</li>
75+
</p>
76+
</li>
77+
</ul>
78+
<h3>Methods</h3>
79+
<ul class="varlist">
80+
<li>
81+
<a name="getMonitoringHelper"/>
82+
<h4><span class="label public">public</span>getMonitoringHelper<span style="font-size:90%;">( )</span></h4>
83+
<p style="font-size:110%; padding-top:5px;">
84+
<li>Retrieve helper class</li>
85+
</p>
86+
<ul>
87+
<h4 class="return">Returns:</h4>
88+
<ul class="return">
89+
<li>Helper Instance</li>
90+
</ul>
91+
</ul>
92+
</li>
93+
<li>
94+
<a name="getRowUrl"/>
95+
<h4><span class="label public">public</span>getRowUrl<span style="font-size:90%;">( <span class="param-type"><a href="../classes/FireGento_AdminMonitoring_Model_History.xhtml">FireGento_AdminMonitoring_Model_History</a></span><strong> $row</strong> )</span></h4>
96+
<p style="font-size:110%; padding-top:5px;">
97+
<li>Retrieve the row url for the given history entry</li>
98+
</p>
99+
<ul>
100+
<h4 class="param">Parameters:</h4>
101+
<ul class="param">
102+
<li><code>$row</code> - History Model</li>
103+
</ul>
104+
</ul>
105+
<ul>
106+
<h4 class="return">Returns:</h4>
107+
<ul class="return">
108+
<li/>
109+
</ul>
110+
</ul>
111+
</li>
112+
<li>
113+
<a name="showNewContent"/>
114+
<h4><span class="label public">public</span>showNewContent<span style="font-size:90%;">( <span class="param-type">string</span><strong> $newContent</strong>, <span class="param-type"><span title="\\FireGento_AdminMonitoring_Model_History">FireGento_AdminMonitoring_Model_History</span></span><strong> $row</strong> )</span></h4>
115+
<p style="font-size:110%; padding-top:5px;">
116+
<li>Show the new content after the changes.</li>
117+
</p>
118+
<ul>
119+
<h4 class="param">Parameters:</h4>
120+
<ul class="param">
121+
<li><code>$newContent</code> - New Content</li>
122+
<li><code>$row</code> - History Model</li>
123+
</ul>
124+
</ul>
125+
<ul>
126+
<h4 class="return">Returns:</h4>
127+
<ul class="return">
128+
<li/>
129+
</ul>
130+
</ul>
131+
</li>
132+
<li>
133+
<a name="showOldContent"/>
134+
<h4><span class="label public">public</span>showOldContent<span style="font-size:90%;">( <span class="param-type">string</span><strong> $oldContent</strong>, <span class="param-type"><span title="\\FireGento_AdminMonitoring_Model_History">FireGento_AdminMonitoring_Model_History</span></span><strong> $row</strong> )</span></h4>
135+
<p style="font-size:110%; padding-top:5px;">
136+
<li>Show the old content before the changes.</li>
137+
</p>
138+
<ul>
139+
<h4 class="param">Parameters:</h4>
140+
<ul class="param">
141+
<li><code>$oldContent</code> - Old Content</li>
142+
<li><code>$row</code> - History Model</li>
143+
</ul>
144+
</ul>
145+
<ul>
146+
<h4 class="return">Returns:</h4>
147+
<ul class="return">
148+
<li/>
149+
</ul>
150+
</ul>
151+
</li>
152+
<li>
153+
<a name="_prepareCollection"/>
154+
<h4><span class="label protected">protected</span>_prepareCollection<span style="font-size:90%;">( )</span></h4>
155+
<p style="font-size:110%; padding-top:5px;">
156+
<li>Prepare the grid collection</li>
157+
</p>
158+
<ul>
159+
<h4 class="return">Returns:</h4>
160+
<ul class="return">
161+
<li>Self.</li>
162+
</ul>
163+
</ul>
164+
</li>
165+
<li>
166+
<a name="_prepareColumns"/>
167+
<h4><span class="label protected">protected</span>_prepareColumns<span style="font-size:90%;">( )</span></h4>
168+
<p style="font-size:110%; padding-top:5px;">
169+
<li>Prepare the grid columns</li>
170+
</p>
171+
<ul>
172+
<h4 class="return">Returns:</h4>
173+
<ul class="return">
174+
<li>Self.</li>
175+
</ul>
176+
</ul>
177+
</li>
178+
<li>
179+
<a name="decodeContent"/>
180+
<h4><span class="label private">private</span>decodeContent<span style="font-size:90%;">( <span class="param-type">string</span><strong> $content</strong> )</span></h4>
181+
<p style="font-size:110%; padding-top:5px;">
182+
<li>Decode the given content string.</li>
183+
</p>
184+
<ul>
185+
<h4 class="param">Parameters:</h4>
186+
<ul class="param">
187+
<li><code>$content</code> - Content to decode</li>
188+
</ul>
189+
</ul>
190+
<ul>
191+
<h4 class="return">Returns:</h4>
192+
<ul class="return">
193+
<li/>
194+
</ul>
195+
</ul>
196+
</li>
197+
<li>
198+
<a name="entities"/>
199+
<h4><span class="label private">private</span>entities<span style="font-size:90%;">( <span class="param-type">string</span><strong> $string</strong> )</span></h4>
200+
<p style="font-size:110%; padding-top:5px;">
201+
<li>Convert special characters to HTML entities</li>
202+
</p>
203+
<ul>
204+
<h4 class="param">Parameters:</h4>
205+
<ul class="param">
206+
<li><code>$string</code> - Input string</li>
207+
</ul>
208+
</ul>
209+
<ul>
210+
<h4 class="return">Returns:</h4>
211+
<ul class="return">
212+
<li/>
213+
</ul>
214+
</ul>
215+
</li>
216+
<li>
217+
<a name="formatCellContent"/>
218+
<h4><span class="label private">private</span>formatCellContent<span style="font-size:90%;">( <span class="param-type">string</span><strong> $key</strong>, <span class="param-type"><span title="array|string">array|string</span></span><strong> $value</strong> )</span></h4>
219+
<p style="font-size:110%; padding-top:5px;">
220+
<li>Format the cell content</li>
221+
</p>
222+
<ul>
223+
<h4 class="param">Parameters:</h4>
224+
<ul class="param">
225+
<li><code>$key</code> - Key</li>
226+
<li><code>$value</code> - Value</li>
227+
</ul>
228+
</ul>
229+
<ul>
230+
<h4 class="return">Returns:</h4>
231+
<ul class="return">
232+
<li>Formatted string</li>
233+
</ul>
234+
</ul>
235+
</li>
236+
<li>
237+
<a name="wrapColor"/>
238+
<h4><span class="label private">private</span>wrapColor<span style="font-size:90%;">( <span class="param-type">string</span><strong> $string</strong>, <span class="param-type">string</span><strong> $color</strong> )</span></h4>
239+
<p style="font-size:110%; padding-top:5px;">
240+
<li>Wrap the given string in a box with a given border color.</li>
241+
</p>
242+
<ul>
243+
<h4 class="param">Parameters:</h4>
244+
<ul class="param">
245+
<li><code>$string</code> - String to format</li>
246+
<li><code>$color</code> - Border color</li>
247+
</ul>
248+
</ul>
249+
<ul>
250+
<h4 class="return">Returns:</h4>
251+
<ul class="return">
252+
<li>Formatted string</li>
253+
</ul>
254+
</ul>
255+
</li>
256+
</ul>
257+
<div class="footer">Generated using phpDox 0.5 - Copyright (C) 2010 - 2013 by Arne Blankerts</div>
258+
</div>
259+
</div>
260+
</body>
261+
</html>

0 commit comments

Comments
 (0)