<?php

/**

 * 2007-2014 [PagSeguro Internet Ltda.]

 *

 * NOTICE OF LICENSE

 *

 *Licensed under the Apache License, Version 2.0 (the "License");

 *you may not use this file except in compliance with the License.

 *You may obtain a copy of the License at

 *

 *http://www.apache.org/licenses/LICENSE-2.0

 *

 *Unless required by applicable law or agreed to in writing, software

 *distributed under the License is distributed on an "AS IS" BASIS,

 *WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.

 *See the License for the specific language governing permissions and

 *limitations under the License.

 *

 *  @author    André da Silva Medeiros <andre@swdesign.net.br>

 *  @copyright 2007-2014 PagSeguro Internet Ltda.

 *  @license   http://www.apache.org/licenses/LICENSE-2.0

 */



/***

 * Defines a list of known transaction statuses.

 * This class is not an enum to enable the introduction of new transaction status.

 * without breaking this version of the library.

 */

class PagSeguroPreApprovalStatus

{



    /***

     * @var array

     */

    private static $statusList = array(

        'INITIATED' => 0,

        'PENDING' => 1,

        'ACTIVE' => 2,

        'CANCELLED' => 3,

        'CANCELLED_BY_RECEIVER' => 4,

        'CANCELLED_BY_SENDER' => 5,

        'EXPIRED' => 6

    );



    /***

     * the value of the transaction status

     * Example: 3

     */

    private $value;



    /***

     * @param null $value

     */

    public function __construct($value = null)

    {

        if ($value) {

            if (!isset(self::$statusList[$value])) {

                self::$statusList = array_merge(self::$statusList, array($value => count(self::$statusList)));

            }

            $this->value = self::$statusList[$value];

        }

    }



    /***

     * @param $value

     */

    public function setValue($value)

    {

        $this->value = $value;

    }



    /***

     * @param $type

     * @throws Exception

     */

    public function setByType($type)

    {

        if (isset(self::$statusList[$type])) {

            $this->value = self::$statusList[$type];

        } else {

            throw new Exception("undefined index $type");

        }

    }



    /***

     * @return integer the status value.

     */

    public function getValue()

    {

        return $this->value;

    }



    /***

     * @param value

     * @return String the transaction status corresponding to the informed status value

     */

    public function getTypeFromValue($value = null)

    {

        $value = ($value == null ? $this->value : $value);

        return array_search($this->value, self::$statusList);

    }



    /***

     * Get status list

     * @return array

     */

    public static function getStatusList()

    {

        return self::$statusList;

    }

}

