feature-php
Back to top  

A file's content.

Because different types of files are supported (\FeaturePhp\File\TextFile and \FeaturePhp\File\StoredFile in particular), file content is represented in its own class, not as a string.

package Default

 Methods

Adds the file's content to a ZIP archive.

addToZip(\ZipArchive $zip, string $target) 

This is expected to be called only be a \FeaturePhp\Exporter\ZipExporter.

Parameters

$zip

\ZipArchive

$target

string

the file target in the ZIP archive

Copies file's content to the local filesystem.

copy(string $target) 

This is expected to be called only be a \FeaturePhp\Exporter\LocalExporter.

Parameters

$target

string

the file target in the filesystem

Returns a summary of the file's content.

getSummary() : string

The summary should be suitable for an overview of generated files, but does not necessarily contain the complete file content.

Returns

string