Location: PHPKode > scripts > rsscalCreator > rsscalCreator-0.8.5/using.html
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN"
   "http://www.w3.org/TR/html4/frameset.dtd">
<html>
<head>
<title>rsscalCreator</title>
<meta name="author"      content="kigkonsult - Kjell-Inge Gustafsson" />
<meta name="copyright"   content="2006 kigkonsult" />
<meta name="keywords"    content="ical, rss, rsscal, calendar, calender, icalender, vcalender, rfc2445" />
<meta name="description" content="rsscalCreator" />
<style type="text/css">
* {
  BACKGROUND-COLOR: white;
  COLOR           : black;
  FONT-FAMILY     : "Lucida Grande","Lucida Sans Unicode", "Bitstream Vera Sans", Lucida, Arial, Geneva, Helvetica, sans-serif;
  FONT-SIZE       : small;
}
body {
  MARGIN          : 10px;
  WIDTH           : 600px;
}
a {
  FONT-SIZE       : inherit;
}
h1 {
  BACKGROUND-COLOR: silver;
  BORDER          : thin solid black;
  FONT-SIZE       : x-large;
  FONT-WEIGHT     : bold;
  DISPLAY         : block;
}
h2 {
  FONT-SIZE       : large;
}
h3 {
  FONT-SIZE       : medium;
  FONT-WEIGHT     : bold;
}
h4 {
  FONT-SIZE       : medium;
  TEXT-DECORATION : underline;
}
p {
  FONT-SIZE       : medium;
}
p.h6 {
  TEXT-DECORATION : underline;
}
table tr td {
  aBORDER          : 0;
  MARGIN          : 0;
  PADDING         : 0;
  VERTICAL-ALIGN  : top;
}
.center {
  TEXT-ALIGN      : center;
}
.comment {
  FONT-FAMILY     : monospace;
  FONT-SIZE       : large;
}
.header {
  BACKGROUND-COLOR: silver;
  BORDER          : thin solid black;
  FONT-SIZE       : xx-large;
  WIDTH           : 600px;
}
.right {
  TEXT-ALIGN      : right;
}
</style>
</head>
<body>
<a name="top"></a>
<div class="header">rsscalCreator</div>
<h2>Description:</h2>
rsscalCreator is a PHP class that implements the rsscal (RDF) and RSS (2.0) specification of iCal, <a class="mini" href="http://www.kigkonsult.se/iCalcreator/iCalDictionary/rfc2445.txt" title="http://www.kigkonsult.se/iCalcreator/iCalDictionary/rfc2445.txt" target="_blank">RFC2445</a>.
Only the calendar event component is implemented.
<br />

<a name="INDEX"></a><h1>Index</h1>
<a href="#INTRO">1. INTRO</a><br />
<a href="#Functions">2. METHODS</a><br />
<a href="#initiation_Methods">2.1 INITIATION METHODS</a><br />
<a href="#channel_management_Methods">2.2 CHANNEL MANAGEMENT METHODS</a><br />
<a href="#item_management_Methods">2.3 ITEM MANAGEMENT METHODS</a><br />
<a href="#image_management_Methods">2.4 IMAGE MANAGEMENT METHODS</a><br />
<a href="#textinput_management_Methods">2.5 TEXTINPUT MANAGEMENT METHODS</a><br />
<a href="#feed_management_Methods">2.6 FEED MANAGEMENT METHODS</a><br />
<a href="#file_management_Methods">2.7 FILE MANAGEMENT METHODS</a><br />
<a href="#Copyright_and_Licence">3. COPYRIGHT AND LICENSE</a><br />

<a name="INTRO"></a><h1>1. INTRO</h1>
<p>
Knowledge of calendar and
<a href="http://www.kigkonsult.se/dl.php?f=rfc2445" title="RFC2445" target="_blank">rfc2445 - Internet Calendaring and Scheduling Core Object Specification (iCalendar) - </a>
</a> is necessary!
</p>
<p>
RFC2445 in <b>text</b> format: <a href="http://www.kigkonsult.se/dl.php?f=rfc2445" title="RFC2445" target="_blank">www.kigkonsult.se/iCalcreator/iCalDictionary/rfc2445.txt</a>.
<br />
RFC2445 in <b>HTML</b> format: <a href="http://www.kigkonsult.se/iCalcreator/iCalDictionary/index.html" title="http://www.kigkonsult.se/iCalcreator/iCalDictionary/index.html" target="_blank">www.kigkonsult.se/iCalcreator/iCalDictionary/index.html</a>.
</p>
<p>
For information about RSS, see <a href="http://www.mnot.net/rss/tutorial/" target="_blank">RSS tutorial</a>.
<br />
For information about RDF specification, see <a href="http://web.resource.org/rss/1.0/spec" target="_blank">http://web.resource.org/rss/1.0/spec</a>.
<br /><br />
For information about RSS 2.0, see <a href="http://www.rssboard.org/rss-2-0" target="_blank">RSS 2.0 Specification</a>.
</p>
<table>
<tr><td colspan="4">The RDF model describe four elements with subelements;
<tr><td width="125"><b>element</b><td width="125"><td width="125"><b>subelements</b><td width="100">1.0<td>2.0
<tr><td>channel<td class="comment">required<td>title<td class="comment">required<td class="comment">required
<tr><td><td><td>link<td class="comment">required<td class="comment">required
<tr><td><td><td>description<td class="comment">required<td class="comment">required

