88 lines
2.1 KiB
PHP
88 lines
2.1 KiB
PHP
<?php
|
|
|
|
interface stTaskSchedulerImportConfigurationInterface
|
|
{
|
|
/**
|
|
* Zwraca id importu
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getId(): string;
|
|
|
|
/**
|
|
* Zwraca hash id importu (używany głównie przy operacjach na modelu)
|
|
*
|
|
* @return integer
|
|
*/
|
|
public function getHashId(): int;
|
|
|
|
/**
|
|
* Zwraca nazwę importu
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getLabel(): string;
|
|
|
|
/**
|
|
* Zwraca klase importu
|
|
*
|
|
* @return string
|
|
*/
|
|
public function getClass(): string;
|
|
|
|
/**
|
|
* Zwraca wartość dodatkowej opcji
|
|
*
|
|
* @param string $name Nazwa opcji
|
|
* @return array|string|int|float|bool
|
|
*/
|
|
public function getOption(string $name);
|
|
|
|
/**
|
|
* Zwraca wartość dodatkowej opcji zapisanej w konfiguracji użytkownika dla danego importu
|
|
*
|
|
* @param string $name Nazwa opcji
|
|
* @param array|string|int|float|bool $default Domyślna wartość dla opcji w przypadku jej braku
|
|
* @return array|string|int|float|bool
|
|
*/
|
|
public function getUserOption(string $name, $default = null);
|
|
|
|
/**
|
|
* Sprawdza czy dana opcja konfiguracyjna jest dostępna
|
|
*
|
|
* @param string $name Nazwa opcji
|
|
* @return bool
|
|
*/
|
|
public function with(string $name): bool;
|
|
|
|
/**
|
|
* Zwraca domyślną wartość dla opcji z konfiguracji importu
|
|
*
|
|
* @param string $name Nazwa opcji
|
|
* @return array|string|int|float|bool
|
|
*/
|
|
public function getDefault(string $name);
|
|
|
|
/**
|
|
* Sprawdza czy dany import jest włączony
|
|
*
|
|
* @return bool
|
|
*/
|
|
public function isActive(): bool;
|
|
|
|
/**
|
|
* Zwraca konfiguracja importu głównego
|
|
*
|
|
* @return stTaskSchedulerImportConfigurationInterface
|
|
*/
|
|
public function getParent(): ?stTaskSchedulerImportConfigurationInterface;
|
|
|
|
/**
|
|
* Zwraca konfiguracje importów zależnych
|
|
*
|
|
* @return stTaskSchedulerImportConfigurationInterface[]
|
|
*/
|
|
public function getChildren(): array;
|
|
|
|
public function getAuthentication(): string;
|
|
} |