nik/davical
1
0
Fork 0
mirror of https://gitlab.com/davical-project/davical.git synced 2026-03-02 06:14:17 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity
davical/docs/api/davical/AtomFeed.html
Andrew McMillan f62d05e882 Release 0.9.9.4
2010-12-28 02:20:18 +13:00

525 lines
19 KiB
HTML
Raw Blame History

<?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 AtomFeed</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"><img src="../media/images/Class_logo.png"
alt=" Class"
title=" Class"
style="vertical-align: middle"> AtomFeed</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-method-summary">Methods</a> (<a href="#sec-methods">details</a>)
</div>
<div class="info-box-body">
<!-- ========== Info from phpDoc block ========= -->
<p class="notes">
Located in <a class="field" href="_inc---AtomFeed.php.html">/inc/AtomFeed.php</a> (line <span class="field">139</span>)
</p>
<pre>XMLDocument
|
--AtomFeed</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> |
<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">
<img src="../media/images/Constructor.png" alt=" "/>
<span class="method-result">AtomFeed</span>
<a href="#__construct" title="details" class="method-name">__construct</a>
()
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#addAuthor" title="details" class="method-name">addAuthor</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#addEntry" title="details" class="method-name">addEntry</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_entry</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#addNode" title="details" class="method-name">addNode</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$in_tag</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#createEntry" title="details" class="method-name">createEntry</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$published</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$updated</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#export" title="details" class="method-name">export</a>
([<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'atom'</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setDateModified" title="details" class="method-name">setDateModified</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$epoch</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setDescription" title="details" class="method-name">setDescription</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">XMLElement</span>
<a href="#setFeedLink" title="details" class="method-name">setFeedLink</a>
(<span class="var-type">uri</span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setId" title="details" class="method-name">setId</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>)
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setLink" title="details" class="method-name">setLink</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">&quot;text/calendar&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$rel</span> = <span class="var-default">'alternate'</span>])
</div>
<div class="method-definition">
<img src="../media/images/Method.png" alt=" "/>
<span class="method-result">void</span>
<a href="#setTitle" title="details" class="method-name">setTitle</a>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
</div>
</div>
</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-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">
<img src="../media/images/Constructor.png" />
<span class="method-title">Constructor __construct</span> (line <span class="line-number">146</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<ul class="tags">
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">AtomFeed</span>
<span class="method-name">
__construct
</span>
()
</div>
</div>
<a name="methodaddAuthor" id="addAuthor"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">addAuthor</span> (line <span class="line-number">201</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
addAuthor
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_value</span> </li>
</ul>
</div>
<a name="methodaddEntry" id="addEntry"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">addEntry</span> (line <span class="line-number">224</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
addEntry
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_entry</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_entry</span> </li>
</ul>
</div>
<a name="methodaddNode" id="addNode"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">addNode</span> (line <span class="line-number">217</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
addNode
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$in_tag</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$content</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$attributes</span> = <span class="var-default">false</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$xmlns</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$in_tag</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$content</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$attributes</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$xmlns</span> </li>
</ul>
</div>
<a name="methodcreateEntry" id="createEntry"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">createEntry</span> (line <span class="line-number">229</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
createEntry
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$id</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$title</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$published</span> = <span class="var-default">null</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$updated</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$id</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$title</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$published</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$updated</span> </li>
</ul>
</div>
<a name="methodexport" id="export"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">export</span> (line <span class="line-number">233</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
export
</span>
([<span class="var-type"></span>&nbsp;<span class="var-name">$format</span> = <span class="var-default">'atom'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$format</span> </li>
</ul>
</div>
<a name="methodsetDateModified" id="setDateModified"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setDateModified</span> (line <span class="line-number">179</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
setDateModified
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$epoch</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$epoch</span> </li>
</ul>
</div>
<a name="methodsetDescription" id="setDescription"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setDescription</span> (line <span class="line-number">213</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
setDescription
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_value</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
</ul>
</div>
<a name="methodsetFeedLink" id="setFeedLink"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setFeedLink</span> (line <span class="line-number">196</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<p class="short-description">Sets the feed link (rel=self), ignoring the parameter which is for compatibility with the Zend library API, although we use this for the Id, whereas they use the first link that is set.</p>
<ul class="tags">
<li><span class="field">return:</span> the node that was added.</li>
<li><span class="field">access:</span> public</li>
</ul>
<div class="method-signature">
<span class="method-result">XMLElement</span>
<span class="method-name">
setFeedLink
</span>
(<span class="var-type">uri</span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">null</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type">uri</span>
<span class="var-name">$new_value</span><span class="var-description">: The link target</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
</ul>
</div>
<a name="methodsetId" id="setId"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setId</span> (line <span class="line-number">169</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
setId
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>)
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_value</span> </li>
</ul>
</div>
<a name="methodsetLink" id="setLink"><!-- --></a>
<div class="evenrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setLink</span> (line <span class="line-number">184</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
setLink
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">&quot;text/calendar&quot;</span>], [<span class="var-type"></span>&nbsp;<span class="var-name">$rel</span> = <span class="var-default">'alternate'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_value</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$rel</span> </li>
</ul>
</div>
<a name="methodsetTitle" id="setTitle"><!-- --></a>
<div class="oddrow">
<div class="method-header">
<img src="../media/images/Method.png" />
<span class="method-title">setTitle</span> (line <span class="line-number">174</span>)
</div>
<!-- ========== Info from phpDoc block ========= -->
<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">
setTitle
</span>
(<span class="var-type"></span>&nbsp;<span class="var-name">$new_value</span>, [<span class="var-type"></span>&nbsp;<span class="var-name">$type</span> = <span class="var-default">'text'</span>])
</div>
<ul class="parameters">
<li>
<span class="var-type"></span>
<span class="var-name">$new_value</span> </li>
<li>
<span class="var-type"></span>
<span class="var-name">$type</span> </li>
</ul>
</div>
</div>
</div>
<p class="notes" id="credit">
Documentation generated on Tue, 28 Dec 2010 02:16:02 +1300 by <a href="http://www.phpdoc.org" target="_blank">phpDocumentor 1.4.3</a>
</p>
</div></body>
</html>
Reference in New Issue View Git Blame Copy Permalink