<tr><td><td><td>language<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>copyright<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>managingEditor<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>webMaster<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>pubDate<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>lastBuildDate<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>category<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>generator<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>docs<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>cloud<td class="comment">n/a<td class="comment">optional
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;domain&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;port&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;path&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;registerProcedure&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;protocol&quot;
<tr><td><td><td>ttl<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>rating<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>skipHours<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>skipDays<td class="comment">n/a<td class="comment">optional
<tr><td colspan="5">&nbsp;

<tr><td>image<td class="comment">optional<td>title<td class="comment">required<td class="comment">required
<tr><td><td><td>url<td class="comment">required<td class="comment">required
<tr><td><td><td>link<td class="comment">required<td class="comment">required
<tr><td><td><td>width<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>height<td class="comment">n/a<td class="comment">optional
<tr><td colspan="5">&nbsp;

<tr><td>item<td class="comment">one or more<br />ocurrences<td>title<td class="comment">required<td class="comment">title or description required
<tr><td><td><td>link<td class="comment">required<td class="comment">optional
<tr><td><td><td>description<td class="comment">optional<td class="comment">title or description required
<tr><td><td><td>author<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>category<td class="comment">n/a<td class="comment">optional
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">opt. attribute &quot;domain&quot; value=true/false
<tr><td><td><td>comments<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>enclosure<td class="comment">n/a<td class="comment">optional
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;url&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;length&quot;
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;type&quot;
<tr><td><td><td>guid<td class="comment">n/a<td class="comment">optional
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">opt. attribute &quot;isPermaLink&quot; value : true (default) / false
<tr><td><td><td>pubDate<td class="comment">n/a<td class="comment">optional
<tr><td><td><td>source<td class="comment">n/a<td class="comment">optional
<tr><td colspan="2">&nbsp;<td colspan="3" class="comment">req. attribute &quot;url&quot;
<tr><td colspan="5">&nbsp;

