Stack2RSS 1.0
A simple web application that creates an RSS feed given an API route.
Protected Member Functions | Private Member Functions

ItemConverter Class Reference

Provides conversion for item objects. More...

Inheritance diagram for ItemConverter:
Converter

List of all members.

Protected Member Functions

 GetDate ($json_item)
 Returns the date of the given item.
 GetDescription ($json_item)
 Returns the description of the given item.
 GetLink ($json_item)
 Returns the link for the given item.
 GetTitle ($json_item)
 Returns the title of the given item.

Private Member Functions

 IsSite ($json_item)
 Determines if this item is a site or associated user.

Detailed Description

Provides conversion for item objects.

Note: unfortunately, the API uses 'item' for two different objects returned: /sites and /users/{ID}/associated.

Because of this, this class is slightly more complicated than it needs to be.

Definition at line 14 of file item_converter.php.


Member Function Documentation

ItemConverter::GetDate ( json_item) [protected]

Returns the date of the given item.

Parameters:
[in]$json_itemthe JSON for the particular item
Returns:
the date of the item

Reimplemented from Converter.

Definition at line 50 of file item_converter.php.

ItemConverter::GetDescription ( json_item) [protected]

Returns the description of the given item.

Parameters:
[in]$json_itemthe JSON for the particular item
Returns:
the HTML for the description of the item

Reimplemented from Converter.

Definition at line 34 of file item_converter.php.

ItemConverter::GetLink ( json_item) [protected]

Returns the link for the given item.

Parameters:
[in]$json_itemthe JSON for the particular item
Returns:
the link for the item

Reimplemented from Converter.

Definition at line 42 of file item_converter.php.

ItemConverter::GetTitle ( json_item) [protected]

Returns the title of the given item.

Parameters:
[in]$json_itemthe JSON for the particular item
Returns:
the HTML for the title of the item

Reimplemented from Converter.

Definition at line 26 of file item_converter.php.

ItemConverter::IsSite ( json_item) [private]

Determines if this item is a site or associated user.

Parameters:
[in]$json_itemthe JSON data for the item
Returns:
TRUE or FALSE depending on whether this item represents a site or not

Definition at line 21 of file item_converter.php.


The documentation for this class was generated from the following file:
 All Classes Files Functions Enumerations