112 lines
2.5 KiB
PHP
112 lines
2.5 KiB
PHP
<?php
|
|
|
|
interface stTaskSchedulerImportInterface
|
|
{
|
|
/**
|
|
* Zwraca odpowiedni rodzaj czytnika danych
|
|
*
|
|
* @return stTaskSchedulerImportReaderInterface
|
|
*/
|
|
public function initializeReader(): stTaskSchedulerImportReaderInterface;
|
|
|
|
/**
|
|
* Zwraca nową instancję downloader'a plików
|
|
*
|
|
* @return stFileDownloader
|
|
*/
|
|
public function createFileDownloader(): stFileDownloader;
|
|
|
|
/**
|
|
* Zwraca ilość danych do zaimportowania
|
|
*
|
|
* @return int
|
|
*/
|
|
public function count(): int;
|
|
|
|
/**
|
|
* Wykonuje import danych
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function execute(): bool;
|
|
|
|
/**
|
|
* Metoda wywoływana po zakończeniu importu
|
|
*
|
|
* @return void
|
|
*/
|
|
public function finished(): void;
|
|
|
|
/**
|
|
* Metoda wywoływana przed rozpoczęciem importu
|
|
*
|
|
* @return void
|
|
*/
|
|
public function started(): void;
|
|
|
|
/**
|
|
* Zwraca aktualną pozycję odczytanych danych
|
|
*
|
|
* @return int
|
|
*/
|
|
public function getOffset(): int;
|
|
|
|
/**
|
|
* Ustawia aktualna pozycję dla odczytywanych danych
|
|
*
|
|
* @param int $offset
|
|
* @return void
|
|
*/
|
|
public function setOffset(int $offset): void;
|
|
|
|
/**
|
|
* Zwraca rozszerzenie importowanego pliku
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getFiletypeExtension(): string;
|
|
|
|
/**
|
|
* Zwraca wartość konfiguracji użytkownika importu dla danego prametru
|
|
*
|
|
* @param string $name Nazwa parametru
|
|
* @param string|array|string|int|float|bool $default Domyśna wartość
|
|
* @return string|array|string|int|float|bool
|
|
*/
|
|
public function getConfigurationParameter(string $name, $default = null);
|
|
|
|
/**
|
|
* Zwraca konfiguracje importu
|
|
*
|
|
* @return stTaskSchedulerImportConfigurationInterface
|
|
*/
|
|
public function getConfiguration(): stTaskSchedulerImportConfigurationInterface;
|
|
|
|
/**
|
|
* Otwiera plik importu
|
|
*
|
|
* @param string $file
|
|
* @return bool
|
|
*/
|
|
public function open(string $file): bool;
|
|
|
|
/**
|
|
* Weryfikuje poprawność formatu pliku importu
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isValid(): bool;
|
|
|
|
/**
|
|
* Zamyka plik importu
|
|
* @return void
|
|
*/
|
|
public function close(): void;
|
|
|
|
/**
|
|
* Sprawdza czy import jest gotowy do wykonania (oczekuje na wykonanie)
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isReadyToExecute(): bool;
|
|
} |