Silla.IO API
  • Namespace
  • Class
  • Tree
  • Todo
  • Download

Namespaces

  • App
    • Controllers
  • CMS
    • Controllers
    • Helpers
    • Models
  • Configurations
    • CI
    • Development
    • Production
    • Staging
  • Core
    • Base
    • CLI
      • Cache
      • DB
    • Helpers
    • Modules
      • Cache
        • Adapters
        • Interfaces
      • Crypt
      • DB
        • Adapters
        • Decorators
          • Interfaces
        • Features
          • Paginator
        • Interfaces
      • Registry
      • Render
        • Adapters
        • Interfaces
      • Router
      • Session
        • Adapters
        • Interfaces
  • None
  • Tasks
    • DB

Classes

  • DateTime
  • Directory
  • File
  • Image
  • Mailer
  • SQL
  • YAML

Class File

Contains helper methods concerned with file manipulation.

Namespace: Core\Helpers
Used by: Core\Modules\Cache\Adapters\FileSystem::store()
Located at helpers/file.php

Methods summary

public static integer
# putContents( string $path, mixed $content )

Write a string to a file.

Write a string to a file.

Parameters

$path
Full or relative path to file.
$content
Content to be persisted.

Returns

integer
Number of bytes written to the file, or FALSE on failure.

Uses

self::getFullPath To format path to file.
Directory::create To create a directory for the file, if necessary.
public static string
# getContents( string $path )

Reads a file into a string.

Reads a file into a string.

Parameters

$path
Full or relative path to file.

Returns

string
The read data.

Throws

InvalidArgumentException
If path does not lead to a file.

Uses

self::getFullPath To format path to file.
public static string
# getContentsCurl( string $url, array $credentials = array() )

Fetches an external file.

Fetches an external file.

Parameters

$url
URI of the file resource.
$credentials

Optional parameter to deal with Basic Authentication ['user' => '', 'password' => ''].

Returns

string
Content of the file.

Throws

UnexpectedValueException
If PHP extension cURL is not enabled.
public static boolean
# delete( string $path )

Deletes a file.

Deletes a file.

Parameters

$path
Full or relative path to file.

Returns

boolean
Result of the operation.

Throws

InvalidArgumentException
If path does not lead to a file.

Uses

self::getFullPath To format path to file.
public static integer
# copy( string $from, string $to )

Copies a file to another destination.

Copies a file to another destination.

Parameters

$from
Full or relative path to file.
$to
Full or relative path to destination.

Returns

integer
Number of bytes written to the file, or FALSE on failure.

Uses

self::getRestrictedPath To format path to file.
Directory::create To create a directory for the file, if necessary.

Todo

Consider using built-in copy function.
public static boolean
# upload( array $file, string $directory, string $saveName = null )

Uploads a file.

Uploads a file.

Parameters

$file
Value from $_FILES.
$directory
Full path to storage.
$saveName
Filename in storage.

Returns

boolean
If the file was successfully uploaded.

Throws

DomainException
If upload file is not valid or cannot be moved.

Uses

self::filterFilename To filter the filename used in storage.
Directory::create() To create a directory for the file, if necessary.
public static boolean
# validate( array $file, array $allowedTypes, integer $maxAllowedSize )

Validates a file by allowed size and MIME types.

Validates a file by allowed size and MIME types.

Parameters

$file
Value from $_FILES.
$allowedTypes
Allowed MIME types of the file.
$maxAllowedSize
Maximum allowed file size in kilobytes.

Returns

boolean
TRUE if file is within allowed max size and MIME types, FALSE otherwise.

Throws

InvalidArgumentException
If path does not lead to a file.

Uses

self::isValidMimeType To check if file is one of the allowed MIME types.

Todo

Distinct the errors from size and type.
private static boolean
# isValidMimeType( array $file, string $type )

Checks if a file is of certain MIME type.

Checks if a file is of certain MIME type.

Parameters

$file
Value from $_FILES.
$type
MIME type to check against.

Returns

boolean
Result of the operation.

Throws

InvalidArgumentException
If invalid MIME type is provided.

Uses

self::getMimeType To retrieve the MIME type of the file.
private static string
# getMimeType( array $file )

Gets the MIME type of a file.

Gets the MIME type of a file.

Parameters

$file
Value from $_FILES.

Returns

string
MIME Type.

See

http://php.net/manual/en/fileinfo.installation.php If using PHP versions prior to 5.3+.
public static string
# filterFilename( string $filename )

Filters a filename.

Filters a filename.

Parameters

$filename
Name of the file to filter.

Returns

string
Filtered filename.
public static string
# formatFilename( string $filename, string $uploadedFile )

