v-technologies/transformist

File conversion library

Transformist

Transformist is a PHP file conversion library. It provides a high level API to convert files into different formats painlessly., _(*1)

It is also designed to be easily extended, just by adding custom converters., _(*2)

Example

Here is what you could do to convert every word documents to PDF files in a directory:, _(*3)

setup(
    '/path/to/directory',
    'application/msword',
    'application/pdf'
);

if ( $Transformist->run( )) {
    // You're good to go !
}

?>

You can use the setup( ) method in different ways to convert multiple documents in one pass:, _(*4)

setup(
    array( '/path/to/input/directory' => '/path/to/output/directory' ),
    'application/msword',
    'application/pdf'
);


// Conversion of a particular file

$Transformist->setup(
    '/path/to/directory',
    'file.doc',
    'application/pdf'
);


// All files matching a pattern

$Transformist->setup(
    '/path/to/directory',
    '*.doc',
    'application/pdf'
);


// Multiple conversions

$Transformist->setup(
    '/path/to/directory',
    array(
        '*.doc'     => 'application/pdf',
        'image/jpg' => 'image/png'
    )
);

?>

Available conversions

Before going any further, you may want to know about the conversions that Transformist can handle. There's a method for that:, _(*5)

availableConversions( );

?>

This method returns an array of all possible conversions. Each of its key represents an input type, and points to an array of output types., _(*6)

Typically, it looks like this:, _(*7)

 array(
        'image/png'
    ),
    'image/png' => array(
        'image/tiff'
    )
);

?>

Here you can convert JPG images to PNG, and PNG images to TIFF., _(*8)

Test

Transformist provides a way to check all converters for validity. Some could be runnable without further configuration, while others could rely on external librairies that must be installed for the converter to work., _(*9)

testConverters( );

// Or statically:

$results = Transformist::testConverters( );

?>

$results now looks like this:, _(*10)

 true,
    'Transformist_Converter_Office_Png' => 'An external library is missing!',
    'Transformist_Converter_Office_Tiff' => true
);

?>

You should run this function only once when configuring your system or troubleshooting errors, as some converters could do some heavy computation to test their environment., _(*11)