Fuman
\

\app_core_action_rss_response_rss

Parses data to a csv response.

Summary

Methods
Properties
Constants
__construct()
getData()
hasData()
setData()
setStatus()
getStatus()
addHeader()
getHeader()
hasHeader()
sendHeaders()
httpRerouteUri()
getOutputCacheTimeToLive()
setOutputCacheTimeToLive()
addAffectedTableUniqueName()
addIgnoreAffectedTableUniqueName()
getAffectedTableUniqueNames()
render()
setTitle()
setLink()
setDescription()
setLanguage()
setPubDate()
addTag()
addItem()
No public properties found
HTTP_STATUS_KEY
PUBDATE_FORMAT
_writeTag()
$_data
$_headers
$_outputCacheTTL
$_affectedTableUniqueNames
$_ignoreAffectedTableUniqueNames
$_title
$_link
$_description
$_language
$_pubTime
$_tags
$_items
$_exportInterface
N/A
No private methods found
No private properties found
N/A

Constants

HTTP_STATUS_KEY

HTTP_STATUS_KEY

Key to identify http status in headers

PUBDATE_FORMAT

PUBDATE_FORMAT

Properties

$_headers

$_headers : array

Type

array

$_outputCacheTTL

$_outputCacheTTL : integer

Output cache time to live

Type

integer

$_affectedTableUniqueNames

$_affectedTableUniqueNames :

Type

$_ignoreAffectedTableUniqueNames

$_ignoreAffectedTableUniqueNames :

Type

$_title

$_title :

Type

$_link

$_link :

Type

$_description

$_description :

Type

$_language

$_language :

Type

$_pubTime

$_pubTime :

Type

$_tags

$_tags :

Type

$_items

$_items :

Type

Methods

__construct()

__construct(\Fuman_Response_Export_Interface|null  $exportInterface = null)

Constructor

Parameters

\Fuman_Response_Export_Interface|null $exportInterface

hasData()

hasData() : boolean

Has data

Returns

boolean

setData()

setData(object|string  $data) : void

Set data

Parameters

object|string $data

setStatus()

setStatus(string  $httpStatusValue) : void

Sets http status

Parameters

string $httpStatusValue

getStatus()

getStatus() : string

Gets http status number

Returns

string

addHeader()

addHeader(string  $name, string  $value) : void

add Header

Parameters

string $name
string $value

getHeader()

getHeader(string  $name) : string

Returns a http header

Parameters

string $name

Returns

string

hasHeader()

hasHeader(string  $name) : boolean

Has http header

Parameters

string $name

Returns

boolean

sendHeaders()

sendHeaders() : void

Send Headers

httpRerouteUri()

httpRerouteUri(string  $uri) : void

Reroute to given uri

Parameters

string $uri

getOutputCacheTimeToLive()

getOutputCacheTimeToLive() : integer

Gets the output cache time to live

Returns

integer

setOutputCacheTimeToLive()

setOutputCacheTimeToLive(integer  $ttl) : integer

Sets the output cache time to live

Parameters

integer $ttl

(-1 will disable cache)

Returns

integer

addAffectedTableUniqueName()

addAffectedTableUniqueName(string  $tableUniqueName)

Add a table unique name to the list of affected table names (Used for output caching)

Parameters

string $tableUniqueName

addIgnoreAffectedTableUniqueName()

addIgnoreAffectedTableUniqueName(  $tableUniqueName)

Adds table unique name to ignore list

Parameters

$tableUniqueName

getAffectedTableUniqueNames()

getAffectedTableUniqueNames(boolean  $withoutIgnored = true) : array

Gets all affected table unique names for this response

Parameters

boolean $withoutIgnored

Returns

array

render()

render() : void

Render a csv.

setTitle()

setTitle(string  $title)

Sets title

Parameters

string $title

setLink()

setLink(string  $link)

Sets links

Parameters

string $link

setDescription()

setDescription(string  $description)

Set description

Parameters

string $description

setLanguage()

setLanguage(string  $language)

Set language

Parameters

string $language

setPubDate()

setPubDate(integer  $pubTime)

Sets publication date

Parameters

integer $pubTime

addTag()

addTag(string  $key, string  $value)

Adds tag

Parameters

string $key
string $value

addItem()

addItem(string  $title, string  $guid, null|integer  $pubDate = null, null|string  $description = null, null|string  $link = null, null|array  $args = null)

Add item

Parameters

string $title
string $guid
null|integer $pubDate
null|string $description
null|string $link
null|array $args

_writeTag()

_writeTag(string  $key, string  $value, string|null  $attrs = '')

Write tag

Parameters

string $key
string $value
string|null $attrs