PHP Класс H2P\Converter\ConverterAbstract

Показать файл Открыть проект

Защищенные свойства (Protected)

Свойство Тип Описание
$options array Options available to the Converter

Открытые методы

Метод Описание
convert ( string | H2P\Request | H2P\TempFile $origin, string | H2P\TempFile $destination ) Convert the file, passing the right arguments to the Converter::transform (proxy pattern)
getOption ( $option ) : mixed Get an specific option
getOptions ( ) : array Return all the options set
setOption ( string $option, mixed $value ) : ConverterAbstract Set an option
setOptions ( array $options ) : ConverterAbstract Set multiple options from an array

Защищенные методы

Метод Описание
transform ( H2P\Request $origin, string $destination ) : boolean Convert the URI to destination with the specified options

Описание методов

convert() публичный Метод

Convert the file, passing the right arguments to the Converter::transform (proxy pattern)
public convert ( string | H2P\Request | H2P\TempFile $origin, string | H2P\TempFile $destination )
$origin string | H2P\Request | H2P\TempFile
$destination string | H2P\TempFile

getOption() публичный Метод

Get an specific option
public getOption ( $option ) : mixed
$option
Результат mixed

getOptions() публичный Метод

Return all the options set
public getOptions ( ) : array
Результат array

setOption() публичный Метод

Set an option
public setOption ( string $option, mixed $value ) : ConverterAbstract
$option string
$value mixed
Результат ConverterAbstract $this

setOptions() публичный Метод

Set multiple options from an array
public setOptions ( array $options ) : ConverterAbstract
$options array
Результат ConverterAbstract $this

transform() абстрактный защищенный Метод

Convert the URI to destination with the specified options
abstract protected transform ( H2P\Request $origin, string $destination ) : boolean
$origin H2P\Request
$destination string The destination full path
Результат boolean

Описание свойств

$options защищенное свойство

Options available to the Converter
protected array $options
Результат array