Joomla! API

Download
Launch

JFeedItem

Extends \JObject

JFeedItem is an internal class that stores feed item information

This class allows for simple but smart objects with get and set methods and an internal error handler.

package

Joomla.Platform
subpackage

Document
since

11.1

Methods

__construct

Class constructor, overridden in descendant classes.

__construct(mixed $properties = null)
inherited
since

11.1

Arguments

$properties

mixedEither and associative array or another object to set the initial properties of the object.

__toString

Magic method to convert the object to a string gracefully.

__toString() : string
inherited deprecated
since

11.1
deprecated

12.3 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not alreay assigned

def(string $property, mixed $default = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixed

get

Returns a property of the object or the default value if the property is not set.

get(string $property, mixed $default = null) : mixed
inherited
since

11.1
see \JObject::getProperties()

Arguments

$property

stringThe name of the property.

$default

mixedThe default value.

Response

mixedThe value of the property.

getError

Get the most recent error message.

getError(integer $i = null, boolean $toString = true) : string
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$i

integerOption error index.

$toString

booleanIndicates if JError objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : array
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Response

arrayArray of error messages or JErrors.

getProperties

Returns an associative array of object properties.

getProperties(boolean $public = true) : array
inherited
since

11.1
see \JObject::get()

Arguments

$public

booleanIf true, returns only the public properties.

Response

array

set

Modifies a property of the object, creating it if it does not already exist.

set(string $property, mixed $value = null) : mixed
inherited
since

11.1

Arguments

$property

stringThe name of the property.

$value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setEnclosure

Set the JFeedEnclosure for this item

setEnclosure(object $enclosure) : \JFeedItem
since

11.1

Arguments

$enclosure

objectThe JFeedItem to add to the feed.

Response

\JFeedIteminstance of $this to allow chaining

setError

Add an error message.

setError(string $error) : void
inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Arguments

$error

stringError message.

setProperties

Set the object properties based on a named array/hash.

setProperties(mixed $properties) : boolean
inherited
since

11.1
see \JObject::set()

Arguments

$properties

mixedEither an associative array or another object.

Response

boolean

toString

Converts the object to a string (the class name).

toString() : string
inherited deprecated
since

11.1
deprecated

12.1 Use magic method __toString()
see \JObject::__toString()

Response

string

Properties

title

Title item element

required

since

11.1

Type(s)

string

link

Link item element

required

since

11.1

Type(s)

string

description

Description item element

required

since

11.1

Type(s)

string

author

Author item element

optional

since

11.1

Type(s)

string

authorEmail

Author email element

optional

since

11.1

Type(s)

string

category

Category element

optional

since

11.1

Type(s)

array

comments

Comments element

optional

since

11.1

Type(s)

string

enclosure

Enclosure element

since

11.1

Type(s)

object

guid

Guid element

optional

since

11.1

Type(s)

string

date

Published date

optional

May be in one of the following formats:

RFC 822: "Mon, 20 Jan 03 18:05:41 +0400" "20 Jan 03 18:05:41 +0000"

ISO 8601: "2003-01-20T18:05:41+04:00"

Unix: 1043082341

since

11.1

Type(s)

string

source

Source element

optional

since

11.1

Type(s)

string

_errors

An array of error messages or Exception objects.

inherited deprecated
since

11.1
see \JError
deprecated

12.3 JError has been deprecated

Type(s)

array
  • \ \
  • \ JFeedItem