Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:controller:importcontroller

This is an old revision of the document!


ImportController

Layer: Controller · Source: lib/controller/ImportController.php:26 (lines 26–299)


final class ImportController extends BaseApp

ImportController

Controller for handling import operations from admin panel

Docblock Metadata

^ Tag ^ Value ^
| ''@category'' | Controller Class |
| ''@author'' | M.Noermoehammad |
| ''@license'' | MIT |
| ''@version'' | 1.0 |
| ''@since'' | Since Release 1.0 |

Inheritance

^ Relation ^ Type ^ Meaning ^
| extends | [[scriptlog:lib:core:baseapp|''BaseApp'']] | parent class/interface |

Constants (0)

None.

Properties (2)

^ Visibility ^ Type ^ Name ^ Default ^ Line ^
| ''private'' | ''(untyped)'' | ''$error'' | ''[];'' | 42 |
| ''private'' | ''(untyped)'' | ''$success'' | ''[];'' | 43 |

Methods (10)

^ Visibility ^ Method ^ Summary ^ Line ^
| public | ''__construct()'' | ImportController constructor. | 50 |
| protected | ''listItems()'' | List items - not used for import | 60 |
| public | ''insert()'' | Insert - not used for import | 70 |
| public | ''update()'' | Update - not used for import | 81 |
| public | ''remove()'' | Remove - not used for import | 92 |
| public | ''index()'' | Render import page | 102 |
| public | ''import()'' | Handle import request | 124 |
| public | ''preview()'' | Preview import data | 228 |
| protected | ''setView()'' | Set view | 281 |
| private | ''getCurrentAuthorId()'' | Get current author ID from session | 291 |

__construct()

public function __construct(MigrationService $migrationService)

lines 50–53 (4)

ImportController constructor.

^ Parameter ^ Type ^ Default ^ Description ^
| ''$migrationService'' | [[scriptlog:lib:service:migrationservice|''MigrationService'']] | //required// | Business logic for import operations |

listItems()

protected function listItems()

lines 60–63 (4)

List items - not used for import

Takes no parameters.

Returns: (none declared) — string

insert()

public function insert()

lines 70–73 (4)

Insert - not used for import

Takes no parameters.

Returns: (none declared) — string

update()

public function update($id = null)

lines 81–84 (4)

Update - not used for import

^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared) — string

remove()

public function remove($id = null)

lines 92–95 (4)

Remove - not used for import

^ Parameter ^ Type ^ Default ^ Description ^
| ''$id'' | ''(untyped)'' | ''null'' | //none// |

Returns: (none declared) — string

index()

public function index()

lines 102–117 (16)

Render import page

Takes no parameters.

Returns: (none declared) — string

import()

public function import()

lines 124–221 (98)

Handle import request

Takes no parameters.

Returns: (none declared) — string

preview()

public function preview()

lines 228–274 (47)

Preview import data

Takes no parameters.

Returns: (none declared) — string

setView()

protected function setView($_viewName)

lines 281–284 (4)

Set view

^ Parameter ^ Type ^ Default ^ Description ^
| ''$_viewName'' | ''(untyped)'' | //required// | //none// |

Returns: (none declared)

getCurrentAuthorId()

private function getCurrentAuthorId()

lines 291–298 (8)

Get current author ID from session

Takes no parameters.

Returns: (none declared) — int

Imports

^ Alias ^ Fully-qualified name ^
| ''BaseApp'' | [[scriptlog:lib:core:baseapp|''Scriptlog\Core\BaseApp'']] |
| ''Session'' | [[scriptlog:lib:core:session|''Scriptlog\Core\Session'']] |
| ''View'' | [[scriptlog:lib:core:view|''Scriptlog\Core\View'']] |
| ''MigrationService'' | [[scriptlog:lib:service:migrationservice|''Scriptlog\Service\MigrationService'']] |

This page is generated from source by 'tools/gendoc'. Edits will be overwritten.

scriptlog/lib/controller/importcontroller.1790413759.txt.gz · Last modified: by admin