API Documentation

Feed/Writer/Deleted.php

Zend Framework

LICENSE

This source file is subject to the new BSD license that is bundled with this package in the file LICENSE.txt. It is also available through the world-wide-web at this URL: http://framework.zend.com/license/new-bsd If you did not receive a copy of the license and are unable to obtain it through the world-wide-web, please send an email to license@zend.com so we can send you a copy immediately.

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Writer  
version
$Id: Deleted.php 23775 2011-03-01 17:25:24Z ralph $  

\Zend_Feed_Writer_Deleted

category
Zend  
copyright
Copyright (c) 2005-2011 Zend Technologies USA Inc. (http://www.zend.com)  
license
New BSD License  
package
Zend_Feed_Writer  

Properties

Propertyprotectedarray  $_data= 'array'

Internal array containing all data associated with this entry or item.

Default valuearrayDetails
Type
array
Propertyprotectedstring  $_type= 'null'

Holds the value "atom" or "rss" depending on the feed type set when when last exported.

Default valuenullDetails
Type
string

Methods

methodpublicgetBy( ) : void

methodpublicgetComment( ) : void

methodpublicgetEncoding( ) : string|null

Get the feed character encoding

Returns
Type Description
stringnull
methodpublicgetReference( ) : void

methodpublicgetType( ) : string

Retrieve the current or last feed type exported.

Returns
Type Description
string Value will be "rss" or "atom"
methodpublicgetWhen( ) : void

methodpublicremove( string $name ) : void

Unset a specific data point

Parameters
Name Type Description
$name string
methodpublicsetBy(  $by ) : void

Parameters
Name Type Description
$by
methodpublicsetComment(  $comment ) : void

Parameters
Name Type Description
$comment
methodpublicsetEncoding(  $encoding ) : string|null

Set the feed character encoding

Parameters
Name Type Description
$encoding
Returns
Type Description
stringnull
methodpublicsetReference(  $reference ) : void

Parameters
Name Type Description
$reference
methodpublicsetType( string $type ) : void

Set the current feed type being exported to "rss" or "atom". This allows other objects to gracefully choose whether to execute or not, depending on their appropriateness for the current type, e.g. renderers.

Parameters
Name Type Description
$type string
methodpublicsetWhen(  $date = null ) : void

Parameters
Name Type Description
$date
Documentation was generated by DocBlox 0.13.3.