Documentation

FeedCrudApiHandler
in package

Sub-handler for feed CRUD API operations.

Tags
since
3.0.0

Table of Contents

Properties

$feedFacade  : FeedFacade

Methods

__construct()  : mixed
createFeed()  : array{success: bool, feed?: array, error?: string}
Create a new feed.
deleteFeeds()  : array{success: bool, deleted: int}
Delete feeds.
formatCreateFeed()  : array<string|int, mixed>
Format response for creating feed.
formatDeleteFeeds()  : array<string|int, mixed>
Format response for deleting feeds.
formatFeedRecord()  : array<string|int, mixed>
Format a feed record for API response.
formatGetFeed()  : array<string|int, mixed>
Format response for getting single feed.
formatGetFeedList()  : array<string|int, mixed>
Format response for getting feed list.
formatUpdateFeed()  : array<string|int, mixed>
Format response for updating feed.
getFeed()  : array<string|int, mixed>
Get a single feed by ID.
getFeedList()  : array{feeds: array, pagination: array, languages: array}
Get list of feeds with pagination and filtering.
getLanguagesForSelect()  : array<string|int, mixed>
Get languages for filter dropdown.
updateFeed()  : array{success: bool, feed?: array, error?: string}
Update an existing feed.

Properties

Methods

createFeed()

Create a new feed.

public createFeed(array<string|int, mixed> $data) : array{success: bool, feed?: array, error?: string}
Parameters
$data : array<string|int, mixed>

Feed data

Return values
array{success: bool, feed?: array, error?: string}

deleteFeeds()

Delete feeds.

public deleteFeeds(array<string|int, mixed> $feedIds) : array{success: bool, deleted: int}
Parameters
$feedIds : array<string|int, mixed>

Array of feed IDs to delete

Return values
array{success: bool, deleted: int}

formatCreateFeed()

Format response for creating feed.

public formatCreateFeed(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$data : array<string|int, mixed>

Feed data

Return values
array<string|int, mixed>

Creation result

formatDeleteFeeds()

Format response for deleting feeds.

public formatDeleteFeeds(array<string|int, mixed> $feedIds) : array<string|int, mixed>
Parameters
$feedIds : array<string|int, mixed>

Feed IDs

Return values
array<string|int, mixed>

Deletion result

formatFeedRecord()

Format a feed record for API response.

public formatFeedRecord(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
$row : array<string|int, mixed>

Database record

Return values
array<string|int, mixed>

Formatted feed data

formatGetFeed()

Format response for getting single feed.

public formatGetFeed(int $feedId) : array<string|int, mixed>
Parameters
$feedId : int

Feed ID

Return values
array<string|int, mixed>

Feed data

formatGetFeedList()

Format response for getting feed list.

public formatGetFeedList(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
$params : array<string|int, mixed>

Filter parameters

Return values
array<string|int, mixed>

Feed list with pagination

formatUpdateFeed()

Format response for updating feed.

public formatUpdateFeed(int $feedId, array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
$feedId : int

Feed ID

$data : array<string|int, mixed>

Feed data

Return values
array<string|int, mixed>

Update result

getFeed()

Get a single feed by ID.

public getFeed(int $feedId) : array<string|int, mixed>
Parameters
$feedId : int

Feed ID

Return values
array<string|int, mixed>

Feed data or error

getFeedList()

Get list of feeds with pagination and filtering.

public getFeedList(array<string|int, mixed> $params) : array{feeds: array, pagination: array, languages: array}
Parameters
$params : array<string|int, mixed>

Filter parameters:

  • lang: int|null (language ID filter)
  • query: string|null (search query)
  • page: int (default 1)
  • per_page: int (default 50)
  • sort: int (1=name, 2=update desc, 3=update asc)
Return values
array{feeds: array, pagination: array, languages: array}

getLanguagesForSelect()

Get languages for filter dropdown.

public getLanguagesForSelect() : array<string|int, mixed>
Return values
array<string|int, mixed>

Array of language options

updateFeed()

Update an existing feed.

public updateFeed(int $feedId, array<string|int, mixed> $data) : array{success: bool, feed?: array, error?: string}
Parameters
$feedId : int

Feed ID

$data : array<string|int, mixed>

Feed data

Return values
array{success: bool, feed?: array, error?: string}

        
On this page

Search results