CalculatePriceDeliveryCdek.php

<?php

namespace mrkody\cdek;

/**
 * Расчёт стоимости доставки СДЭК
 * Модуль для интернет-магазинов (ИМ)
 *
 * @version 1.0
 * @since 21.06.2012
 * @link http://www.edostavka.ru/integrator/
 * @see 3197
 * @author Tatyana Shurmeleva
 */
class CalculatePriceDeliveryCdek
{

    //версия модуля
    public $goodsList;
    //url для получения данных по отправке
    public $tariffList;

    //авторизация ИМ
    public $dateExecute;
    private $version = "1.0";

    //id города-отправителя
    private $jsonUrl = 'http://api.cdek.ru/calculator/calculate_price_by_json.php';
    //id города-получателя
    private $authLogin;
    //id тарифа
    private $authPassword;
    //id способа доставки (склад-склад, склад-дверь)
    private $senderCityId;
    //массив мест отправления
    private $receiverCityId;
    //массив id тарифов
    private $tariffId;
    //результат расчёта стоимости отправления ИМ
    private $modeId;
    //результат в случае ошибочного расчёта
    private $result;
    //планируемая дата заказа
    private $error;

    /**
     * конструктор
     */
    public function __construct()
    {
        $this->dateExecute = date('Y-m-d');
    }

    /**
     * Установка планируемой даты отправки
     *
     * @param string $date дата планируемой отправки, например '2012-06-25'
     */
    public function setDateExecute($date)
    {
        $this->dateExecute = date($date);
    }

    /**
     * Авторизация ИМ
     *
     * @param string $authLogin логин
     * @param string $authPassword пароль
     */
    public function setAuth($authLogin, $authPassword)
    {
        $this->authLogin = $authLogin;
        $this->authPassword = $authPassword;
    }

    /**
     * Город-отправитель
     *
     * @param int $id города
     * @throws \Exception
     */
    public function setSenderCityId($id)
    {
        $id = (int)$id;
        if ($id == 0) {
            throw new \Exception("Неправильно задан город-отправитель.");
        }
        $this->senderCityId = $id;
    }

    /**
     * Город-получатель
     *
     * @param int $id города
     * @throws \Exception
     */
    public function setReceiverCityId($id)
    {
        $id = (int)$id;
        if ($id == 0) {
            throw new \Exception("Неправильно задан город-получатель.");
        }
        $this->receiverCityId = $id;
    }

    /**
     * Устанавливаем тариф
     *
     * @param int $id тарифа
     * @throws \Exception
     */
    public function setTariffId($id)
    {
        $id = (int)$id;
        if ($id == 0) {
            throw new \Exception("Неправильно задан тариф.");
        }
        $this->tariffId = $id;
    }

    /**
     * Устанавливаем режим доставки (дверь-дверь=1, дверь-склад=2, склад-дверь=3, склад-склад=4)
     *
     * @param int $id режим доставки
     * @throws \Exception
     */
    public function setModeDeliveryId($id)
    {
        $id = (int)$id;
        if (!in_array($id, array(1, 2, 3, 4))) {
            throw new \Exception("Неправильно задан режим доставки.");
        }
        $this->modeId = $id;
    }

    /**
     * Добавление места в отправлении
     *
     * @param int $weight вес, килограммы
     * @param int $length длина, сантиметры
     * @param int $width ширина, сантиметры
     * @param int $height высота, сантиметры
     * @throws \Exception
     */
    public function addGoodsItemBySize($weight, $length, $width, $height)
    {
        //проверка веса
        $weight = (float)$weight;
        if ($weight == 0.00) {
            throw new \Exception("Неправильно задан вес места № " . (count($this->getGoodslist()) + 1) . ".");
        }
        //проверка остальных величин
        $paramsItem = array(
            "длина" => $length,
            "ширина" => $width,
            "высота" => $height
        );
        foreach ($paramsItem as $k => $param) {
            $param = (int)$param;
            if ($param == 0) {
                throw new \Exception("Неправильно задан параметр '" . $k . "' места № " . (count($this->getGoodslist()) + 1) . ".");
            }
        }
        $this->goodsList[] = array(
            'weight' => $weight,
            'length' => $length,
            'width' => $width,
            'height' => $height
        );
    }

    /**
     * Получение массива мест отправления
     *
     * @return array
     */
    public function getGoodslist()
    {
        if (!isset($this->goodsList)) {
            return null;
        }
        return $this->goodsList;
    }

    /**
     * Добавление места в отправлении по объёму (куб.метры)
     *
     * @param int $weight вес, килограммы
     * @param int $volume объёмный вес, метры кубические (А * В * С)
     * @throws \Exception
     */
    public function addGoodsItemByVolume($weight, $volume)
    {
        $paramsItem = array(
            "вес" => $weight,
            "объёмный вес" => $volume
        );
        foreach ($paramsItem as $k => $param) {
            $param = (float)$param;
            if ($param == 0.00) {
                throw new \Exception("Неправильно задан параметр '" . $k . "' места № " . (count($this->getGoodslist()) + 1) . ".");
            }
        }
        $this->goodsList[] = array(
            'weight' => $weight,
            'volume' => $volume
        );
    }

