PHP Class Sulu\Component\Rest\ListBuilder\ListRepresentation

Inheritance: extends Hateoas\Representation\PaginatedRepresentation

Datei anzeigen Open project: sulu/sulu Class Usage Examples

Protected Properties

Property	Type	Description
$data	mixed[]
$rel	string
$total	integer

Public Methods

Method	Description
__construct ( mixed $data, string $rel, string $route, array $parameters, integer $page, integer $limit, integer $total )
getData ( ) : mixed[]	Returns data.
getRel ( ) : string	Returns relation name.
getTotal ( ) : integer	Returns total number of elements.

Method Details

__construct() public method

public __construct ( mixed $data, string $rel, string $route, array $parameters, integer $page, integer $limit, integer $total )
$data	mixed	The data which will be presented
$rel	string	The name of the relation inside of the _embedded field
$route	string	The name of the route, for generating the links
$parameters	array	The parameters to append to the route
$page	integer	The number of the current page
$limit	integer	The size of one page
$total	integer	The total number of elements

getData() public method

Returns data.

public getData ( ) : mixed[]
return	mixed[]

getRel() public method

Returns relation name.

public getRel ( ) : string
return	string

getTotal() public method

Returns total number of elements.

public getTotal ( ) : integer
return	integer

Property Details

$data protected_oe property

protected mixed[] $data
return	mixed[]

$rel protected_oe property

protected string $rel
return	string

$total protected_oe property

protected int $total
return	integer