Api\Model\Payload

Complexity

Total Complexity

2

Size/Duplication

Total Lines	20
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	0

Importance

Changes

0

2 Methods

Rating	Name	Duplication	Size	Complexity
A	__construct()	0	5	1
A	toArray()	0	7	1

<?php

namespace Api\Model;

/**
 * Class Payload.
 * Class represents json output that is sent to clients via REST API interface.
 *
 * Output is standardized and consists of error message (if applicable) and custom formatted content.
 * Example for index page:
 *
 * {
 *   "error": false,
 *   "content": "welcome to api."
 * }
 *
 * If there was an error, the reason should be described within error property.
 * HTTP status code is always 200, since server itself responded with no error.
 *
 * @package Api\Model
 */
class Payload
{
    private $error;

    private $content;

    public function __construct($content, $error = false)
    {
        $this->error = $error;
        $this->content = $content;
    }

    public function toArray()
    {
        return array(
            'error' => $this->error,
            'content' => $this->content
        );
    }
}