AmoCRM\Models\Lead

Complexity

Total Complexity

10

Size/Duplication

Total Lines	133
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	5

Test Coverage

Coverage

88.57%

Importance

Changes

0

4 Methods

Rating	Name	Duplication	Size	Complexity
A	apiList()	0	6	2
A	apiListItem()	0	6	2
A	apiAdd()	0	28	5
A	apiUpdate()	0	20	1

<?php

namespace AmoCRM\Models;

use AmoCRM\Exception;
use AmoCRM\Models\Traits\SetNote;
use AmoCRM\Models\Traits\SetTags;
use AmoCRM\Models\Traits\SetDateCreate;
use AmoCRM\Models\Traits\SetLastModified;
use AmoCRM\NetworkException;

/**
 * Class Lead
 *
 * Класс модель для работы со Сделками
 *
 * @package AmoCRM\Models
 * @author dotzero <mail@dotzero.ru>
 * @link http://www.dotzero.ru/
 * @link https://github.com/dotzero/amocrm-php
 *
 * For the full copyright and license information, please view the LICENSE
 * file that was distributed with this source code.
 */
class Lead extends AbstractModel
{
    use SetNote, SetTags, SetDateCreate, SetLastModified;

    /**
     * @var array Список доступный полей для модели (исключая кастомные поля)
     */
    protected $fields = [
        'name',
        'date_create',
        'last_modified',
        'status_id',
        'pipeline_id',
        'price',
        'responsible_user_id',
        'created_user_id',
        'request_id',
        'linked_company_id',
        'tags',
        'visitor_uid',
        'notes',
        'modified_user_id',
        'loss_reason_id',
    ];

    /**
     * Список сделок
     *
     * Метод для получения списка сделок с возможностью фильтрации и постраничной выборки.
     * Ограничение по возвращаемым на одной странице (offset) данным - 500 сделок
     *
     * @link https://www.amocrm.ru/developers/content/crm_platform/leads-api#leads-list
     * @param array $parameters Массив параметров к amoCRM API
     * @param null|string $modified Дополнительная фильтрация по (изменено с)
     * @return array Ответ amoCRM API
     */
    
    public function apiList($parameters, $url = '/api/v4/leads', $modified = null)
    {
        $response = $this->getRequest($url, $parameters, $modified);
        
        return isset($response['_embedded']['leads']) ? $response['_embedded']['leads'] : [];
    }
    
    /**
     * Получение одной сделки
     * Метод для получения одной сделки по id
     * @link https://www.amocrm.ru/developers/content/crm_platform/leads-api#lead-detail
     * @param             $itemId
     * @param string      $url
     * @param array       $parameters
     * @param null|string $modified Дополнительная фильтрация по (изменено с)
     * @return array Ответ amoCRM API
     * @throws Exception
     * @throws NetworkException
     */
    public function apiListItem($itemId, $url = '/api/v4/leads/', $parameters = [], $modified = null)
    {
        $response = $this->getRequest($url.$itemId, $parameters, $modified);
        
        return $response ? : [];
    }
    
    /**
     * Добавление сделки
     *
     * Метод позволяет добавлять сделки по одной или пакетно
     *
     * @link https://developers.amocrm.ru/rest_api/leads_set.php
     * @param array $leads Массив сделок для пакетного добавления
     * @return int|array Уникальный идентификатор сделки или массив при пакетном добавлении
     */
    public function apiAdd($leads = [])
    {
        if (empty($leads)) {
            $leads = [$this];
        }

        $parameters = [
            'leads' => [
                'add' => [],
            ],
        ];

        foreach ($leads AS $lead) {
            $parameters['leads']['add'][] = $lead->getValues();
        }

        $response = $this->postRequest('/private/api/v2/json/leads/set', $parameters);

        if (isset($response['leads']['add'])) {
            $result = array_map(function($item) {
                return $item['id'];
            }, $response['leads']['add']);
        } else {
            return [];
        }

        return count($leads) == 1 ? array_shift($result) : $result;
    }

    /**
     * Обновление сделки
     *
     * Метод позволяет обновлять данные по уже существующим сделкам
     *
     * @link https://developers.amocrm.ru/rest_api/leads_set.php
     * @param int $id Уникальный идентификатор сделки
     * @param string $modified Дата последнего изменения данной сущности
     * @return bool Флаг успешности выполнения запроса
     * @throws \AmoCRM\Exception
     */
    public function apiUpdate($id, $modified = 'now')
    {
        $this->checkId($id);

        $parameters = [
            'leads' => [
                'update' => [],
            ],
        ];

        $lead = $this->getValues();
        $lead['id'] = $id;
        $lead['last_modified'] = strtotime($modified);

        $parameters['leads']['update'][] = $lead;

        $response = $this->postRequest('/private/api/v2/json/leads/set', $parameters);

        return empty($response['leads']['update']['errors']);
    }
}