<?php
/**
 * This program is free software; you can redistribute it and/or
 * modify it under the terms of the GNU General Public License
 * as published by the Free Software Foundation; under version 2
 * of the License (non-upgradable).
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
 *
 * Copyright (c) 2002-2008 (original work) Public Research Centre Henri Tudor & University of Luxembourg (under the project TAO & TAO2);
 *               2008-2010 (update and modification) Deutsche Institut für Internationale Pädagogische Forschung (under the project TAO-TRANSFER);
 *               2009-2012 (update and modification) Public Research Centre Henri Tudor (under the project TAO-SUSTAIN & TAO-DEV);
 *
 */


/**
 * Generis Object Oriented API - common/class.AjaxResponse.php
 *
 * Short description of class common_AjaxResponse
 *
 * @access public
 * @author Cédric Alfonsi, <cedric.alfonsi@tudor.lu>
 * @package generis

 */
class common_AjaxResponse
{
    // --- ASSOCIATIONS ---


    // --- ATTRIBUTES ---

    // --- OPERATIONS ---

    /**
     * constructor
     *
     * @access public
     * @author Cédric Alfonsi, <cedric.alfonsi@tudor.lu>
     * @param  array $options
     *
     */
    public function __construct(array $options = [])
    {

        
        $success    = isset($options['success'])    ? $options['success']    : true;
        $type       = isset($options['type'])       ? $options['type']       : 'json';
        $data       = isset($options['data'])       ? $options['data']       : null;
        $message    = isset($options['message'])    ? $options['message']    : '';
        
        //position the header of the response
        $context = Context::getInstance();
        $context->getResponse()->setContentHeader('application/json');
        //set the response object
        $response = [
            'success'           => $success
            , 'type'            => $type
            , 'message'         => $message
            , 'data'            => $data
        ];
        
        //write the response
        echo json_encode($response);
    }
}