<tr><td>textinput<td class="comment">optional<td>title<td class="comment">required<td class="comment">required
<tr><td><td><td>description<td class="comment">required<td class="comment">required
<tr><td><td><td>name<td class="comment">required<td class="comment">required
<tr><td><td><td>link<td class="comment">required<td class="comment">required
</table>
<p>
The <a href="http://purl.org/dc/elements/1.1/" target="_blank">'Dublin Core' Namespace Declaration</a>
(explanation at <a href="http://dublincore.org/documents/dces/" target="_blank">http://dublincore.org/documents/dces/</a> allows subelements (all optional);
</p>
<table>
<tr><td width="125"><b>element</b><td width="125"><td width="125"><b>subelements</b><td width="100">1.0<td>2.0
<tr><td colspan="2">channel / *item / image? / textinput?<td>dc:title<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:creator<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:subject<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:description<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:publisher<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:contributor<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:date<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:type<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:format<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:identifier<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:source<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:language<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:relation<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:coverage<td class="comment">optional<td class="comment">optional
<tr><td><td><td>dc:rights<td class="comment">optional<td class="comment">optional
</table>
<p>
The <a href="http://purl.org/rss/1.0/modules/event/" target="_blank">EVENT Namespace</a> Declaration
describes event (optional) subelements for ITEM elements:
</p>
<table>
<tr><td width="125"><b>element</b><td width="125"><td width="125"><b>subelements</b><td width="100">1.0<td>2.0
<tr><td colspan="2">*item<td>ev:startdate<td class="comment">optional<td class="comment">optional
<tr><td><td><td>ev:enddate<td class="comment">optional<td class="comment">optional
<tr><td><td><td>ev:location<td class="comment">optional<td class="comment">optional
<tr><td><td><td>ev:organizer<td class="comment">optional<td class="comment">optional
<tr><td><td><td>ev:type<td class="comment">optional<td class="comment">optional
</table>
<a href="#INDEX">[index]</a>
<a name="INTRO"></a><h1>2. Usage</h1>
<p>
A simple demo of using rsscalCreator:
</p>
<p>&lt;?php</p>
<p>/* ensure the right path to class file */<br />
require_once './rsscalCreator.class.php';
</p>
<p>/* set all required elements (title, link, description) */<br />
$feed = new rsscalCreator( $title, $link, $desc );
</p>
<p>/* use a while/for/foreach-loop to set the items */<br />
foreach( $databaseQueryResult as $data ) {<br />
&nbsp;&nbsp;/* set items subelements, title (required), link (required), description (optional) */<br />
&nbsp;&nbsp;$item = new rsscalItem( $data['title'], $data['link'], $data['desc'] );<br />
&nbsp;&nbsp;/* add optional item subelement, one by one (element name, element content) to item */<br />
&nbsp;&nbsp;$item->addElement( 'ev:type', $data['type]' );<br />
&nbsp;&nbsp;$item->addElement( 'ev:organizer', $data['organizer'] );<br />
&nbsp;&nbsp;$item->addElement( 'ev:location', $data['location'] );<br />
&nbsp;&nbsp;$item->addElement( 'ev:startdate', $data['startdate'] );<br />
&nbsp;&nbsp;$item->addElement( 'ev:enddate', $data['enddate'] );<br />
&nbsp;&nbsp;$item->addElement( 'dc:subject', $data['subject'] );<br />
&nbsp;&nbsp;/* add item to feed */<br />
&nbsp;&nbsp;$feed->addItem( $item );<br />
}
</p>
<p>/* create and redirect RSS feed to browser */<br />
$feed->returnRSS();
</p>
<p>?&gt;</p>
<p>Se more more samples at the samples*.php files.</p>
<p>
Don't forget to test the feed at <a href="http://feedvalidator.org/" title="FEED Validator for Atom and RSS" target="_blank">feedvalidator.org</a>
</p>
<p>Please use icons and script in images directory!</p>
<a href="#INDEX">[index]</a>
<a name="Functions"></a><h1>2. METHODS</h1>

<a name="initiation_Methods"></a><h2>2.1 INITIATION METHODS</h2>

<h3>rsscalCreator</h3>
<p>Class : rsscalCreator</p>
<p>constructor for rsscalCreator object.</p>
<p class="h6">format:<br />
<span class=comment>
rsscalCreator( string title, string link, string description [, string version ] )</span>&nbsp;(preferred)</p>
<p class="comment">rsscalCreator()</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required
</span></p>
<a href="#INDEX">[index]</a>

<a name="channel_management_Methods"></a><h2>2.2 CHANNEL MANAGEMENT METHODS</h2>

<h3>rsscalChannel</h3>
<p>Class : rsscalChannel</p>
<p>Constructor for rsscalChannel object.</p>
<p class="h6">format:<br />
<span class="comment">
rsscalChannel( string title, string link, string desc )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$channel = new rsscalChannel( $title, $link, $desc ); // required, required, required<br />
$c->setChannel( $channel );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>addElement</h3>
<p>Class : rsscalChannel</p>
<p>Add new (optional) element.</p>
<p class="h6">format:<br />
<span class="comment">
addElement( string elementName, string elementContent [, array attributes ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$channel = new rsscalChannel( $title, $link, $desc ); // required, required, required<br />
$channel->addElement( 'dc:date', $date ); // optional element, name required, content required<br />
$channel->addElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
$c->setChannel( $channel );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannel</h3>
<p>Class : rsscalCreator</p>
<p>Set channel element for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setChannel( object channelElement )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$channel = new rsscalChannel( $title, $link, $desc ); // required, required, required<br />
$channel->addElement( 'dc:date', $date ); // optional element, name required, content required<br />
$channel->addElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
$c->setChannel( $channel );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannelAttribute</h3>
<p>Class : rsscalCreator</p>
<p>Set channel attribute for rsscalCreator instans.<br />
Link content is taken if attribute is not set.</p>
<p class="h6">format:<br />
<span class="comment">
setChannelAttribute( string attribute )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$c->setChannelAttribute( $attribute );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannelDescription</h3>
<p>Class : rsscalCreator</p>
<p>Set channel element description for rsscalCreator instans.<br />
Overwrites any previous set description.</p>
<p class="h6">format:<br />
<span class="comment">
setChannelDescription( string description )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$c->setChannelDescription( $description );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannelElement</h3>
<p>Class : rsscalCreator</p>
<p>Set channel element for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setChannelElement( string elementName, string elementContent [, array elementAttribute ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
$c->setChannelElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannelLink</h3>
<p>Class : rsscalCreator</p>
<p>Set channel element link for rsscalCreator instans.<br />
Overwrites any previous set link.</p>
<p class="h6">format:<br />
<span class="comment">
setChannelLink( string link )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$c->setChannelLink( $link );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setChannelTitle</h3>
<p>Class : rsscalCreator</p>
<p>Set channel element title for rsscalCreator instans.<br />
Overwrites any previous set title.</p>
<p class="h6">format:<br />
<span class="comment">
setChannelTitle( string title )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator();<br />
.. .<br />
$c->setChannelTitle( $title );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setImage</h3>
<p>Class : rsscalCreator</p>
<p>Set channel image for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setImage( object imageElement )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
$image = new rsscalImage( $imageTitle, $imageUrl, $imageLink ); // required, required, required<br />
$c->setImage( $image );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setTextinput</h3>
<p>Class : rsscalCreator</p>
<p>Set channel textinput for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setTextinput( object textinputElement )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
$textinput = new rsscalTextinput( $textinputTitle, $textinputDescription, $textinputName, $textinputLink ); // required, required, required, required<br />
$c->setTextinput( $textinput );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<a name="item_management_Methods"></a><h2>2.3 ITEM MANAGEMENT METHODS</h2>

<h3>rsscalItem</h3>
<p>Class : rsscalItem</p>
<p>Constructor for rsscalItem object.</p>
<p class="h6">format:<br />
<span class="comment">
rsscalItem( string title, string link [, string description ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$item = new rsscalItem( $itemTitle, $itemLink, $itemDescription ); // required, required, optional<br />
$c->addItem( $item );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>addElement</h3>
<p>Class : rsscalItem</p>
<p>Add new (optional) element.</p>
<p class="h6">format:<br />
<span class="comment">
addElement( string elementName, string elementContent [, array attributes ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$item = new rsscalItem( $itemTitle, $itemLink, $itemDescription ); // required, required, optional<br />
$item->addElement( 'dc:date', $date ); // optional element, name required, content required<br />
$item->addElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
$c->addItem( $item );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>addItem</h3>
<p>Class : rsscalCreator</p>
<p>Add item element.</p>
<p class="h6">format:<br />
<span class="comment">
addItem( object rsscalItem )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$item = new rsscalItem( $itemTitle, $itemLink, $itemDescription ); // required, required, optional<br />
$item->addElement( 'dc:date', $date ); // optional element, name required, content required<br />
$item->addElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
$c->addItem( $item );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<a name="image_management_Methods"></a><h2>2.4 IMAGE MANAGEMENT METHODS</h2>

<h3>rsscalImage</h3>
<p>Class : rsscalImage</p>
<p>Constructor for rsscalImahe object.</p>
<p class="h6">format:<br />
<span class="comment">
rsscalImage( string title, string url, string link )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$image = new rsscalImage( $imageTitle, $imageUrl, $imageLink ); // required, required, required<br />
$c->setImage( $image );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>addElement</h3>
<p>Class : rsscalImage</p>
<p>Add new (optional) element.</p>
<p class="h6">format:<br />
<span class="comment">
addElement( string elementName, string elementContent [, array attributes ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$image = new rsscalImage( $imageTitle, $imageUrl, $imageLink ); // required, required, required<br />
$image->addElement( 'dc:date', $date ); // optional element, name required, content required<br />
$image->addElement( 'dc:rights', $copy ); // optional element, name required, content required<br />
$c->setImage( $image );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setImage</h3>
<p>Class : rsscalCreator</p>
<p>Set channel image for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setImage( object imageElement )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
$image = new rsscalImage( $imageTitle, $imageUrl, $imageLink ); // required, required, required<br />
$c->setImage( $image );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<a name="textinput_management_Methods"></a><h2>2.5 TEXTINPUT MANAGEMENT METHODS</h2>

<h3>rsscalTextinput</h3>
<p>Class : rsscalTextinput</p>
<p>Constructor for rsscalTextinput object.</p>
<p class="h6">format:<br />
<span class="comment">
rsscalTextinput( string title, string description, string name, string link )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$textinput = new rsscalTextinput( $textinputTitle, $textinputDescription, $textinputName, $textinputLink );
 // required, required, required, required<br />
$c->setTextinput( $textinput );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>addElement</h3>
<p>Class : rsscalTextinput</p>
<p>Add new (optional) element.</p>
<p class="h6">format:<br />
<span class="comment">
addElement( string elementName, string elementContent [, array attributes ] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc ); // required, required, required<br />
.. .<br />
$textinput = new rsscalTextinput( $textinputTitle, $textinputDescription, $textinputName, $textinputLink ); // required, required, required, required<br />
$textinput->addElement( 'dc:date', $date ); // optional element<br />
$textinput->addElement( 'dc:language', $lang ); // optional element<br />
$c->setTextinput( $textinput );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<h3>setTextinput</h3>
<p>Class : rsscalCreator</p>
<p>Set channel textinput for rsscalCreator instans.</p>
<p class="h6">format:<br />
<span class="comment">
setTextinput( object textinputElement )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
$textinput = new rsscalTextinput( $textinputTitle, $textinputDescription, $textinputName, $textinputLink ); // required, required, required, required<br />
$c->setTextinput( $textinput );<br />
.. .</span></p>
<a href="#INDEX">[index]</a>

<a name="feed_management_Methods"></a><h2>2.6 FEED MANAGEMENT METHODS</h2>

<h3>createRSS</h3>
<p>Class : rsscalCreator</p>
<p>Creates formatted output for rsscalCreator instance<br />
Returns string, feed content</p>
<p class="h6">format:<br />
<span class="comment">
createRSS( [version] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
.. .<br />
$string = $c->createRSS();<br />
echo $string;                                                   // display created feed content, testing?
</p>
<a href="#INDEX">[index]</a>

<h3>returnRSS</h3>
<p>Class : rsscalCreator</p>
<p>a HTTP redirect header is sent with created and saved file.</p>
<p class="h6">format:<br />
<span class="comment">
returnRSS( [string directory [, string filename [, string delimiter ]]] )</span></p>
<p class="h6">example:<br />
<span class="comment">
$c = new rsscalCreator( $title, $link, $desc );                 // required, required, required<br />
.. .<br />
.. .<br />
$c->returnRSS( $cacheFolder );<br />
</p>
<a href="#INDEX">[index]</a>

<h3>useCachedRSS</h3>
<p>Class : rsscalCreator</p>
<p>if recent version of feed file exists (default 3600 sec), an HTTP redirect header is sent.</p>
<p class="h6">format:<br />
<span class="comment">
useCachedRSS( string directory, string filename, string delimiter [, int timeout ] )</span></p>
<a href="#INDEX">[index]</a>

<a name="file_management_Methods"></a><h2>2.7 FILE MANAGEMENT METHODS</h2>

<h3>getFilename</h3>
<p>Class : rsscalCreator</p>
<p>Get feed file name.<br />
Returns array : directory, filename, filesize.</p>
<p class="h6">format:<br />
<span class="comment">
setFilename( [string directory [, string filename [, string delimiter ]]] )</span></p>
<a href="#INDEX">[index]</a>

<h3>saveRSS</h3>
<p>Class : rsscalCreator</p>
<p>Create and save edited rsscalCreator content to file<br />
Returns FALSE (file not writeable) /array : directory, filename, filesize</p>
<p class="comment">saveRSS( [string directory [, string filename [, string delimiter ]]] )</p>
<a href="#INDEX">[index]</a>

<h3>setFilename</h3>
<p>Class : rsscalCreator</p>
<p>Set feed file name (default date( 'YmdHis' ).'.rss') (create empty file ).<br />
Returns FALSE if not writable else TRUE.</p>
<p class="h6">format:<br />
<span class="comment">
setFilename( [string directory [, string filename [, string delimiter ]]] )</span></p>
<a href="#INDEX">[index]</a>

<a name="Copyright_and_Licence"></a><h1>3. COPYRIGHT AND LICENSE</h1>

<h2>Copyright</h2>
rsscalCreator class <br />
originally (c) Kjell-Inge Gustafsson<br />
www.kigkonsult.se/rsscalCreator/index.php<br />
hide@address.com<br />

<h2>License</h2>
<p>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 2.1 of the License, or (at your option) any later version.
</p>
<p>
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
Lesser General Public License for more details.
</p>
<p>
You should have received a copy of the GNU Lesser General Public
License along with this library; if not, write to the Free Software
Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307 USA
or download it <a href="http://www.kigkonsult.se/dl.php?f=LGPL" target="_blank">here</a>.
</p>
<a href="#INDEX">[index]</a>
</body>
</html>
Return current item: rsscalCreator