FeedArticleApiHandler
in package
Sub-handler for feed article API operations.
Tags
Table of Contents
Properties
Methods
- __construct() : mixed
- deleteArticles() : array{success: bool, deleted: int}
- Delete articles.
- formatArticleRecord() : array<string|int, mixed>
- Format an article record for API response.
- formatDeleteArticles() : array<string|int, mixed>
- Format response for deleting articles.
- formatGetArticles() : array<string|int, mixed>
- Format response for getting articles.
- formatImportArticles() : array<string|int, mixed>
- Format response for importing articles.
- formatResetErrorArticles() : array<string|int, mixed>
- Format response for resetting error articles.
- getArticles() : array{articles?: array, pagination?: array, feed?: array, error?: string}
- Get articles for a feed.
- importArticles() : array{success: bool, imported: int, errors: array}
- Import articles as texts.
- resetErrorArticles() : array{success: bool, reset: int}
- Reset error articles (remove leading space from links).
Properties
$feedFacade
private
FeedFacade
$feedFacade
Methods
__construct()
public
__construct(FeedFacade $feedFacade) : mixed
Parameters
- $feedFacade : FeedFacade
deleteArticles()
Delete articles.
public
deleteArticles(int $feedId[, array<string|int, mixed> $articleIds = [] ]) : array{success: bool, deleted: int}
Parameters
- $feedId : int
-
Feed ID
- $articleIds : array<string|int, mixed> = []
-
Article IDs to delete (empty = all)
Return values
array{success: bool, deleted: int}formatArticleRecord()
Format an article record for API response.
public
formatArticleRecord(array<string|int, mixed> $row) : array<string|int, mixed>
Parameters
- $row : array<string|int, mixed>
-
Database record
Return values
array<string|int, mixed> —Formatted article data
formatDeleteArticles()
Format response for deleting articles.
public
formatDeleteArticles(int $feedId[, array<string|int, mixed> $articleIds = [] ]) : array<string|int, mixed>
Parameters
- $feedId : int
-
Feed ID
- $articleIds : array<string|int, mixed> = []
-
Article IDs (empty = all)
Return values
array<string|int, mixed> —Deletion result
formatGetArticles()
Format response for getting articles.
public
formatGetArticles(array<string|int, mixed> $params) : array<string|int, mixed>
Parameters
- $params : array<string|int, mixed>
-
Filter parameters
Return values
array<string|int, mixed> —Articles with pagination
formatImportArticles()
Format response for importing articles.
public
formatImportArticles(array<string|int, mixed> $data) : array<string|int, mixed>
Parameters
- $data : array<string|int, mixed>
-
Import data
Return values
array<string|int, mixed> —Import result
formatResetErrorArticles()
Format response for resetting error articles.
public
formatResetErrorArticles(int $feedId) : array<string|int, mixed>
Parameters
- $feedId : int
-
Feed ID
Return values
array<string|int, mixed> —Reset result
getArticles()
Get articles for a feed.
public
getArticles(array<string|int, mixed> $params) : array{articles?: array, pagination?: array, feed?: array, error?: string}
Parameters
- $params : array<string|int, mixed>
-
Parameters:
- feed_id: int (required)
- query: string (search)
- page: int
- per_page: int
- sort: int (1=date desc, 2=date asc, 3=title)
Return values
array{articles?: array, pagination?: array, feed?: array, error?: string}importArticles()
Import articles as texts.
public
importArticles(array<string|int, mixed> $data) : array{success: bool, imported: int, errors: array}
Parameters
- $data : array<string|int, mixed>
-
Import data:
- article_ids: array of article IDs
Return values
array{success: bool, imported: int, errors: array}resetErrorArticles()
Reset error articles (remove leading space from links).
public
resetErrorArticles(int $feedId) : array{success: bool, reset: int}
Parameters
- $feedId : int
-
Feed ID