PHP Interface Yosymfony\Spress\Core\ContentManager\Converter\ConverterInterface

Converters extend Spress to support new type of content.
Author: Victor Puertas ([email protected])
Datei anzeigen Open project: spress/spress Interface Usage Examples

Public Methods

Method Description
convert ( string $input ) : string Convert the input data.
getOutExtension ( string $extension ) : string The extension of filename result (without dot). E.g: html.
getPriority ( ) : integer Get the priority of converter.
matches ( string $extension ) : boolean If file's extension is support by converter.

Method Details

convert() public method

Convert the input data.
public convert ( string $input ) : string
$input string The raw content without Front-matter
return string

getOutExtension() public method

The extension of filename result (without dot). E.g: html.
public getOutExtension ( string $extension ) : string
$extension string File's extension
return string

getPriority() public method

Get the priority of converter.
public getPriority ( ) : integer
return integer Value between 0 to 10. Greater means higher priority

matches() public method

If file's extension is support by converter.
public matches ( string $extension ) : boolean
$extension string Extension without dot
return boolean