mautic / mautic/api-library

[Feature request] Search filters to be an array, instead of function arguments

Open
#247 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
PHP
Stars
205
Forks
129
PR merge metrics
No merged PRs in 30d

Description

Given this:
$contacts = $contactApi->getList($searchFilter, $start, $limit, $orderBy, $orderByDir, $publishedOnly, $minimal);

If I only want to set $limit, I have to fill in empty or NULL for all the other arguments.

Where as, if filters were an array, I can do something like this:
$filter['limit'] = 10; $contacts = $contactApi->getList($filter);


Want to back this issue? Post a bounty on it! We accept bounties via Bountysource.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the contact API entry point that implements getList and review its callers to understand the current argument contract. The change is complete when the API accepts a filter array, including a limit-only call, with the supported filters and existing behavior defined and covered by the project's tests.

Written by the indexing model from the issue text.

Assessment

Tech stack
php
Domain
api
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.