FilesystemHelper
File system helper
Holds support functions for the filesystem, particularly the stream
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper instead. |
| package |
Joomla CMS |
Methods
fileUploadMaxSize
Calculates the maximum upload file size and returns string with unit or the size in bytes
fileUploadMaxSize( unitOutput = true) : float|string
Call it with JFilesystemHelper::fileUploadMaxSize();
| since |
3.4 |
|---|
Arguments
- unitOutput
boolThis parameter determines whether the return value should be a string with a unit
Response
float|stringThe maximum upload size of files with the appropriate unit or in bytes
ftpChmod
Quick FTP chmod
ftpChmod( url, mode) :
| link | |
|---|---|
| since |
1.7.0 |
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::ftpChmod() instead. |
Arguments
- url
stringLink identifier- mode
intThe new permissions, given as an octal value.
Response
mixed
getFilters
Returns a list of filters
getFilters() : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::getFilters() instead. |
Response
array<string|int, mixed>
getJStreams
Returns a list of J! streams
getJStreams() : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::getJStreams() instead. |
Response
array<string|int, mixed>
getSupported
Stream and Filter Support Operations
getSupported() : mixed||string|int
Returns the supported streams, in addition to direct file access Also includes Joomla! streams as well as PHP streams
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::getSupported() instead. |
Response
array<string|int, mixed>Streams
getTransports
Returns a list of transports
getTransports() : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::getTransports() instead. |
Response
array<string|int, mixed>
getWriteModes
Modes that require a write operation
getWriteModes() : mixed||string|int
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::getWriteModes() instead. |
Response
array<string|int, mixed>
isJoomlaStream
Determine if a stream is a Joomla stream.
isJoomlaStream( streamname) :
| since |
1.7.0 |
|---|---|
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::isJoomlaStream() instead. |
Arguments
- streamname
stringThe name of a stream
Response
boolTrue for a Joomla Stream
parseSize
Returns the size in bytes without the unit for the comparison
parseSize( size) :
| since |
3.4 |
|---|
Arguments
- size
stringThe size which is received from the PHP settings
Response
floatThe size in bytes without the unit
parseSizeUnit
Creates the rounded size of the size with the appropriate unit
parseSizeUnit( maxSize) :
| since |
3.4 |
|---|
Arguments
- maxSize
floatThe maximum size which is allowed for the uploads
Response
stringString with the size and the appropriate unit
remotefsize
Remote file size function for streams that don't support it
remotefsize( url) :
| link | |
|---|---|
| since |
1.7.0 |
| deprecated |
4.4 will be removed in 6.0 Use Joomla\Filesystem\Helper::remotefsize() instead. |
Arguments
- url
stringLink identifier
Response
mixed