pluf/bank

<?php

/*
 * This file is part of Pluf Framework, a simple PHP Application Framework.
 * Copyright (C) 2010-2020 Phoinex Scholars Co. (http://dpq.co.ir)
 *
 * 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, either version 3 of the License, or
 * (at your option) any later version.
 *
 * 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, see <http://www.gnu.org/licenses/>.
 */

/**
 * سرویس پرداخت‌ها را برای ماژولهای داخلی سیستم ایجاد می کند.
 *
 * @author maso<mostafa.barmshory@dpq.co.ir>
 *        
 */
class Bank_Engine implements JsonSerializable
{

    const ENGINE_PREFIX = 'bank_engine_';

    /**
     *
     * @return string
     */
    public function getType()
    {
        $name = strtolower(get_class($this));
        // NOTE: maso, 1395: تمام متورهای پرداخت باید در پوشه تعیین شده قرار
        // بگیرند
        if (strpos($name, Bank_Engine::ENGINE_PREFIX) !== 0) {
            throw new Bank_Exception_EngineLoad('Engine class must be placed in engine package.');
        }
        return substr($name, strlen(Bank_Engine::ENGINE_PREFIX));
    }

    /**
     *
     * @return string
     */
    public function getSymbol()
    {
        return $this->getType();
    }

    /**
     *
     * @return string
     */
    public function getTitle()
    {
        return '';
    }

    /**
     *
     * @return string
     */
    public function getDescription()
    {
        return '';
    }

    /**
     * Returns supported currency by this engine
     * Returned value is based on ISO 4217 list of currencies (plus IRT for iran tooman)
     *
     * @return string
     */
    public function getCurrency()
    {
        return '';
    }

    /**
     * Creates a new transaction
     *
     * اطلاعات ایجاد شده برای پرداخت می‌تواند در متا قرار گیرد. و تمام اطلاعات
     * مورد نیاز باید ار تقاضا به دست آید.
     *
     * خود روال بر اساس اطلاعات متا باید بفهمد که ایا قبلا این را ساخته یا اولین
     * بار
     * است.
     *
     * پرداخت تنها با یک پشتیبان انجام می‌شود و تغییر پشتیبان غیر ممکن است.
     *
     * در صورتی که امکان انجام کار وجود نداشت باید خطا صادر شود.
     *
     * بعد از این روال ورودی ذخیره خواهد شد.
     *
     * @param Bank_Receipt $receipt
     */
    public function create($receipt)
    {
        // XXX: maso, 1395: ایجاد یک پرداخت
    }

    /**
     * حالت پرداخت را بررسی و پرداخت را به روز می‌کند.
     *
     * اطلاعات مورد نیاز باید از متا برداشته شود.
     *
     * در صورتی که ‌شماره ارجا تعیین شود به معنی انجام شدن پرداخت است.
     *
     * در صورتی که بررسی مشکل داشته باشد خطا صادر می‌شود.
     *
     * در صورتی که پرداخت تکمیل شده باشد درستی برگردانده می‌شود در غیر این صورت
     * نا درستی.
     *
     * بعد از این فراخوانی داده‌ها باز ذخیره سازی می‌شود اگر و تنها اگر پرداخت
     * انجام شده باشد.
     *
     * @param Bank_Receipt $receipt
     */
    public function update($receipt)
    {
        // XXX: maso, 1395: ایجاد یک پرداخت
        return false;
    }

    /**
     * (non-PHPdoc)
     *
     * @see JsonSerializable::jsonSerialize()
     */
    public function jsonSerialize()
    {
        $coded = array(
            'type' => $this->getType(),
            'title' => $this->getTitle(),
            'description' => $this->getDescription(),
            'symbol' => $this->getSymbol(),
            'currency' => $this->getCurrency()
        );
        return $coded;
    }

    /**
     * فهرستی از پارامترهای موتور پرداخت را تعیین می‌کند
     *
     * هر موتور پرداخت به دسته‌ای از پارامترها نیازمند است که باید توسط کاربر
     * تعیین شود. این فراخوانی پارامترهایی را تعیین می‌کند که برای استفاده از
     * این متور پرداخت باید تعیین کرد.
     *
     * خروجی این فراخوانی یک فهرست است توصیف خصوصیت‌ها است.
     */
    public function getParameters()
    {
        $param = array(
            'id' => $this->getType(),
            'name' => $this->getType(),
            'type' => 'struct',
            'title' => $this->getTitle(),
            'description' => $this->getDescription(),
            'editable' => true,
            'visible' => true,
            'priority' => 5,
            'symbol' => $this->getSymbol(),
            'currency' => $this->getCurrency(),
            'children' => []
        );
        $general = $this->getGeneralParam();
        foreach ($general as $gp) {
            $param['children'][] = $gp;
        }

        $extra = $this->getExtraParam();
        foreach ($extra as $ep) {
            $param['children'][] = $ep;
        }
        return $param;
    }

    /**
     * فهرست خصوصیت‌های عمومی را تعیین می‌کند.
     *
     * @return
     *
     */
    public function getGeneralParam()
    {
        $params = array();
        $params[] = array(
            'name' => 'title',
            'type' => 'String',
            'unit' => 'none',
            'title' => 'title',
            'description' => 'beackend title',
            'editable' => true,
            'visible' => true,
            'priority' => 5,
            'symbol' => 'title',
            'defaultValue' => 'no title',
            'validators' => [
                'NotNull',
                'NotEmpty'
            ]
        );
        $params[] = array(
            'name' => 'description',
            'type' => 'String',
            'unit' => 'none',
            'title' => 'description',
            'description' => 'beackend description',
            'editable' => true,
            'visible' => true,
            'priority' => 5,
            'symbol' => 'title',
            'defaultValue' => 'description',
            'validators' => []
        );
        $params[] = array(
            'name' => 'symbol',
            'type' => 'String',
            'unit' => 'none',
            'title' => 'Symbol',
            'description' => 'beackend symbol',
            'editable' => true,
            'visible' => true,
            'priority' => 5,
            'symbol' => 'icon',
            'defaultValue' => '',
            'validators' => []
        );
        return $params;
    }

    /**
     * خصوصیت‌های اضافه را تعیین می‌کند.
     */
    public function getExtraParam()
    {
        // TODO: maso, 1395: فرض شده که این فراخوانی توسط پیاده‌سازی‌ها بازنویسی
        // شود
        return array();
    }
}