Skip to content

v4 API: Forms and Landing Pages: Pagination and Total Count #91

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.

Sign up for GitHub

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

Merged
merged 13 commits into from
Apr 5, 2024
Merged

v4 API: Forms and Landing Pages: Pagination and Total Count #91

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
bfac523
Update `get_forms` and `get_landing_pages` methods
n7studios Mar 29, 2024
6e5a0b0
Started tests
n7studios Mar 29, 2024
d0221a4
Merge remote-tracking branch 'origin/v4-api-oauth' into v4-api-forms-…
n7studios Apr 1, 2024
a6753fa
Coding standards
n7studios Apr 1, 2024
95a2256
Add form pagination and total count tests
n7studios Apr 1, 2024
512ea0a
Added landing page tests
n7studios Apr 1, 2024
6197652
Remove deprecated `get_resources` tests
n7studios Apr 1, 2024
b6e94c0
Use `type` parameter to fetch Forms or Landing Pages
n7studios Apr 2, 2024
87e871a
Completed tests for `type` filtering
n7studios Apr 2, 2024
02de911
Merge remote-tracking branch 'origin/v4-api-oauth' into v4-api-forms-…
n7studios Apr 2, 2024
67e1346
Merge remote-tracking branch 'origin/v4-api-oauth' into v4-api-forms-…
n7studios Apr 4, 2024
57bbb00
Updated `get_forms` and `get_landing_pages` to support new `status` f…
n7studios Apr 4, 2024
66cb9ae
Completed tests
n7studios Apr 4, 2024
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
181 changes: 56 additions & 125 deletions src/ConvertKit_API.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -386,31 +386,77 @@ public function get_growth_stats(\DateTime $starting = null, \DateTime $ending =
}

/**
* Gets all forms.
* Get forms.
*
* @param string $status Form status (active|archived|trashed|all).
* @param boolean $include_total_count To include the total count of records in the response, use true.
* @param string $after_cursor Return results after the given pagination cursor.
* @param string $before_cursor Return results before the given pagination cursor.
* @param integer $per_page Number of results to return.
*
* @since 1.0.0
*
* @see https://developers.convertkit.com/v4.html#convertkit-api-forms
*
* @return false|mixed
* @return false|array<int,\stdClass>
*/
public function get_forms()
{
return $this->get_resources('forms');
public function get_forms(
string $status = 'active',
bool $include_total_count = false,
string $after_cursor = '',
string $before_cursor = '',
int $per_page = 100
) {
return $this->get(
endpoint: 'forms',
args: $this->build_total_count_and_pagination_params(
params: [
'type' => 'embed',
'status' => $status,
],
include_total_count: $include_total_count,
after_cursor: $after_cursor,
before_cursor: $before_cursor,
per_page: $per_page
)
);
}

/**
* Gets all landing pages.
* Get landing pages.
*
* @param string $status Form status (active|archived|trashed|all).
* @param boolean $include_total_count To include the total count of records in the response, use true.
* @param string $after_cursor Return results after the given pagination cursor.
* @param string $before_cursor Return results before the given pagination cursor.
* @param integer $per_page Number of results to return.
*
* @since 1.0.0
*
* @see https://developers.convertkit.com/v4.html#convertkit-api-forms
*
* @return false|mixed
* @return false|array<int,\stdClass>
*/
public function get_landing_pages()
{
return $this->get_resources('landing_pages');
public function get_landing_pages(
string $status = 'active',
bool $include_total_count = false,
string $after_cursor = '',
string $before_cursor = '',
int $per_page = 100
) {
return $this->get(
endpoint: 'forms',
args: $this->build_total_count_and_pagination_params(
params: [
'type' => 'hosted',
'status' => $status,
],
include_total_count: $include_total_count,
after_cursor: $after_cursor,
before_cursor: $before_cursor,
per_page: $per_page
)
);
}

/**
Expand Down Expand Up @@ -883,121 +929,6 @@ public function get_email_templates(
);
}

/**
* Gets a resource index
* Possible resources: forms, landing_pages, subscription_forms, tags
*
* GET /{$resource}/
*
* @param string $resource Resource type.
*
* @throws \InvalidArgumentException If the resource argument is not a supported resource type.
*
* @return array<int|string, mixed|\stdClass> API response
*/
public function get_resources(string $resource)
{
// Assign the resource to the request variable.
$request = $resource;

// Landing pages are included in the /forms endpoint.
if ($resource === 'landing_pages') {
$request = 'forms';
}

// Fetch resources.
$resources = $this->get($request);

$this->create_log(sprintf('%s response %s', $resource, json_encode($resources)));

// Return a blank array if no resources exist.
if (!$resources) {
$this->create_log('No resources');
return [];
}

// Build array of resources.
$_resource = [];
switch ($resource) {
// Forms.
case 'forms':
// Bail if no forms are set.
if (!isset($resources->forms)) {
$this->create_log('No form resources');
return [];
}

// Build array of forms.
foreach ($resources->forms as $form) {
// Exclude archived forms.
if (isset($form->archived) && $form->archived) {
continue;
}

// Exclude hosted forms.
if ($form->type === 'hosted') {
continue;
}

$_resource[] = $form;
}
break;

// Landing Pages.
case 'landing_pages':
// Bail if no landing pages are set.
if (!isset($resources->forms)) {
$this->create_log('No landing page resources');
return [];
}

foreach ($resources->forms as $form) {
// Exclude archived landing pages.
if (isset($form->archived) && $form->archived) {
continue;
}

// Exclude non-hosted (i.e. forms).
if ($form->type !== 'hosted') {
continue;
}

$_resource[] = $form;
}
break;

// Subscription Forms.
case 'subscription_forms':
// Exclude archived subscription forms.
foreach ($resources as $mapping) {
if (isset($mapping->archived) && $mapping->archived) {
continue;
}

$_resource[$mapping->id] = $mapping->form_id;
}
break;

// Tags.
case 'tags':
// Bail if no tags are set.
if (!isset($resources->tags)) {
$this->create_log('No tag resources');
return [];
}

foreach ($resources->tags as $tag) {
$_resource[] = $tag;
}
break;

default:
throw new \InvalidArgumentException('An unsupported resource was specified.');
}//end switch

return $_resource;
}

/**
* List subscribers.
*
Expand Down
Loading