/
ClassMethods.html
349 lines (197 loc) · 11.7 KB
/
ClassMethods.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
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
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
<!DOCTYPE html>
<html>
<head>
<meta content="text/html; charset=utf-8" http-equiv="Content-Type">
<title>module SafeInPlaceEditing::ClassMethods - YOUR_TITLE</title>
<link type="text/css" media="screen" href="../rdoc.css" rel="stylesheet">
<script type="text/javascript">
var rdoc_rel_prefix = "../";
</script>
<script type="text/javascript" charset="utf-8" src="../js/jquery.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/navigation.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search_index.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/search.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/searcher.js"></script>
<script type="text/javascript" charset="utf-8" src="../js/darkfish.js"></script>
<body id="top" class="module">
<nav id="metadata">
<nav id="home-section" class="section">
<h3 class="section-header">
<a href="../index.html">Home</a>
<a href="../table_of_contents.html#classes">Classes</a>
<a href="../table_of_contents.html#methods">Methods</a>
</h3>
</nav>
<nav id="search-section" class="section project-section" class="initially-hidden">
<form action="#" method="get" accept-charset="utf-8">
<h3 class="section-header">
<input type="text" name="search" placeholder="Search" id="search-field"
title="Type to search, Up and Down to navigate, Enter to load">
</h3>
</form>
<ul id="search-results" class="initially-hidden"></ul>
</nav>
<div id="file-metadata">
<nav id="file-list-section" class="section">
<h3 class="section-header">Defined In</h3>
<ul>
<li>lib/safe_in_place_editing/safe_in_place_editing.rb
</ul>
</nav>
</div>
<div id="class-metadata">
<!-- Method Quickref -->
<nav id="method-list-section" class="section">
<h3 class="section-header">Methods</h3>
<ul class="link-list">
<li><a href="#method-i-safe_in_place_edit_for">#safe_in_place_edit_for</a>
</ul>
</nav>
</div>
<div id="project-metadata">
<nav id="fileindex-section" class="section project-section">
<h3 class="section-header">Pages</h3>
<ul>
<li class="file"><a href="../doc/README_FOR_APP.html">README_FOR_APP</a>
</ul>
</nav>
<nav id="classindex-section" class="section project-section">
<h3 class="section-header">Class and Module Index</h3>
<ul class="link-list">
<li><a href="../TrackRecordReport.html">TrackRecordReport</a>
<li><a href="../TrackRecordReport/Calculator.html">TrackRecordReport::Calculator</a>
<li><a href="../TrackRecordReport/CalculatorWithUsers.html">TrackRecordReport::CalculatorWithUsers</a>
<li><a href="../TrackRecordReport/Cell.html">TrackRecordReport::Cell</a>
<li><a href="../TrackRecordReport/Report.html">TrackRecordReport::Report</a>
<li><a href="../TrackRecordReport/Row.html">TrackRecordReport::Row</a>
<li><a href="../TrackRecordReport/Section.html">TrackRecordReport::Section</a>
<li><a href="../TrackRecordSections.html">TrackRecordSections</a>
<li><a href="../TrackRecordSections/Group.html">TrackRecordSections::Group</a>
<li><a href="../TrackRecordSections/GroupMixin.html">TrackRecordSections::GroupMixin</a>
<li><a href="../TrackRecordSections/Section.html">TrackRecordSections::Section</a>
<li><a href="../TrackRecordSections/SectionMixin.html">TrackRecordSections::SectionMixin</a>
<li><a href="../TrackRecordSections/Sections.html">TrackRecordSections::Sections</a>
<li><a href="../TrackRecordSections/SectionsMixin.html">TrackRecordSections::SectionsMixin</a>
<li><a href="../ReportsHelper.html">ReportsHelper</a>
<li><a href="../ReportsHelper/ReportMonth.html">ReportsHelper::ReportMonth</a>
<li><a href="../ReportsHelper/ReportWeek.html">ReportsHelper::ReportWeek</a>
<li><a href="../ReportsHelper/ReportYear.html">ReportsHelper::ReportYear</a>
<li><a href="../QuietLeightbox.html">QuietLeightbox</a>
<li><a href="../QuietLeightbox/ClassMethods.html">QuietLeightbox::ClassMethods</a>
<li><a href="../QuietLeightbox/QuietLeightboxHelper.html">QuietLeightbox::QuietLeightboxHelper</a>
<li><a href="../QuietPrototype.html">QuietPrototype</a>
<li><a href="../QuietPrototype/ClassMethods.html">QuietPrototype::ClassMethods</a>
<li><a href="../QuietPrototype/QuietPrototypeHelper.html">QuietPrototype::QuietPrototypeHelper</a>
<li><a href="../YuiTree.html">YuiTree</a>
<li><a href="../YuiTree/ClassMethods.html">YuiTree::ClassMethods</a>
<li><a href="../YuiTree/YuiTreeHelper.html">YuiTree::YuiTreeHelper</a>
<li><a href="../SafeInPlaceEditing.html">SafeInPlaceEditing</a>
<li><a href="../SafeInPlaceEditing/ClassMethods.html">SafeInPlaceEditing::ClassMethods</a>
<li><a href="../TrackRecordReportGenerator.html">TrackRecordReportGenerator</a>
<li><a href="../TrackRecordReportGenerator/UkOrgPondCSV.html">TrackRecordReportGenerator::UkOrgPondCSV</a>
<li><a href="../ApplicationController.html">ApplicationController</a>
<li><a href="../ApplicationHelper.html">ApplicationHelper</a>
<li><a href="../AuditsController.html">AuditsController</a>
<li><a href="../AuditsHelper.html">AuditsHelper</a>
<li><a href="../ChartsController.html">ChartsController</a>
<li><a href="../ChartsHelper.html">ChartsHelper</a>
<li><a href="../ControlPanel.html">ControlPanel</a>
<li><a href="../ControlPanelsController.html">ControlPanelsController</a>
<li><a href="../Customer.html">Customer</a>
<li><a href="../CustomersController.html">CustomersController</a>
<li><a href="../CustomersHelper.html">CustomersHelper</a>
<li><a href="../EmailNotifier.html">EmailNotifier</a>
<li><a href="../HelpController.html">HelpController</a>
<li><a href="../HelpHelper.html">HelpHelper</a>
<li><a href="../Project.html">Project</a>
<li><a href="../ProjectsController.html">ProjectsController</a>
<li><a href="../ProjectsHelper.html">ProjectsHelper</a>
<li><a href="../Rangeable.html">Rangeable</a>
<li><a href="../ReportsController.html">ReportsController</a>
<li><a href="../SafeInPlaceEditingHelper.html">SafeInPlaceEditingHelper</a>
<li><a href="../SavedReport.html">SavedReport</a>
<li><a href="../SavedReportAutoTitlesController.html">SavedReportAutoTitlesController</a>
<li><a href="../SavedReportsBaseController.html">SavedReportsBaseController</a>
<li><a href="../SavedReportsByCustomerController.html">SavedReportsByCustomerController</a>
<li><a href="../SavedReportsByProjectController.html">SavedReportsByProjectController</a>
<li><a href="../SavedReportsByTaskController.html">SavedReportsByTaskController</a>
<li><a href="../SavedReportsByUserController.html">SavedReportsByUserController</a>
<li><a href="../SavedReportsController.html">SavedReportsController</a>
<li><a href="../SavedReportsHelper.html">SavedReportsHelper</a>
<li><a href="../SessionsController.html">SessionsController</a>
<li><a href="../Task.html">Task</a>
<li><a href="../TaskGroup.html">TaskGroup</a>
<li><a href="../TaskImport.html">TaskImport</a>
<li><a href="../TaskImportsController.html">TaskImportsController</a>
<li><a href="../TaskImportsHelper.html">TaskImportsHelper</a>
<li><a href="../TasksController.html">TasksController</a>
<li><a href="../TasksHelper.html">TasksHelper</a>
<li><a href="../Timesheet.html">Timesheet</a>
<li><a href="../TimesheetForceCommit.html">TimesheetForceCommit</a>
<li><a href="../TimesheetForceCommitsController.html">TimesheetForceCommitsController</a>
<li><a href="../TimesheetRow.html">TimesheetRow</a>
<li><a href="../TimesheetRowsController.html">TimesheetRowsController</a>
<li><a href="../TimesheetRowsHelper.html">TimesheetRowsHelper</a>
<li><a href="../TimesheetsController.html">TimesheetsController</a>
<li><a href="../TimesheetsHelper.html">TimesheetsHelper</a>
<li><a href="../TreesController.html">TreesController</a>
<li><a href="../User.html">User</a>
<li><a href="../UsersController.html">UsersController</a>
<li><a href="../UsersHelper.html">UsersHelper</a>
<li><a href="../WorkPacket.html">WorkPacket</a>
<li><a href="../WorkPacketsController.html">WorkPacketsController</a>
<li><a href="../WorkPacketsHelper.html">WorkPacketsHelper</a>
</ul>
</nav>
</div>
</nav>
<div id="documentation">
<h1 class="module">module SafeInPlaceEditing::ClassMethods</h1>
<div id="description" class="description">
</div><!-- description -->
<section id="5Buntitled-5D" class="documentation-section">
<!-- Methods -->
<section id="public-instance-5Buntitled-5D-method-details" class="method-section section">
<h3 class="section-header">Public Instance Methods</h3>
<div id="method-i-safe_in_place_edit_for" class="method-detail ">
<div class="method-heading">
<span class="method-name">safe_in_place_edit_for</span><span
class="method-args">( object, attribute, options = {} )</span>
<span class="method-click-advice">click to toggle source</span>
</div>
<div class="method-description">
<p>Exact API equivalent of in_place_edit_for, except:</p>
<ul><li>
<p>Runs all user data through “ERB::Util::html_escape” when sending it to the
view to avoid associated vulnerabilities with otherwise-unescaped
user-supplied data; the current InPlaceEditing plugin does this too, albeit
using “CGI::escapeHTML” for some reason.</p>
</li><li>
<p>Supports optimistic locking if a lock_version CGI parameter is supplied, by
explicitly checking the version being updated.</p>
</li><li>
<p>Explicitly catches errors and returns them as 500 status codes with a plain
text message regardless of Rails environment.</p>
</li></ul>
<p>See safe_in_place_editor and safe_in_place_editor_field inside file
“safe_in_place_editing_helper.rb” for the counterpart helper functions.</p>
<p>The Prototype library getText function must be patched as described in the
README rationale; see public/javascripts/safe_in_place_editing.js.</p>
<div class="method-source-code" id="safe_in_place_edit_for-source">
<pre><span class="ruby-comment"># File lib/safe_in_place_editing/safe_in_place_editing.rb, line 37</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier">safe_in_place_edit_for</span>( <span class="ruby-identifier">object</span>, <span class="ruby-identifier">attribute</span>, <span class="ruby-identifier">options</span> = {} )
<span class="ruby-identifier">define_method</span>( <span class="ruby-node">"set_#{object}_#{attribute}"</span> ) <span class="ruby-keyword">do</span>
<span class="ruby-identifier">safe_in_place_edit_backend</span>( <span class="ruby-identifier">object</span>, <span class="ruby-identifier">attribute</span>, <span class="ruby-identifier">options</span> )
<span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
</div><!-- safe_in_place_edit_for-source -->
</div>
</div><!-- safe_in_place_edit_for-method -->
</section><!-- public-instance-method-details -->
</section><!-- 5Buntitled-5D -->
</div><!-- documentation -->
<footer id="validator-badges">
<p><a href="http://validator.w3.org/check/referer">[Validate]</a>
<p>Generated by <a href="https://github.com/rdoc/rdoc">RDoc</a> 3.12.2.
<p>Generated with the <a href="http://deveiate.org/projects/Darkfish-Rdoc/">Darkfish Rdoc Generator</a> 3.
</footer>