<?xml version="1.0" encoding="iso-8859-1"?>
<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<!-- template designed by Marco Von Ballmoos -->
<title>Docs For Class PhpiCalLib_iCalendar</title>
<link rel="stylesheet" href="../media/stylesheet.css" />
<meta http-equiv='Content-Type' content='text/html; charset=iso-8859-1'/>
</head>
<body>
<div class="page-body">
<h2 class="class-name">Class PhpiCalLib_iCalendar</h2>
<a name="sec-description"></a>
<div class="info-box">
<div class="info-box-title">Description</div>
<div class="nav-bar">
<span class="disabled">Description</span> |
<a href="#sec-vars">Vars</a>
| <a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">The top level class of PhpiCalLib, representing the contents of an iCalendar file</p>
<ul class="tags">
<li><span class="field">version:</span> 1.0</li>
</ul>
<p class="notes">
Located in <a class="field" href="_icalendar.php.html">/icalendar.php</a> (line <span class="field">35</span>)
</p>
<pre><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a>
|
--PhpiCalLib_iCalendar</pre>
</div>
</div>
<a name="sec-method-summary"></a>
<div class="info-box">
<div class="info-box-title">Method Summary</span></div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
|
<span class="disabled">Methods</span> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<div class="method-summary">
<div class="method-definition">
<span class="method-result">PhpiCalLib_iCalendar</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#AddComponent" title="details" class="method-name">AddComponent</a>
(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span> <span class="var-name">$Component</span>)
</div>
<div class="method-definition">
<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span>
<a href="#CreateComponent" title="details" class="method-name">CreateComponent</a>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#FromFile" title="details" class="method-name">FromFile</a>
(<span class="var-type">string</span> <span class="var-name">$FileName</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#FromString" title="details" class="method-name">FromString</a>
(<span class="var-type"></span> <span class="var-name">$iCalObjectString</span>, <span class="var-type">string</span> <span class="var-name">$Text</span>)
</div>
<div class="method-definition">
<span class="method-result">array</span>
<a href="#GetComponents" title="details" class="method-name">GetComponents</a>
([<span class="var-type">integer</span> <span class="var-name">$Type</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$Name</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#ParseiCalBody" title="details" class="method-name">ParseiCalBody</a>
(<span class="var-type">array(contentline)</span> <span class="var-name">$aContentLines</span>)
</div>
<div class="method-definition">
<span class="method-result">void</span>
<a href="#ToFile" title="details" class="method-name">ToFile</a>
(<span class="var-type">string</span> <span class="var-name">$FileName</span>)
</div>
<div class="method-definition">
<span class="method-result">A</span>
<a href="#ToString" title="details" class="method-name">ToString</a>
()
</div>
</div>
</div>
</div>
<a name="sec-vars"></a>
<div class="info-box">
<div class="info-box-title">Variables</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-var-summary">Vars</a> (<span class="disabled">details</span>)
|
<a href="#sec-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<h4>Inherited Variables</h4>
<A NAME='inherited_vars'><!-- --></A>
<p>Inherited from <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span></p>
<blockquote>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#var$aContentLines">PhpiCalLib_Component::$aContentLines</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#var$aPermittedProperties">PhpiCalLib_Component::$aPermittedProperties</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#var$Name">PhpiCalLib_Component::$Name</a></span><br>
</span>
<span class="var-title">
<span class="var-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#var$Type">PhpiCalLib_Component::$Type</a></span><br>
</span>
</blockquote>
</div>
</div>
<a name="sec-methods"></a>
<div class="info-box">
<div class="info-box-title">Methods</div>
<div class="nav-bar">
<a href="#sec-description">Description</a> |
<a href="#sec-vars">Vars</a>
<a href="#sec-method-summary">Methods</a> (<span class="disabled">details</span>)
</div>
<div class="info-box-body">
<A NAME='method_detail'></A>
<a name="method__construct" id="__construct"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">Constructor __construct</span> (line <span class="line-number">101</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Consturctor</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">PhpiCalLib_iCalendar</span>
<span class="method-name">
__construct
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PhpiCalLib/PhpiCalLib_Component.html#method__construct">PhpiCalLib_Component::__construct()</a></dt>
<dd>Constructor</dd>
</dl>
</div>
<a name="methodAddComponent" id="AddComponent"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">AddComponent</span> (line <span class="line-number">402</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Add a component to the collection in this calendar</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
AddComponent
</span>
(<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span> <span class="var-name">$Component</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span>
<span class="var-name">$Component</span> </li>
</ul>
</div>
<a name="methodCreateComponent" id="CreateComponent"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">CreateComponent</span> (line <span class="line-number">164</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Overridden to create the right kind of component</p>
<ul class="tags">
<li><span class="field">return:</span> derived class</li>
<li><span class="field">access:</span> protected</li>
</ul>
<div class="method-signature">
<span class="method-result"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span>
<span class="method-name">
CreateComponent
</span>
(<span class="var-type">string</span> <span class="var-name">$Name</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Name</span><span class="var-description">: The name of the component</span> </li>
</ul>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodCreateComponent">PhpiCalLib_Component::CreateComponent()</a></dt>
<dd>Create a new Component object</dd>
</dl>
</div>
<a name="methodFromFile" id="FromFile"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">FromFile</span> (line <span class="line-number">118</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse an iCalendar file from a file on disk</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FromFile
</span>
(<span class="var-type">string</span> <span class="var-name">$FileName</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$FileName</span> </li>
</ul>
</div>
<a name="methodFromString" id="FromString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">FromString</span> (line <span class="line-number">131</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse an iCalendar file from a string</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
FromString
</span>
(<span class="var-type"></span> <span class="var-name">$iCalObjectString</span>, <span class="var-type">string</span> <span class="var-name">$Text</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$Text</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$iCalObjectString</span> </li>
</ul>
</div>
<a name="methodGetComponents" id="GetComponents"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">GetComponents</span> (line <span class="line-number">419</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Access all the components of the given type</p>
<ul class="tags">
<li><span class="field">return:</span> A collection of PHPICALLIB_COMPONENT objects</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">array</span>
<span class="method-name">
GetComponents
</span>
([<span class="var-type">integer</span> <span class="var-name">$Type</span> = <span class="var-default">null</span>], [<span class="var-type">string</span> <span class="var-name">$Name</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">integer</span>
<span class="var-name">$Type</span><span class="var-description">: One of the PHPICALLIB_COMPONENT_* types, or null to return all components.</span> </li>
<li>
<span class="var-type">string</span>
<span class="var-name">$Name</span><span class="var-description">: The name of the component to match, or null to match just by type</span> </li>
</ul>
</div>
<a name="methodParseiCalBody" id="ParseiCalBody"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ParseiCalBody</span> (line <span class="line-number">199</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse an iCalendar object from a set of contentlines that represent an icalbody</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ParseiCalBody
</span>
(<span class="var-type">array(contentline)</span> <span class="var-name">$aContentLines</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">array(contentline)</span>
<span class="var-name">$aContentLines</span><span class="var-description">: An array of content lines that represent the iCalendar</span> </li>
</ul>
</div>
<a name="methodToFile" id="ToFile"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<span class="method-title">ToFile</span> (line <span class="line-number">334</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Parse an iCalendar file from a file on disk</p>
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">void</span>
<span class="method-name">
ToFile
</span>
(<span class="var-type">string</span> <span class="var-name">$FileName</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type">string</span>
<span class="var-name">$FileName</span> </li>
</ul>
</div>
<a name="methodToString" id="ToString"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<span class="method-title">ToString</span> (line <span class="line-number">348</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Dump the object to a string</p>
<ul class="tags">
<li><span class="field">return:</span> string representation in the default code page</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">A</span>
<span class="method-name">
ToString
</span>
()
</div>
<hr class="separator" />
<div class="notes">Redefinition of:</div>
<dl>
<dt><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodToString">PhpiCalLib_Component::ToString()</a></dt>
<dd>Dump the parameter to an array of unfolded content lines</dd>
</dl>
</div>
<h4>Inherited Methods</h4>
<a name='inherited_methods'><!-- --></a>
<!-- =========== Summary =========== -->
<p>Inherited From <span class="classname"><a href="../PhpiCalLib/PhpiCalLib_Component.html">PhpiCalLib_Component</a></span></p>
<blockquote>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#method__construct">PhpiCalLib_Component::__construct()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodAddProperty">PhpiCalLib_Component::AddProperty()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodAddPropertyPermitted">PhpiCalLib_Component::AddPropertyPermitted()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodCreate">PhpiCalLib_Component::Create()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodCreateComponent">PhpiCalLib_Component::CreateComponent()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodGetName">PhpiCalLib_Component::GetName()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodGetProperties">PhpiCalLib_Component::GetProperties()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodGetProperty">PhpiCalLib_Component::GetProperty()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodGetType">PhpiCalLib_Component::GetType()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodRemoveProperty">PhpiCalLib_Component::RemoveProperty()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodRemovePropertyPermitted">PhpiCalLib_Component::RemovePropertyPermitted()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodSetName">PhpiCalLib_Component::SetName()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodSetProperties">PhpiCalLib_Component::SetProperties()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodSetProperty">PhpiCalLib_Component::SetProperty()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodSetPropertyPermitted">PhpiCalLib_Component::SetPropertyPermitted()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodSetType">PhpiCalLib_Component::SetType()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodToComponentType">PhpiCalLib_Component::ToComponentType()</a></span><br>
<span class="method-name"><a href="../PhpiCalLib/PhpiCalLib_Component.html#methodToString">PhpiCalLib_Component::ToString()</a></span><br>
</blockquote>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 01 Apr 2008 01:07:23 +0100 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.0</a>
</p>
</div></body>
</html>