Joomla! API

Download
Launch

JsonApiView

Extends JsonView

Base class for a Joomla Json List View

abstract

Class holding methods for displaying presentation data.

since

4.0.0
package

Joomla CMS

Methods

__construct

Constructor.

__construct(mixed||string|int config = []) :
since

4.0.0

Arguments

config

array<string|int, mixed>A named configuration array for object construction. contentType: the name (optional) of the content type to use for the serialization

Response

mixed

__toString

Magic method to convert the object to a string gracefully.

__toString() :
inherited deprecated
since

1.7.0
deprecated

4.3 will be removed in 6.0 Classes should provide their own __toString() implementation.

Response

stringThe classname.

def

Sets a default value if not already assigned

def( property,  default = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Defining dynamic properties should not be used anymore

Arguments

property

stringThe name of the property.

default

mixedThe default value.

Response

mixed

dispatchEvent

Dispatches the given event on the internal dispatcher, does a fallback to the global one.

dispatchEvent(\Joomla\Event\EventInterface event) :
inherited deprecated
since

4.1.0
deprecated

4.4 will be removed in 6.0. Use $this->getDispatcher() directly.

Arguments

event

EventInterfaceThe event

Response

void

display

Execute and display a template script.

display( tpl = null) :
inherited
since

4.0.0

Arguments

tpl

stringThe name of the template file to parse; automatically searches through the template paths.

Response

void

displayItem

Execute and display a template script.

displayItem( item = null) :
since

4.0.0

Arguments

item

objectItem

Response

string

displayList

Execute and display a template script.

displayList(array|null items = null) :
since

4.0.0

Arguments

items

array<string|int, mixed>|nullArray of items

Response

string

get

Method to get data from a registered model or a property of the view

get( property,  default = null) :
inherited
since

3.0

Arguments

property

stringThe name of the method to call on the model or the property to get

default

stringThe name of the model to reference or the default value [optional]

Response

mixedThe return value of the method

getDispatcher

Get the event dispatcher.

getDispatcher() : \Joomla\Event\DispatcherInterface
inherited

The override was made to keep a backward compatibility for legacy component. TODO: Remove the override in 6.0

since

4.4.0
throws

UnexpectedValueExceptionMay be thrown if the dispatcher has not been set.

Response

DispatcherInterface

getDocument

Get the Document.

getDocument() : \Joomla\CMS\Document\Document
inherited
since

4.4.0
throws

UnexpectedValueExceptionMay be thrown if the document has not been set.

Response

Document

getError

Get the most recent error message.

getError( i = null,  toString = true) :
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getError

Arguments

i

intOption error index.

toString

boolIndicates if Exception objects should return their error message.

Response

stringError message

getErrors

Return all errors, if any.

getErrors() : mixed||string|int
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Catch thrown Exceptions instead of getErrors

Response

array<string|int, mixed>Array of error messages.

getLanguage

Get the Language.

getLanguage() : \Joomla\CMS\Language\Language
inherited
since

4.4.0
throws

UnexpectedValueExceptionMay be thrown if the language has not been set.

Response

Language

getModel

Method to get the model object

getModel( name = null) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
inherited
since

3.0

Arguments

name

stringThe name of the model (optional)

Response

BaseDatabaseModelThe model object

getName

Method to get the view name

getName() :
inherited

The model name by default parsed using the classname, or it can be set by passing a $config['name'] in the class constructor

since

3.0
throws

Exception

Response

stringThe name of the model

getProperties

Returns an associative array of object properties.

getProperties( public = true) : mixed||string|int
inherited deprecated
since

1.7.0
see CMSObject::get()
deprecated

4.3.0 will be removed in 6.0 Create a proper getter function for the property

Arguments

public

boolIf true, returns only the public properties.

Response

array<string|int, mixed>

prepareItem

Prepare item before render.

prepareItem( item) :
since

4.0.0

Arguments

item

objectThe model item

Response

object

queryEncode

Encode square brackets in the URI query, according to JSON API specification.

queryEncode( query) :
since

4.0.0

Arguments

query

stringThe URI query

Response

string

set

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

set( property,  value = null) :
inherited deprecated
since

1.7.0
deprecated

4.3.0 will be removed in 6.0 Create a proper setter function for the property

Arguments

property

stringThe name of the property.

value

mixedThe value of the property to set.

Response

mixedPrevious value of the property.

setDocument

Set the document to use.

setDocument(\Joomla\CMS\Document\Document document) :
inherited
since

4.4.0

Arguments

document

DocumentThe document to use

Response

void

setError

Add an error message.

setError( error) :
inherited deprecated
since

1.7.0
deprecated

3.1.4 will be removed in 6.0 Will be removed without replacement Throw an Exception instead of using setError

Arguments

error

stringError message.

Response

void

setLanguage

Set the language to use.

setLanguage(\Joomla\CMS\Language\Language language) :
inherited
since

4.4.0

Arguments

language

LanguageThe language to use

Response

void

setModel

Method to add a model to the view. We support a multiple model single view system by which models are referenced by classname. A caveat to the classname referencing is that any classname prepended by \JModel will be referenced by the name without \JModel, eg. \JModelCategory is just Category.

setModel(\Joomla\CMS\MVC\Model\BaseDatabaseModel model,  default = false) : \Joomla\CMS\MVC\Model\BaseDatabaseModel
inherited
since

3.0

Arguments

model

BaseDatabaseModelThe model to add to the view.

default

boolIs this the default model?

Response

BaseDatabaseModelThe added model.

setProperties

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

setProperties( properties) :
inherited deprecated
since

1.7.0
see CMSObject::set()
deprecated

4.3.0 will be removed in 6.0 Create a proper setter function for the property

Arguments

properties

mixedEither an associative array or another object.

Response

bool

Properties

_errors

An array of error messages or Exception objects.

inherited deprecated
since

1.7.0
deprecated

3.1.4 JError has been deprecated

Type(s)

array<string|int, mixed>

language

Language

inherited
since

4.4.0

Type(s)

Language

document

The active document object (Redeclared for typehinting)

since

3.0

Type(s)

JsonapiDocument

option

The URL option for the component. It is usually passed by controller while it creates the view

inherited
since

3.0

Type(s)

string

_name

The name of the view

inherited
since

3.0

Type(s)

string

_models

Registered models

inherited
since

3.0

Type(s)

array<string|int, mixed>

_defaultModel

The default model

inherited
since

3.0

Type(s)

string

_basePath

The base path of the view

inherited
since

4.0.0

Type(s)

string

_charset

Charset to use in escaping mechanisms; defaults to urf8 (UTF-8)

inherited
since

4.0.0

Type(s)

string

_output

The output of the view.

inherited
since

4.0.0

Type(s)

array<string|int, mixed>

type

The content type

Type(s)

string

relationship

Item relationship

since

4.0.0

Type(s)

array<string|int, mixed>

serializer

Serializer data

since

4.0.0

Type(s)

AbstractSerializer

fieldsToRenderItem

The fields to render item in the documents

since

4.0.0

Type(s)

array<string|int, mixed>

fieldsToRenderList

The fields to render items in the documents

since

4.0.0

Type(s)

array<string|int, mixed>
  • \ Joomla
  • \ CMS
  • \ MVC
  • \ View
  • \ JsonApiView