League\Flysystem\Util Class Reference

Collaboration diagram for League\Flysystem\Util:

Static Public Member Functions
static	pathinfo ($path)
	Get normalized pathinfo. More...
static	normalizeDirname ($dirname)
	Normalize a dirname return value. More...
static	dirname ($path)
	Get a normalized dirname from a path. More...
static	map (array $object, array $map)
	Map result arrays. More...
static	normalizePath ($path)
	Normalize path. More...
static	normalizeRelativePath ($path)
	Normalize relative directories in a path. More...
static	normalizePrefix ($prefix, $separator)
	Normalize prefix. More...
static	contentSize ($contents)
	Get content size. More...
static	guessMimeType ($path, $content)
	Guess MIME Type based on the path of the file and it's content. More...
static	emulateDirectories (array $listing)
	Emulate directories. More...
static	ensureConfig ($config)
	Ensure a Config instance. More...
static	rewindStream ($resource)
	Rewind a stream. More...
static	isSeekableStream ($resource)
static	getStreamSize ($resource)
	Get the size of a stream. More...

Static Protected Member Functions
static	removeFunkyWhiteSpace ($path)
	Removes unprintable characters and invalid unicode characters. More...
static	emulateObjectDirectories (array $object, array $directories, array $listedDirectories)
	Emulate the directories of a single object. More...

Detailed Description

Definition at line 8 of file Util.php.

Member Function Documentation

contentSize()

static League\Flysystem\Util::contentSize (   $contents )

static

Get content size.

Parameters

string

$contents

Returns

int content size

Definition at line 164 of file Util.php.

References $contents, and defined.

    {
        return defined('MB_OVERLOAD_STRING') ? mb_strlen($contents, '8bit') : strlen($contents);
    }

dirname()

static League\Flysystem\Util::dirname (   $path )

static

Get a normalized dirname from a path.

Parameters

string

$path

Returns

string dirname

Definition at line 45 of file Util.php.

References $path.

Referenced by League\Flysystem\Util\ContentListingFormatter\isDirectChild(), League\Flysystem\Adapter\Local\rename(), and League\Flysystem\Adapter\Ftp\writeStream().

    {
        return static::normalizeDirname(dirname($path));
    }

Here is the caller graph for this function:

emulateDirectories()

static League\Flysystem\Util::emulateDirectories ( array  $listing )

static

Emulate directories.

Parameters

array

$listing

Returns

array listing with emulated directories

Definition at line 195 of file Util.php.

    {
        $directories = [];
        $listedDirectories = [];

        foreach ($listing as $object) {
            list($directories, $listedDirectories) = static::emulateObjectDirectories(
                $object,
                $directories,
                $listedDirectories
            );
        }

        $directories = array_diff(array_unique($directories), array_unique($listedDirectories));

        foreach ($directories as $directory) {
            $listing[] = static::pathinfo($directory) + ['type' => 'dir'];
        }

        return $listing;
    }

emulateObjectDirectories()

static League\Flysystem\Util::emulateObjectDirectories ( array  $object, array  $directories, array  $listedDirectories  )

staticprotected

Emulate the directories of a single object.

Parameters

array	$object
array	$directories
array	$listedDirectories

Returns

array

Definition at line 285 of file Util.php.

    {
        if ($object['type'] === 'dir') {
            $listedDirectories[] = $object['path'];
        }

        if (empty($object['dirname'])) {
            return [$directories, $listedDirectories];
        }

        $parent = $object['dirname'];

        while ( ! empty($parent) && ! in_array($parent, $directories)) {
            $directories[] = $parent;
            $parent = static::dirname($parent);
        }

        if (isset($object['type']) && $object['type'] === 'dir') {
            $listedDirectories[] = $object['path'];

            return [$directories, $listedDirectories];
        }

        return [$directories, $listedDirectories];
    }

ensureConfig()

static League\Flysystem\Util::ensureConfig (   $config )

static

Ensure a Config instance.

Parameters

null | array | Config

$config

Returns

Config config instance

Exceptions

LogicException

Definition at line 226 of file Util.php.

References $config.

Referenced by League\Flysystem\setConfig().

    {
        if ($config === null) {
            return new Config();
        }

        if ($config instanceof Config) {
            return $config;
        }

        if (is_array($config)) {
            return new Config($config);
        }

        throw new LogicException('A config should either be an array or a Flysystem\Config object.');
    }

Here is the caller graph for this function:

getStreamSize()

static League\Flysystem\Util::getStreamSize (   $resource )

static

Get the size of a stream.

Parameters

resource

$resource

Returns

int stream size

Definition at line 269 of file Util.php.

    {
        $stat = fstat($resource);

        return $stat['size'];
    }

guessMimeType()

static League\Flysystem\Util::guessMimeType (   $path,   $content  )

static

Guess MIME Type based on the path of the file and it's content.

Parameters

string	$path
string | resource	$content

Returns

string|null MIME Type or NULL if no extension detected

Definition at line 177 of file Util.php.

References $path, League\Flysystem\Util\MimeType\detectByContent(), and League\Flysystem\Util\MimeType\detectByFilename().

Referenced by League\Flysystem\Adapter\Local\update(), and League\Flysystem\Adapter\Ftp\write().

    {
        $mimeType = MimeType::detectByContent($content);

        if ( ! (empty($mimeType) || in_array($mimeType, ['application/x-empty', 'text/plain', 'text/x-asm']))) {
            return $mimeType;
        }

        return MimeType::detectByFilename($path);
    }

