n2n Page Rocket 1 API

­Path

Constant summary

• DELIMITER

Property summary

Methods summary

Constants in detail

• DELIMITER

  ­ const DELIMITER ­

Properties in detail

• leadingDelimiter

  protected ­ ­ ­ leadingDelimiter

• endingDelimiter

  protected ­ ­ ­ endingDelimiter

Methods in detail

• __construct

  public __construct ( array pathParts , unknown leadingDelimiter = false , unknown endingDelimiter = false )

• setStr

  protected setStr ( unknown str )

• setPathParts

  protected setPathParts ( array pathParts )

• isEmpty

  public isEmpty ( unknown checkDelimiters = false )

• hasLeadingDelimiter

  public hasLeadingDelimiter ( )

• hasEndingDelimiter

  public hasEndingDelimiter ( )

• getPathParts

  public getPathParts ( )

• getFirstPathPart

  string|null public getFirstPathPart ( bool required = true )

  param

  bool required

  throws

  IllegalStateException

  return

  n2n\util\uri\string|null

• getLastPathPart

  string|null public getLastPathPart ( bool required = true )

  param

  bool required

  throws

  IllegalStateException

  return

  n2n\util\uri\string|null

• toEncodedArray

  public toEncodedArray ( )

• size

  public size ( )

• __toString

  public __toString ( )

• toRealString

  public toRealString ( unknown leadingDelimiter = null , unknown endingDelimiter = null )

• ext

  Path public ext ( unknown pathPartExts )

  Extends the path with part parts. Passed strings will be interpreted as unencoded path parts. Therefore calls
  like ext('path-part-1/path-part2') are not possible because path-part-1/path-part2
  would be used and encoded as one single path part (path-part-1%2Fpath-part2). That behavior makes
  this method safer than Path however.
  
  
  
  Usage examples
  $path->ext('path-part-1', 'path-part2')
  
  $path->ext(array('path-part-1', 'path-part2'))
  
  
  
  
  param
  mixed ...$parts ...$parts Use string, Path or array with string and Path fields.
  return
  Path

• extEnc

  Path public extEnc ( unknown pathExts )

  Extends the path. Passed strings will be interpreted as encoded paths. Strings in arrays will be interpreted
  as unencoded path parts.
  
  
  
  Usage examples
  $path->extEnc('path-part-1/path-part2', 'Path%20Part%203/Path%20Part%204');
  
  $path->extEnc(array('path-part-1', 'path-part2'))
  
  
  
  
  param
  mixed ...$pathExts ...$pathExts Use string, Path or array with string and Path fields.
  return
  Path

• getParent

  public getParent ( )

• reduced

  Path public reduced ( int num )

  param

  int num

  return

  Path

• sub

  Path public sub ( int start , int num = null )

  param

  int start

  int num

  throws

  InvalidArgumentException

  return

  Path

  todo

  todo: make new

• toUrl

  public toUrl ( unknown query = null , unknown fragment = null )

• chLeadingDelimiter

  public chLeadingDelimiter ( unknown leadingDelimiter )

• chEndingDelimiter

  public chEndingDelimiter ( unknown endingDelimiter )

• chPathParts

  public chPathParts ( array pathParts )

• equals

  public equals ( unknown obj )

• create

  public static create ( unknown expression , bool lenient = false )

• validatePathString

  public static validatePathString ( unknown pathString )