Adds an extension to a filename, if not present. The file extension is taken from uploadedFile.

Adds an extension to a filename, if not present. The file extension is taken from uploadedFile.

Parameters

$filename
Name of the file to format.
$uploadedFile
Name of the file that is currently uploading.

Returns

string
Formatted filename.
public static boolean
# uploadedFileExists( string $filename )

Check uploaded file exists.

Check uploaded file exists.

Parameters

$filename
Name of the file.

Returns

boolean
Result of the operation.

Todo

Perhaps use is_uploaded_file() But accepts tmp_name only.
public static string
# getRestrictedPath( string $path )

Fetches a restricted path.

Fetches a restricted path.

Parameters

$path
Path to file.

Returns

string
Restricted path.

Uses

self::getFullPath To format path to file.
public static string
# getFullPath( string $path )

Formats a (relative) path to full path.

Formats a (relative) path to full path.

Parameters

$path
File path.

Returns

string
Full path.

Uses

Core\Base\Configuration::paths To get root path of framework.

Properties summary

protected static array $errors

Errors container.

Errors container.

# array()
public static array $mimeTypeList

Mime types list.

Mime types list.

# array( '323' => 'text/h323', 'acx' => 'application/internet-property-stream', 'ai' => 'application/postscript', 'aif' => 'audio/x-aiff', 'aifc' => 'audio/x-aiff', 'aiff' => 'audio/x-aiff', 'asf' => 'video/x-ms-asf', 'asr' => 'video/x-ms-asf', 'asx' => 'video/x-ms-asf', 'au' => 'audio/basic', 'avi' => 'video/x-msvideo', 'axs' => 'application/olescript', 'bas' => 'text/plain', 'bcpio' => 'application/x-bcpio', 'bin' => 'application/octet-stream', 'bmp' => 'image/bmp', 'c' => 'text/plain', 'cat' => 'application/vnd.ms-pkiseccat', 'cdf' => 'application/x-cdf', 'cer' => 'application/x-x509-ca-cert', 'class' => 'application/octet-stream', 'clp' => 'application/x-msclip', 'cmx' => 'image/x-cmx', 'cod' => 'image/cis-cod', 'cpio' => 'application/x-cpio', 'crd' => 'application/x-mscardfile', 'crl' => 'application/pkix-crl', 'crt' => 'application/x-x509-ca-cert', 'csh' => 'application/x-csh', 'css' => 'text/css', 'csv' => 'text/plain', 'dcr' => 'application/x-director', 'der' => 'application/x-x509-ca-cert', 'dir' => 'application/x-director', 'dll' => 'application/x-msdownload', 'dms' => 'application/octet-stream', 'doc' => 'application/msword', 'dot' => 'application/msword', 'dvi' => 'application/x-dvi', 'dxr' => 'application/x-director', 'eps' => 'application/postscript', 'etx' => 'text/x-setext', 'evy' => 'application/envoy', 'exe' => 'application/octet-stream', 'fif' => 'application/fractals', 'flr' => 'x-world/x-vrml', 'gif' => 'image/gif', 'gtar' => 'application/x-gtar', 'gz' => 'application/x-gzip', 'h' => 'text/plain', 'hdf' => 'application/x-hdf', 'hlp' => 'application/winhlp', 'hqx' => 'application/mac-binhex40', 'hta' => 'application/hta', 'htc' => 'text/x-component', 'htm' => 'text/html', 'html' => 'text/html', 'htt' => 'text/webviewhtml', 'ico' => 'image/x-icon', 'ief' => 'image/ief', 'iii' => 'application/x-iphone', 'ins' => 'application/x-internet-signup', 'isp' => 'application/x-internet-signup', 'jfif' => 'image/pipeg', 'jpe' => 'image/jpeg', 'jpeg' => 'image/jpeg', 'jpg' => 'image/jpeg', 'js' => 'application/x-javascript', 'latex' => 'application/x-latex', 'lha' => 'application/octet-stream', 'lsf' => 'video/x-la-asf', 'lsx' => 'video/x-la-asf', 'lzh' => 'application/octet-stream', 'm13' => 'application/x-msmediaview', 'm14' => 'application/x-msmediaview', 'm3u' => 'audio/x-mpegurl', 'man' => 'application/x-troff-man', 'mdb' => 'application/x-msaccess', 'me' => 'application/x-troff-me', 'mht' => 'message/rfc822', 'mhtml' => 'message/rfc822', 'mid' => 'audio/mid', 'mny' => 'application/x-msmoney', 'mov' => 'video/quicktime', 'movie' => 'video/x-sgi-movie', 'mp2' => 'video/mpeg', 'mp3' => 'audio/mpeg', 'mpa' => 'video/mpeg', 'mpe' => 'video/mpeg', 'mpeg' => 'video/mpeg', 'mpg' => 'video/mpeg', 'mpp' => 'application/vnd.ms-project', 'mpv2' => 'video/mpeg', 'ms' => 'application/x-troff-ms', 'mvb' => 'application/x-msmediaview', 'nws' => 'message/rfc822', 'oda' => 'application/oda', 'p10' => 'application/pkcs10', 'p12' => 'application/x-pkcs12', 'p7b' => 'application/x-pkcs7-certificates', 'p7c' => 'application/x-pkcs7-mime', 'p7m' => 'application/x-pkcs7-mime', 'p7r' => 'application/x-pkcs7-certreqresp', 'p7s' => 'application/x-pkcs7-signature', 'pbm' => 'image/x-portable-bitmap', 'pdf' => 'application/pdf', 'pfx' => 'application/x-pkcs12', 'pgm' => 'image/x-portable-graymap', 'pko' => 'application/ynd.ms-pkipko', 'pma' => 'application/x-perfmon', 'pmc' => 'application/x-perfmon', 'pml' => 'application/x-perfmon', 'pmr' => 'application/x-perfmon', 'pmw' => 'application/x-perfmon', 'pnm' => 'image/x-portable-anymap', 'png' => 'image/png', 'pot' => 'application/vnd.ms-powerpoint', 'ppm' => 'image/x-portable-pixmap', 'pps' => 'application/vnd.ms-powerpoint', 'ppt' => 'application/vnd.ms-powerpoint', 'prf' => 'application/pics-rules', 'ps' => 'application/postscript', 'pub' => 'application/x-mspublisher', 'qt' => 'video/quicktime', 'ra' => 'audio/x-pn-realaudio', 'ram' => 'audio/x-pn-realaudio', 'ras' => 'image/x-cmu-raster', 'rgb' => 'image/x-rgb', 'rmi' => 'audio/mid', 'roff' => 'application/x-troff', 'rtf' => 'application/rtf', 'rtx' => 'text/richtext', 'scd' => 'application/x-msschedule', 'sct' => 'text/scriptlet', 'setpay' => 'application/set-payment-initiation', 'setreg' => 'application/set-registration-initiation', 'sh' => 'application/x-sh', 'shar' => 'application/x-shar', 'sit' => 'application/x-stuffit', 'snd' => 'audio/basic', 'spc' => 'application/x-pkcs7-certificates', 'spl' => 'application/futuresplash', 'src' => 'application/x-wais-source', 'sst' => 'application/vnd.ms-pkicertstore', 'stl' => 'application/vnd.ms-pkistl', 'stm' => 'text/html', 'svg' => 'image/svg+xml', 'sv4cpio' => 'application/x-sv4cpio', 'sv4crc' => 'application/x-sv4crc', 't' => 'application/x-troff', 'tar' => 'application/x-tar', 'tcl' => 'application/x-tcl', 'tex' => 'application/x-tex', 'texi' => 'application/x-texinfo', 'texinfo' => 'application/x-texinfo', 'tgz' => 'application/x-compressed', 'tif' => 'image/tiff', 'tiff' => 'image/tiff', 'tr' => 'application/x-troff', 'trm' => 'application/x-msterminal', 'tsv' => 'text/tab-separated-values', 'txt' => 'text/plain', 'uls' => 'text/iuls', 'ustar' => 'application/x-ustar', 'vcf' => 'text/x-vcard', 'vrml' => 'x-world/x-vrml', 'wav' => 'audio/x-wav', 'wcm' => 'application/vnd.ms-works', 'wdb' => 'application/vnd.ms-works', 'wks' => 'application/vnd.ms-works', 'wmf' => 'application/x-msmetafile', 'wps' => 'application/vnd.ms-works', 'wri' => 'application/x-mswrite', 'wrl' => 'x-world/x-vrml', 'wrz' => 'x-world/x-vrml', 'xaf' => 'x-world/x-vrml', 'xbm' => 'image/x-xbitmap', 'xla' => 'application/vnd.ms-excel', 'xlc' => 'application/vnd.ms-excel', 'xlm' => 'application/vnd.ms-excel', 'xls' => 'application/vnd.ms-excel', 'xlt' => 'application/vnd.ms-excel', 'xlw' => 'application/vnd.ms-excel', 'xof' => 'x-world/x-vrml', 'xpm' => 'image/x-xpixmap', 'xwd' => 'image/x-xwindowdump', 'z' => 'application/x-compress', 'zip' => 'application/zip', )
Silla.IO API API documentation generated by ApiGen