Here is the call graph for this function:

Here is the caller graph for this function:

isSeekableStream()

static League\Flysystem\Util::isSeekableStream (   $resource )

static

Definition at line 255 of file Util.php.

References $metadata.

    {
        $metadata = stream_get_meta_data($resource);

        return $metadata['seekable'];
    }

map()

static League\Flysystem\Util::map ( array  $object, array  $map  )

static

Map result arrays.

Parameters

array	$object
array	$map

Returns

array mapped result

Definition at line 58 of file Util.php.

References $from, and $result.

    {
        $result = [];

        foreach ($map as $from => $to) {
            if ( ! isset($object[$from])) {
                continue;
            }

            $result[$to] = $object[$from];
        }

        return $result;
    }

normalizeDirname()

static League\Flysystem\Util::normalizeDirname (   $dirname )

static

Normalize a dirname return value.

Parameters

string

$dirname

Returns

string normalized dirname

Definition at line 33 of file Util.php.

    {
        return $dirname === '.' ? '' : $dirname;
    }

normalizePath()

static League\Flysystem\Util::normalizePath (   $path )

static

Normalize path.

Parameters

string

$path

Exceptions

LogicException

Returns

string

Definition at line 82 of file Util.php.

References $path.

Referenced by League\Flysystem\Filesystem\copy(), League\Flysystem\Filesystem\createDir(), League\Flysystem\Filesystem\delete(), League\Flysystem\Filesystem\deleteDir(), League\Flysystem\Filesystem\get(), League\Flysystem\Filesystem\getMetadata(), League\Flysystem\Filesystem\getMimetype(), League\Flysystem\Filesystem\getSize(), League\Flysystem\Filesystem\getTimestamp(), League\Flysystem\Filesystem\getVisibility(), League\Flysystem\Filesystem\has(), League\Flysystem\Filesystem\listContents(), League\Flysystem\Filesystem\put(), League\Flysystem\Filesystem\putStream(), League\Flysystem\Filesystem\read(), League\Flysystem\Filesystem\readAndDelete(), League\Flysystem\Filesystem\readStream(), League\Flysystem\Filesystem\rename(), League\Flysystem\Filesystem\setVisibility(), League\Flysystem\Filesystem\update(), League\Flysystem\Filesystem\updateStream(), League\Flysystem\Filesystem\write(), and League\Flysystem\Filesystem\writeStream().

    {
        return static::normalizeRelativePath($path);
    }

Here is the caller graph for this function:

normalizePrefix()

static League\Flysystem\Util::normalizePrefix (   $prefix,   $separator  )

static

Normalize prefix.

Parameters

string	$prefix
string	$separator

Returns

string normalized path

Definition at line 152 of file Util.php.

    {
        return rtrim($prefix, $separator) . $separator;
    }

normalizeRelativePath()

static League\Flysystem\Util::normalizeRelativePath (   $path )

static

Normalize relative directories in a path.

Parameters

string

$path

Exceptions

LogicException

Returns

string

Definition at line 96 of file Util.php.

References $path.

    {
        $path = str_replace('\\', '/', $path);
        $path = static::removeFunkyWhiteSpace($path);

        $parts = [];

        foreach (explode('/', $path) as $part) {
            switch ($part) {
                case '':
                case '.':
                break;

            case '..':
                if (empty($parts)) {
                    throw new LogicException(
                        'Path is outside of the defined root, path: [' . $path . ']'
                    );
                }
                array_pop($parts);
                break;

            default:
                $parts[] = $part;
                break;
            }
        }

        return implode('/', $parts);
    }

pathinfo()

static League\Flysystem\Util::pathinfo (   $path )

static

Get normalized pathinfo.

Parameters

string

$path

Returns

array pathinfo

Definition at line 17 of file Util.php.

References $path.

Referenced by League\Flysystem\Util\ContentListingFormatter\addPathInfo(), and League\Flysystem\Util\MimeType\detectByFilename().

    {
        $pathinfo = pathinfo($path) + compact('path');
        $pathinfo['dirname'] = array_key_exists('dirname', $pathinfo)
            ? static::normalizeDirname($pathinfo['dirname']) : '';

        return $pathinfo;
    }

Here is the caller graph for this function:

removeFunkyWhiteSpace()

static League\Flysystem\Util::removeFunkyWhiteSpace (   $path )

staticprotected

Removes unprintable characters and invalid unicode characters.

Parameters

string

$path

Returns

string $path

Definition at line 134 of file Util.php.

References $path.

                                                           {
        // We do this check in a loop, since removing invalid unicode characters
        // can lead to new characters being created.
        while (preg_match('#\p{C}+|^\./#u', $path)) {
            $path = preg_replace('#\p{C}+|^\./#u', '', $path);
        }

        return $path;
    }

rewindStream()

static League\Flysystem\Util::rewindStream (   $resource )

static

Rewind a stream.

Parameters

resource

$resource

Definition at line 248 of file Util.php.

Referenced by League\Flysystem\Filesystem\putStream(), League\Flysystem\Filesystem\updateStream(), and League\Flysystem\Filesystem\writeStream().

    {
        if (ftell($resource) !== 0 && static::isSeekableStream($resource)) {
            rewind($resource);
        }
    }

Here is the caller graph for this function:

---

The documentation for this class was generated from the following file:

• libs/composer/vendor/league/flysystem/src/Util.php