Overview

Namespaces

  • Contrib
    • Bundle
      • CoverallsBundle
        • Console
        • Entity
      • CoverallsV1Bundle
        • Api
        • Collector
        • Command
        • Config
        • Entity
          • Git
    • Component
      • File
      • Log
      • System
        • Git
  • Guzzle
    • Batch
      • Exception
    • Cache
    • Common
      • Exception
    • Http
      • Curl
      • Exception
      • Message
      • QueryAggregator
    • Inflection
    • Iterator
    • Log
    • Parser
      • Cookie
      • Message
      • UriTemplate
      • Url
    • Plugin
      • Async
      • Backoff
      • Cache
      • Cookie
        • CookieJar
        • Exception
      • CurlAuth
      • ErrorResponse
        • Exception
      • History
      • Log
      • Md5
      • Mock
      • Oauth
    • Service
      • Builder
      • Command
        • Factory
        • LocationVisitor
          • Request
          • Response
      • Description
      • Exception
      • Resource
    • Stream
  • PHP
  • Psr
    • Log
  • Symfony
    • Component
      • Config
        • Definition
          • Builder
          • Exception
        • Exception
        • Loader
        • Resource
        • Util
      • Console
        • Command
        • Formatter
        • Helper
        • Input
        • Output
        • Tester
      • EventDispatcher
        • Debug
      • Finder
        • Adapter
        • Comparator
        • Exception
        • Expression
        • Iterator
        • Shell
      • Stopwatch
      • Yaml
        • Exception

Classes

  • Path
  • Overview
  • Namespace
  • Class
  • Tree
  • Todo

Class Path

Path utils.

Namespace: Contrib\Component\File
Author: Kitamura Satoshi <with.no.parachute@gmail.com>
Located at Contrib/Component/File/Path.php
Methods summary
public boolean
# isRelativePath( string $path )

Return whether the path is relative path.

Return whether the path is relative path.

Parameters

$path
string
$path Path.

Returns

boolean
true if the path is relative path, false otherwise.
public string|false
# toAbsolutePath( string $path, string $rootDir )

Cat file path.

Cat file path.

Parameters

$path
string
$path File path.
$rootDir
string
$rootDir Absolute path to project root directory.

Returns

string|false
Absolute path.
public string|false
# getRealPath( string $path, string $rootDir )

Return real file path.

Return real file path.

Parameters

$path
string
$path File path.
$rootDir
string
$rootDir Absolute path to project root directory.

Returns

string|false
Real path string if the path string is passed and real path exists, false otherwise.
public string|false
# getRealDir( string $path, string $rootDir )

Return real directory path.

Return real directory path.

Parameters

$path
string
$path Path.
$rootDir
string
$rootDir Absolute path to project root directory.

Returns

string|false
Real directory path string if the path string is passed and real directory exists, false otherwise.
public string|false
# getRealWritingFilePath( string $path, string $rootDir )

Return real file path to write.

Return real file path to write.

Parameters

$path
string
$path File path.
$rootDir
string
$rootDir Absolute path to project root directory.

Returns

string|false
Real file path string if the parent directory exists, false otherwise.
public boolean
# isRealPathExist( string|boolean $realpath )

Return whether the real path exists.

Return whether the real path exists.

Parameters

$realpath
string|boolean
$realpath Real path.

Returns

boolean
true if the real path exists, false otherwise.
public boolean
# isRealFileExist( string|boolean $realpath )

Return whether the real file path exists.

Return whether the real file path exists.

Parameters

$realpath
string|boolean
$realpath Real file path.

Returns

boolean
true if the real file path exists, false otherwise.
public boolean
# isRealFileReadable( string|boolean $realpath )

Return whether the real file path is readable.

Return whether the real file path is readable.

Parameters

$realpath
string|boolean
$realpath Real file path.

Returns

boolean
true if the real file path is readable, false otherwise.
public boolean
# isRealFileWritable( string|boolean $realpath )

Return whether the real file path is writable.

Return whether the real file path is writable.

Parameters

$realpath
string|boolean
$realpath Real file path.

Returns

boolean
true if the real file path is writable, false otherwise.
public boolean
# isRealDirExist( string|boolean $realpath )

Return whether the real directory exists.

Return whether the real directory exists.

Parameters

$realpath
string|boolean
$realpath Real directory path.

Returns

boolean
true if the real directory exists, false otherwise.
public boolean
# isRealDirWritable( string|boolean $realpath )

Return whether the real directory is writable.

Return whether the real directory is writable.

Parameters

$realpath
string|boolean
$realpath Real directory path.

Returns

boolean
true if the real directory is writable, false otherwise.
php-coveralls API documentation generated by ApiGen 2.8.0