Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Добавил CustomFieldsFilter для фильтрации полей по типам. #519

Merged
merged 3 commits into from
Jul 26, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -539,6 +539,7 @@ $leadsService = $apiClient->leads();
| ```companies``` | ```\AmoCRM\Filters\CompaniesFilter``` | Доступен только на аккаунтах, которые подключены к тестированию функционала фильтрации по API | ✅ |
| ```contacts``` | ```\AmoCRM\Filters\ContactsFilter``` | Доступен только на аккаунтах, которые подключены к тестированию функционала фильтрации по API | ✅ |
| ```customers``` | ```\AmoCRM\Filters\CustomersFilter``` | Доступен только на аккаунтах, которые подключены к тестированию функционала фильтрации по API | ✅ |
| ```customFields``` | ```\AmoCRM\Filters\CustomFieldsFilter``` | Фильтр для метода получения полей `\AmoCRM\EntitiesServices\CustomFields::get` | ❌ |
evergreentype marked this conversation as resolved.
Show resolved Hide resolved
| ```leads``` | ```\AmoCRM\Filters\LeadsFilter``` | Доступен только на аккаунтах, которые подключены к тестированию функционала фильтрации по API | ✅ |
| ```events``` | ```\AmoCRM\Filters\EventsFilter``` | Фильтр для списка событий | ❌ |
| ```leads```, ```contacts```, ```customers```, ```companies``` | ```\AmoCRM\Filters\LinksFilter``` | Фильтр для получения связей для метода `\AmoCRM\EntitiesServices\HasLinkMethodInterface::getLinks` | ❌ |
Expand Down
11 changes: 11 additions & 0 deletions examples/custom_fields_actions.php
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,7 @@
use AmoCRM\Helpers\EntityTypesInterface;
use AmoCRM\Collections\CustomFields\CustomFieldsCollection;
use AmoCRM\Exceptions\AmoCRMApiException;
use AmoCRM\Filters\CustomFieldsFilter;
use AmoCRM\Models\CustomFields\CheckboxCustomFieldModel;
use AmoCRM\Models\CustomFields\CustomFieldModel;
use AmoCRM\Models\CustomFields\EnumModel;
Expand Down Expand Up @@ -47,6 +48,16 @@ function (AccessTokenInterface $accessToken, string $baseDomain) {
die;
}

//Получим поля по типу
try {
$filter = (new CustomFieldsFilter())
->setTypes([CustomFieldModel::TYPE_TEXT, CustomFieldModel::TYPE_URL]); // или ['text', 'url']
$result = $customFieldsService->get($filter);
} catch (AmoCRMApiException $e) {
printError($e);
die;
}

//Создадим модель поля и освежим его
$customFieldModel = new CustomFieldModel();
$customFieldModel->setId(269303);
Expand Down
57 changes: 57 additions & 0 deletions src/AmoCRM/Filters/CustomFieldsFilter.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,57 @@
<?php

namespace AmoCRM\Filters;

use AmoCRM\Filters\Interfaces\HasPagesInterface;
use AmoCRM\Filters\Traits\ArrayOrStringFilterTrait;
use AmoCRM\Filters\Traits\PagesFilterTrait;

/**
* Supports pagination and filtering custom_fields by types.
*/
class CustomFieldsFilter extends BaseEntityFilter implements HasPagesInterface
{
use PagesFilterTrait;
use ArrayOrStringFilterTrait;

/**
* @var null|string[] An array of custom_field types.
*/
private $types = null;

/**
* @return string[]|null
*/
public function getTypes(): ?array
{
return $this->types;
}

/**
* Filters custom_fields by types.
*
* @param string[]|null $types Type are defined in `CustomFieldModel`.
*/
public function setTypes(?array $types): self
{
$this->types = $this->parseArrayOrStringFilter($types);

return $this;
}

/**
* @return array
*/
public function buildFilter(): array
{
$filter = [];

if (!is_null($this->types)) {
evergreentype marked this conversation as resolved.
Show resolved Hide resolved
$filter['filter']['type'] = $this->getTypes();
}

$filter = $this->buildPagesFilter($filter);

return $filter;
}
}