TestMonitor\ActiveCampaign\Actions\ManagesLists

Complexity

Total Complexity

12

Size/Duplication

Total Lines	126
Duplicated Lines	0 %

Coupling/Cohesion

Components	1
Dependencies	2

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	lists()	0	8	1
A	getList()	0	13	4
A	findList()	0	10	1
A	createList()	0	16	2
A	deleteList()	0	4	1
A	updateListStatus()	0	9	2
A	contactsByList()	0	8	1

<?php

namespace TestMonitor\ActiveCampaign\Actions;

use TestMonitor\ActiveCampaign\Actions\Action;
use TestMonitor\ActiveCampaign\Resources\Contact;
use TestMonitor\ActiveCampaign\Resources\ContactsList;

trait ManagesLists
{
    use Action;
    
    /**
     * Returns all lists.
     *
     * @return ContactsList[]
     */
    public function lists()
    {
        return $this->transformCollection(
            $this->get('lists'),
            ContactsList::class,
            'lists'
        );
    }

    /**
     * Returns list by ID.
     *
     * @param string $id
     *
     * @return ContactsList|null
     */
    public function getList($id)
    {
        try {
            $lists = $this->get('lists/'.$id);

            if (isset($lists['list']) && count($lists['list'])) {
                return new ContactsList($lists['list']);
            }
        } catch (\TestMonitor\ActiveCampaign\Exceptions\NotFoundException $e) {
            // return null if list not foun
        }
        return null;
    }

    /**
     * Finds list by it's name or URL-safe name.
     *
     * @param string $name name of list to find
     *
     * @return null|ContactsList
     */
    public function findList($name)
    {
        $lists = $this->transformCollection(
            $this->get('lists', ['query' => ['filters[name]' => $name]]),
            ContactsList::class,
            'lists'
        );

        return array_shift($lists);
    }

    /**
     * Creates a new list.
     *
     * @param string $name Name of the list to create
     * @param string $senderUrl The website URL this list is for.
     * @param array  $params other options to create list
     *
     * @return ContactsList
     */
    public function createList($name, $senderUrl, $params = [])
    {
        $params['name'] = $name;
        if (! isset($params['stringid'])) {
            $params['stringid'] = strtolower(preg_replace('/[^A-Z0-9]+/i', '-', $name));
        }
        $params['sender_url'] = $senderUrl;
        $params['sender_reminder'] = 'You signed up for my mailing list.';

        $lists = $this->transformCollection(
            $this->post('lists', ['json' => ['list' => $params]]),
            ContactsList::class
        );

        return array_shift($lists);
    }

    /**
     * Removes list.
     *
     * @param int $id ID of the list to delete
     *
     * @throws \TestMonitor\ActiveCampaign\Exceptions\NotFoundException
     */
    public function deleteList($id)
    {
        $this->delete('lists/'.$id);
    }

    /**
     * Subscribe a contact to a list or unsubscribe a contact from a list.
     *
     * @param int $list ID of list to remove contact from
     * @param int $contact ID of contact to remove from list
     * @param bool $subscribe TRUE to subscribe, FALSE otherwise
     */
    public function updateListStatus($list, $contact, $subscribe)
    {
        $this->post('contactLists', ['json' => [
            'contactList' => [
                'list' => $list,
                'contact' => $contact,
                'status' => $subscribe ? 1 : 2,
            ], ]]);
    }

    /**
     * Get all contacts related to the list.
     *
     * @return Contact[]
     */
    public function contactsByList($listId)
    {
        return $this->transformCollection(
            $this->get('contacts', ['query' => ['listid' => $listId]]),
            Contact::class,
            'contacts'
        );
    }    
}