Documentation

ApkgController extends VocabularyBaseController
in package

HTTP entry points for round-trip Anki .apkg interop:

GET /vocabulary/apkg/export?lang_id=N stream a .apkg download GET /vocabulary/apkg/import render the upload form POST /vocabulary/apkg/import accept upload + render summary

The orchestration lives in ApkgExportService / ApkgImportService; this controller is just request parsing + response shaping.

Table of Contents

Properties

$bulkService  : WordBulkService|null
$contextService  : WordContextService|null
$crudService  : WordCrudService|null
Lazy-loaded services.
$discoveryService  : WordDiscoveryService|null
$expressionService  : ExpressionService|null
$linkingService  : WordLinkingService|null
$multiWordService  : MultiWordService|null
$sentenceService  : SentenceService|null
$textStatisticsService  : TextStatisticsService|null
$uploadService  : WordUploadService|null
$viewPath  : string
View base path.
$exportService  : ApkgExportService|null
$importService  : ApkgImportService|null
$languageFacade  : LanguageFacade

Methods

__construct()  : mixed
Constructor.
export()  : never
Export terms as a .apkg, streamed to the browser.
importForm()  : void
Render the import upload form (GET) or process the upload (POST).
setViewPath()  : void
Set custom view path.
getBulkService()  : WordBulkService
Get WordBulkService (lazy loaded).
getContextService()  : WordContextService
Get WordContextService (lazy loaded).
getCrudService()  : WordCrudService
Get WordCrudService (lazy loaded).
getDiscoveryService()  : WordDiscoveryService
Get WordDiscoveryService (lazy loaded).
getExpressionService()  : ExpressionService
Get ExpressionService (lazy loaded).
getLinkingService()  : WordLinkingService
Get WordLinkingService (lazy loaded).
getMultiWordService()  : MultiWordService
Get MultiWordService (lazy loaded).
getSentenceService()  : SentenceService
Get SentenceService (lazy loaded).
getTextStatisticsService()  : TextStatisticsService
Get TextStatisticsService (lazy loaded).
getUploadService()  : WordUploadService
Get WordUploadService (lazy loaded).
render()  : void
Render a view.
exportSvc()  : ApkgExportService
handleImportSubmit()  : void
importSvc()  : ApkgImportService
renderImportForm()  : void
slugify()  : string
streamDownload()  : never

Properties

Methods

export()

Export terms as a .apkg, streamed to the browser.

public export(array<string, string> $params) : never

Accepted parameters (any source — query string for GET, body for POST):

  • lang_id int target language; defaults to the current language
  • marked[] int[] optional subset of WoIDs; empty/missing = whole language
Parameters
$params : array<string, string>

Route params (unused).

Return values
never

importForm()

Render the import upload form (GET) or process the upload (POST).

public importForm(array<string, string> $params) : void
Parameters
$params : array<string, string>

Route params (unused).

setViewPath()

Set custom view path.

public setViewPath(string $path) : void
Parameters
$path : string

View path

render()

Render a view.

protected render(string $view[, array<string|int, mixed> $data = [] ]) : void
Parameters
$view : string

View name (without .php)

$data : array<string|int, mixed> = []

View data

slugify()

private slugify(string $name) : string
Parameters
$name : string
Return values
string

streamDownload()

private streamDownload(string $path, string $filename) : never
Parameters
$path : string
$filename : string
Return values
never
On this page

Search results