Overview

Namespaces

  • Coast
    • App
      • Access
      • Executable
    • Controller
    • Csrf
    • Dir
    • Feed
    • File
    • Filter
      • Rule
    • Http
    • Image
    • Model
      • Exception
    • Resolver
    • Router
    • Sitemap
    • Transformer
      • Rule
    • Validator
      • Rule
    • View

Classes

  • Acl
  • App
  • Coast
  • Collection
  • Config
  • Controller
  • Csp
  • Csrf
  • Dir
  • Feed
  • File
  • Filter
  • Http
  • Image
  • Lazy
  • Model
  • Path
  • Request
  • Resolver
  • Response
  • Router
  • Session
  • Sitemap
  • Transformer
  • Url
  • Validator
  • View
  • Xml

Exceptions

  • Exception
  • Overview
  • Namespace
  • Class
  • Deprecated
  • Todo

Class Path

Path object.

Direct known subclasses

Coast\File\Path

Indirect known subclasses

Coast\Dir, Coast\File
Namespace: Coast
Located at Path.php
Methods summary
public
# __construct( string $name )

Constructs a new path object.

Constructs a new path object.

Parameters

$name
Full path name.
public
# name( string $name = null )

Get/set the name.

Get/set the name.

Parameters

$name
Full path name.
public string
# __toString( )

Aliases name

Aliases name

Returns

string
public string
# dirName( $dirName = null )

Get/set the directory name.

Get/set the directory name.

Returns

string
public string
# baseName( $baseName = null )

Get/set the base name.

Get/set the base name.

Returns

string
public string
# fileName( $fileName = null )

Get/set the file name.

Get/set the file name.

Returns

string
public
# fileNameDot( )
public string
# extName( $extName = null )

Get/set the extension name.

Get/set the extension name.

Returns

string
public
# extNameDot( )
public
# parts( )
public
# part( $i, $reverse = false )
public string
# prefix( $prefix )

Add prefix.

Add prefix.

Returns

string
public string
# suffix( $suffix )

Add suffix.

Add suffix.

Returns

string
public boolean
# isWithin( Coast\Path $parent )

Check if path is within another

Check if path is within another

Parameters

$parent
$target path to check against.

Returns

boolean
public Coast\Path
# toAbsolute( Coast\Path $base )

Get absolute path from relative path.

Get absolute path from relative path.

Parameters

$base
base absolute path.

Returns

Coast\Path
public Coast\Path
# toRelative( Coast\Path $base )

Get relative path from absolute path.

Get relative path from absolute path.

Parameters

$base
Base absolute path.

Returns

Coast\Path
public Coast\Path
# toReal( )

Reduce absolute path with relative parts to real path.

Reduce absolute path with relative parts to real path.

Returns

Coast\Path
public boolean
# isAbsolute( )

Is path absolute.

Is path absolute.

Returns

boolean
public boolean
# isRelative( )

Is path relative.

Is path relative.

Returns

boolean
public
# child( $path )
public
# parent( )
public
# toDir( )
public
# toFile( )
Constants summary
string PART_FIRST
# 'first'
string PART_LAST
# 'last'
Properties summary
protected string $_name

Full path name.

Full path name.

#
Coast API Documentation API documentation generated by ApiGen