    /**
     * добавление тарифа в список тарифов с приоритетами
     *
     * @param int $id тариф
     * @param int $priority default false приоритет
     * @throws \Exception
     */
    public function addTariffPriority($id, $priority = 0)
    {
        $id = (int)$id;
        if ($id == 0) {
            throw new \Exception("Неправильно задан id тарифа.");
        }
        $priority = ($priority > 0) ? $priority : count($this->tariffList) + 1;
        $this->tariffList[] = array(
            'priority' => $priority,
            'id' => $id
        );
    }

    /**
     * Расчет стоимости доставки
     *
     * @return bool
     * @throws \Exception
     */
    public function calculate()
    {
        //формируем массив для отправки curl-post-запроса
        //передаём только явно заданные параметры, установленные ИМ
        //всю проверку и обработку будем делать на стороне сервера
        $data = array();
        //получение всех свойств текущего объекта не работает, т.к. у нас свойства private
        //поэтому определим массив $data явно
        //проверяем на установленную переменную и не-NULL-значение

        //версия модуля
        isset($this->version) ? $data['version'] = $this->version : '';
        //дата планируемой доставки, если не установлено, берётся сегодняшний день
        $data['dateExecute'] = $this->dateExecute;
        //авторизация: логин
        isset($this->authLogin) ? $data['authLogin'] = $this->authLogin : '';
        //авторизация: пароль
        isset($this->authPassword) ? $data['secure'] = $this->_getSecureAuthPassword() : '';
        //город-отправитель
        isset($this->senderCityId) ? $data['senderCityId'] = $this->senderCityId : '';
        //город-получатель
        isset($this->receiverCityId) ? $data['receiverCityId'] = $this->receiverCityId : '';
        //выбранный тариф
        isset($this->tariffId) ? $data['tariffId'] = $this->tariffId : '';
        //список тарифов с приоритетами
        (isset($this->tariffList)) ? $data['tariffList'] = $this->tariffList : '';
        //режим доставки
        isset($this->modeId) ? $data['modeId'] = $this->modeId : '';

        //список мест
        if (isset($this->goodsList)) {
            foreach ($this->goodsList as $idGoods => $goods) {
                $data['goods'][$idGoods] = array();
                //вес
                (isset($goods['weight']) && $goods['weight'] <> '' && $goods['weight'] > 0.00) ? $data['goods'][$idGoods]['weight'] = $goods['weight'] : '';
                //длина
                (isset($goods['length']) && $goods['length'] <> '' && $goods['length'] > 0) ? $data['goods'][$idGoods]['length'] = $goods['length'] : '';
                //ширина
                (isset($goods['width']) && $goods['width'] <> '' && $goods['width'] > 0) ? $data['goods'][$idGoods]['width'] = $goods['width'] : '';
                //высота
                (isset($goods['height']) && $goods['height'] <> '' && $goods['height'] > 0) ? $data['goods'][$idGoods]['height'] = $goods['height'] : '';
                //объемный вес (куб.м)
                (isset($goods['volume']) && $goods['volume'] <> '' && $goods['volume'] > 0.00) ? $data['goods'][$idGoods]['volume'] = $goods['volume'] : '';

            }
        }
        //проверка на подключние библиотеки curl
        if (!extension_loaded('curl')) {
            throw new \Exception("Не подключена библиотека CURL");
        }
        $response = $this->_getRemoteData($data);

        if (isset($response['result']) && !empty($response['result'])) {
            $this->result = $response;
            return true;
        } else {
            $this->error = $response;
            return false;
        }

        //return (isset($response['result']) && (!empty($response['result']))) ? true : false;
        //результат
        //$result = ($this->getResponse());
        //return $result;
    }

    /**
     * Защифрованный пароль для передачи на сервер
     *
     * @return string
     */
    private function _getSecureAuthPassword()
    {
        return md5($this->dateExecute . '&' . $this->authPassword);
    }

    /**
     * Выполнение POST-запроса на сервер для получения данных
     * по запрашиваемым параметрам.
     *
     *
     */
    private function _getRemoteData($data)
    {
        $data_string = json_encode($data);

        $ch = curl_init();
        curl_setopt($ch, CURLOPT_URL, $this->jsonUrl);
        curl_setopt($ch, CURLOPT_RETURNTRANSFER, 1);
        curl_setopt($ch, CURLOPT_HTTPHEADER, array(
                'Content-Type: application/json'
            )
        );
        curl_setopt($ch, CURLOPT_POST, 1);
        curl_setopt($ch, CURLOPT_POSTFIELDS, $data_string);

        $result = curl_exec($ch);
        curl_close($ch);

        return json_decode($result, true);
    }

    /**
     * Получить результаты подсчета
     *
     * @return array
     */
    public function getResult()
    {
        return $this->result;
    }

    /**
     * получить код и текст ошибки
     *
     * @return object
     */
    public function getError()
    {
        return $this->error;
    }

    /**
     * Получение массива заданных тарифов
     *
     * @return array
     */
    private function _getTariffList()
    {
        if (!isset($this->tariffList)) {
            return null;
        }
        return $this->tariffList;
    }

}

?>