1 <?xml version=
"1.0" encoding=
"iso-8859-1"?>
2 <!DOCTYPE html PUBLIC
"-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
3 <html xmlns=
"http://www.w3.org/1999/xhtml">
5 <!-- template designed by Marco Von Ballmoos -->
6 <title>Docs For Class iCalProp
</title>
7 <link rel=
"stylesheet" href=
"../../media/stylesheet.css" />
8 <script src=
"../../media/lib/classTree.js"></script>
9 <script language=
"javascript" type=
"text/javascript">
10 var imgPlus = new Image();
11 var imgMinus = new Image();
12 imgPlus.src =
"../../media/images/plus.png";
13 imgMinus.src =
"../../media/images/minus.png";
15 function showNode(Node){
16 switch(navigator.family){
18 // Nav
4.x code fork...
19 var oTable = document.layers[
"span" + Node];
20 var oImg = document.layers[
"img" + Node];
23 // IE
4/
5 code fork...
24 var oTable = document.all[
"span" + Node];
25 var oImg = document.all[
"img" + Node];
28 // Standards Compliant code fork...
29 var oTable = document.getElementById(
"span" + Node);
30 var oImg = document.getElementById(
"img" + Node);
33 oImg.src = imgMinus.src;
34 oTable.style.display =
"block";
37 function hideNode(Node){
38 switch(navigator.family){
40 // Nav
4.x code fork...
41 var oTable = document.layers[
"span" + Node];
42 var oImg = document.layers[
"img" + Node];
45 // IE
4/
5 code fork...
46 var oTable = document.all[
"span" + Node];
47 var oImg = document.all[
"img" + Node];
50 // Standards Compliant code fork...
51 var oTable = document.getElementById(
"span" + Node);
52 var oImg = document.getElementById(
"img" + Node);
55 oImg.src = imgPlus.src;
56 oTable.style.display =
"none";
59 function nodeIsVisible(Node){
60 switch(navigator.family){
62 // Nav
4.x code fork...
63 var oTable = document.layers[
"span" + Node];
66 // IE
4/
5 code fork...
67 var oTable = document.all[
"span" + Node];
70 // Standards Compliant code fork...
71 var oTable = document.getElementById(
"span" + Node);
74 return (oTable && oTable.style.display ==
"block");
77 function toggleNodeVisibility(Node){
78 if (nodeIsVisible(Node)){
87 <div class=
"page-body">
88 <h2 class=
"class-name"><img src=
"../../media/images/Class_logo.png"
91 style=
"vertical-align: middle"> iCalProp
</h2>
93 <a name=
"sec-description"></a>
94 <div class=
"info-box">
95 <div class=
"info-box-title">Description
</div>
97 <span class=
"disabled">Description
</span> |
98 <a href=
"#sec-method-summary">Methods
</a> (
<a href=
"#sec-methods">details
</a>)
101 <div class=
"info-box-body">
102 <!-- ========== Info from phpDoc block ========= -->
103 <p class=
"short-description">A Class for representing properties within an iCalendar
</p>
105 Located in
<a class=
"field" href=
"_iCalendar.php.html">/iCalendar.php
</a> (line
<span class=
"field">57</span>)
117 <a name=
"sec-method-summary"></a>
118 <div class=
"info-box">
119 <div class=
"info-box-title">Method Summary
</span></div>
120 <div class=
"nav-bar">
121 <a href=
"#sec-description">Description
</a> |
122 <span class=
"disabled">Methods
</span> (
<a href=
"#sec-methods">details
</a>)
124 <div class=
"info-box-body">
125 <div class=
"method-summary">
127 <div class=
"method-definition">
128 <img src=
"../../media/images/Constructor.png" alt=
" "/>
129 <span class=
"method-result">iCalProp
</span>
130 <a href=
"#iCalProp" title=
"details" class=
"method-name">iCalProp
</a>
131 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$propstring
</span> =
<span class=
"var-default">null
</span>])
134 <div class=
"method-definition">
135 <img src=
"../../media/images/Method.png" alt=
" "/>
136 <span class=
"method-result">string
</span>
137 <a href=
"#GetParameterValue" title=
"details" class=
"method-name">GetParameterValue
</a>
138 (
<span class=
"var-type">string
</span> <span class=
"var-name">$name
</span>)
141 <div class=
"method-definition">
142 <img src=
"../../media/images/Method.png" alt=
" "/>
143 <span class=
"method-result">string
</span>
144 <a href=
"#Name" title=
"details" class=
"method-name">Name
</a>
145 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$newname
</span> =
<span class=
"var-default">null
</span>])
148 <div class=
"method-definition">
149 <img src=
"../../media/images/Method.png" alt=
" "/>
150 <span class=
"method-result">array
</span>
151 <a href=
"#Parameters" title=
"details" class=
"method-name">Parameters
</a>
152 ([
<span class=
"var-type">array
</span> <span class=
"var-name">$newparams
</span> =
<span class=
"var-default">null
</span>])
155 <div class=
"method-definition">
156 <img src=
"../../media/images/Method.png" alt=
" "/>
157 <span class=
"method-result">void
</span>
158 <a href=
"#ParseFrom" title=
"details" class=
"method-name">ParseFrom
</a>
159 (
<span class=
"var-type">string
</span> <span class=
"var-name">$propstring
</span>)
162 <div class=
"method-definition">
163 <img src=
"../../media/images/Method.png" alt=
" "/>
164 <span class=
"method-result">void
</span>
165 <a href=
"#Render" title=
"details" class=
"method-name">Render
</a>
169 <div class=
"method-definition">
170 <img src=
"../../media/images/Method.png" alt=
" "/>
171 <span class=
"method-result">void
</span>
172 <a href=
"#RenderParameters" title=
"details" class=
"method-name">RenderParameters
</a>
176 <div class=
"method-definition">
177 <img src=
"../../media/images/Method.png" alt=
" "/>
178 <span class=
"method-result">void
</span>
179 <a href=
"#SetParameterValue" title=
"details" class=
"method-name">SetParameterValue
</a>
180 (
<span class=
"var-type">string
</span> <span class=
"var-name">$name
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$value
</span>)
183 <div class=
"method-definition">
184 <img src=
"../../media/images/Method.png" alt=
" "/>
185 <span class=
"method-result">string
</span>
186 <a href=
"#TextMatch" title=
"details" class=
"method-name">TextMatch
</a>
187 (
<span class=
"var-type">string
</span> <span class=
"var-name">$search
</span>)
190 <div class=
"method-definition">
191 <img src=
"../../media/images/Method.png" alt=
" "/>
192 <span class=
"method-result">string
</span>
193 <a href=
"#Value" title=
"details" class=
"method-name">Value
</a>
194 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$newvalue
</span> =
<span class=
"var-default">null
</span>])
201 <a name=
"sec-methods"></a>
202 <div class=
"info-box">
203 <div class=
"info-box-title">Methods
</div>
204 <div class=
"nav-bar">
205 <a href=
"#sec-description">Description
</a> |
206 <a href=
"#sec-method-summary">Methods
</a> (
<span class=
"disabled">details
</span>)
209 <div class=
"info-box-body">
210 <A NAME='method_detail'
></A>
211 <a name=
"methodiCalProp" id=
"iCalProp"><!-- --></a>
214 <div class=
"method-header">
215 <img src=
"../../media/images/Constructor.png" />
216 <span class=
"method-title">Constructor iCalProp
</span> (line
<span class=
"line-number">100</span>)
219 <!-- ========== Info from phpDoc block ========= -->
220 <p class=
"short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().
</p>
222 <div class=
"method-signature">
223 <span class=
"method-result">iCalProp
</span>
224 <span class=
"method-name">
227 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$propstring
</span> =
<span class=
"var-default">null
</span>])
230 <ul class=
"parameters">
232 <span class=
"var-type">string
</span>
233 <span class=
"var-name">$propstring
</span><span class=
"var-description">: The string from the iCalendar which contains this property.
</span> </li>
238 <a name=
"methodGetParameterValue" id=
"GetParameterValue"><!-- --></a>
239 <div class=
"evenrow">
241 <div class=
"method-header">
242 <img src=
"../../media/images/Method.png" />
243 <span class=
"method-title">GetParameterValue
</span> (line
<span class=
"line-number">210</span>)
246 <!-- ========== Info from phpDoc block ========= -->
247 <p class=
"short-description">Get the value of a parameter
</p>
249 <li><span class=
"field">return:
</span> The value of the parameter
</li>
252 <div class=
"method-signature">
253 <span class=
"method-result">string
</span>
254 <span class=
"method-name">
257 (
<span class=
"var-type">string
</span> <span class=
"var-name">$name
</span>)
260 <ul class=
"parameters">
262 <span class=
"var-type">string
</span>
263 <span class=
"var-name">$name
</span><span class=
"var-description">: The name of the parameter to retrieve the value for
</span> </li>
268 <a name=
"methodName" id=
"Name"><!-- --></a>
271 <div class=
"method-header">
272 <img src=
"../../media/images/Method.png" />
273 <span class=
"method-title">Name
</span> (line
<span class=
"line-number">148</span>)
276 <!-- ========== Info from phpDoc block ========= -->
277 <p class=
"short-description">Get/Set name property
</p>
279 <li><span class=
"field">return:
</span> The name for the property.
</li>
282 <div class=
"method-signature">
283 <span class=
"method-result">string
</span>
284 <span class=
"method-name">
287 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$newname
</span> =
<span class=
"var-default">null
</span>])
290 <ul class=
"parameters">
292 <span class=
"var-type">string
</span>
293 <span class=
"var-name">$newname
</span><span class=
"var-description">: [optional] A new name for the property
</span> </li>
298 <a name=
"methodParameters" id=
"Parameters"><!-- --></a>
299 <div class=
"evenrow">
301 <div class=
"method-header">
302 <img src=
"../../media/images/Method.png" />
303 <span class=
"method-title">Parameters
</span> (line
<span class=
"line-number">181</span>)
306 <!-- ========== Info from phpDoc block ========= -->
307 <p class=
"short-description">Get/Set parameters in their entirety
</p>
309 <li><span class=
"field">return:
</span> The current array of parameters for the property.
</li>
312 <div class=
"method-signature">
313 <span class=
"method-result">array
</span>
314 <span class=
"method-name">
317 ([
<span class=
"var-type">array
</span> <span class=
"var-name">$newparams
</span> =
<span class=
"var-default">null
</span>])
320 <ul class=
"parameters">
322 <span class=
"var-type">array
</span>
323 <span class=
"var-name">$newparams
</span><span class=
"var-description">: An array of new parameter key/value pairs
</span> </li>
328 <a name=
"methodParseFrom" id=
"ParseFrom"><!-- --></a>
331 <div class=
"method-header">
332 <img src=
"../../media/images/Method.png" />
333 <span class=
"method-title">ParseFrom
</span> (line
<span class=
"line-number">119</span>)
336 <!-- ========== Info from phpDoc block ========= -->
337 <p class=
"short-description">The constructor parses the incoming string, which is formatted as per RFC2445 as a propname[;param1=pval1[; ... ]]:propvalue however we allow ourselves to assume that the RFC2445 content unescaping has already happened when iCalComponent::ParseFrom() called iCalComponent::UnwrapComponent().
</p>
339 <div class=
"method-signature">
340 <span class=
"method-result">void
</span>
341 <span class=
"method-name">
344 (
<span class=
"var-type">string
</span> <span class=
"var-name">$propstring
</span>)
347 <ul class=
"parameters">
349 <span class=
"var-type">string
</span>
350 <span class=
"var-name">$propstring
</span><span class=
"var-description">: The string from the iCalendar which contains this property.
</span> </li>
355 <a name=
"methodRender" id=
"Render"><!-- --></a>
356 <div class=
"evenrow">
358 <div class=
"method-header">
359 <img src=
"../../media/images/Method.png" />
360 <span class=
"method-title">Render
</span> (line
<span class=
"line-number">243</span>)
363 <!-- ========== Info from phpDoc block ========= -->
364 <p class=
"short-description">Render a suitably escaped RFC2445 content string.
</p>
366 <div class=
"method-signature">
367 <span class=
"method-result">void
</span>
368 <span class=
"method-name">
377 <a name=
"methodRenderParameters" id=
"RenderParameters"><!-- --></a>
380 <div class=
"method-header">
381 <img src=
"../../media/images/Method.png" />
382 <span class=
"method-title">RenderParameters
</span> (line
<span class=
"line-number">230</span>)
385 <!-- ========== Info from phpDoc block ========= -->
386 <p class=
"short-description">Render the set of parameters as key1=value1[;key2=value2[; ...]] with any colons or semicolons escaped.
</p>
388 <div class=
"method-signature">
389 <span class=
"method-result">void
</span>
390 <span class=
"method-name">
399 <a name=
"methodSetParameterValue" id=
"SetParameterValue"><!-- --></a>
400 <div class=
"evenrow">
402 <div class=
"method-header">
403 <img src=
"../../media/images/Method.png" />
404 <span class=
"method-title">SetParameterValue
</span> (line
<span class=
"line-number">221</span>)
407 <!-- ========== Info from phpDoc block ========= -->
408 <p class=
"short-description">Set the value of a parameter
</p>
410 <div class=
"method-signature">
411 <span class=
"method-result">void
</span>
412 <span class=
"method-name">
415 (
<span class=
"var-type">string
</span> <span class=
"var-name">$name
</span>,
<span class=
"var-type">string
</span> <span class=
"var-name">$value
</span>)
418 <ul class=
"parameters">
420 <span class=
"var-type">string
</span>
421 <span class=
"var-name">$name
</span><span class=
"var-description">: The name of the parameter to set the value for
</span> </li>
423 <span class=
"var-type">string
</span>
424 <span class=
"var-name">$value
</span><span class=
"var-description">: The value of the parameter
</span> </li>
429 <a name=
"methodTextMatch" id=
"TextMatch"><!-- --></a>
432 <div class=
"method-header">
433 <img src=
"../../media/images/Method.png" />
434 <span class=
"method-title">TextMatch
</span> (line
<span class=
"line-number">197</span>)
437 <!-- ========== Info from phpDoc block ========= -->
438 <p class=
"short-description">Test if our value contains a string
</p>
440 <li><span class=
"field">return:
</span> The name for the property.
</li>
443 <div class=
"method-signature">
444 <span class=
"method-result">string
</span>
445 <span class=
"method-name">
448 (
<span class=
"var-type">string
</span> <span class=
"var-name">$search
</span>)
451 <ul class=
"parameters">
453 <span class=
"var-type">string
</span>
454 <span class=
"var-name">$search
</span><span class=
"var-description">: The needle which we shall search the haystack for.
</span> </li>
459 <a name=
"methodValue" id=
"Value"><!-- --></a>
460 <div class=
"evenrow">
462 <div class=
"method-header">
463 <img src=
"../../media/images/Method.png" />
464 <span class=
"method-title">Value
</span> (line
<span class=
"line-number">165</span>)
467 <!-- ========== Info from phpDoc block ========= -->
468 <p class=
"short-description">Get/Set the content of the property
</p>
470 <li><span class=
"field">return:
</span> The value of the property.
</li>
473 <div class=
"method-signature">
474 <span class=
"method-result">string
</span>
475 <span class=
"method-name">
478 ([
<span class=
"var-type">string
</span> <span class=
"var-name">$newvalue
</span> =
<span class=
"var-default">null
</span>])
481 <ul class=
"parameters">
483 <span class=
"var-type">string
</span>
484 <span class=
"var-name">$newvalue
</span><span class=
"var-description">: [optional] A new value for the property
</span> </li>
494 <p class=
"notes" id=
"credit">
495 Documentation generated on Thu,
15 Apr
2010 20:
23:
05 +
1200 by
<a href=
"http://www.phpdoc.org" target=
"_blank">phpDocumentor
1.3.2</a>