[ Index ]

PHP Cross Reference of DokuWiki

title

Body

[close]

/vendor/splitbrain/php-archive/src/ -> FileInfo.php (summary)

(no description)

File Size: 340 lines (7 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

FileInfo:: (27 methods):
  __construct()
  fromPath()
  getSize()
  setSize()
  getCompressedSize()
  setCompressedSize()
  getMtime()
  setMtime()
  getGid()
  setGid()
  getUid()
  setUid()
  getComment()
  setComment()
  getGroup()
  setGroup()
  getIsdir()
  setIsdir()
  getMode()
  setMode()
  getOwner()
  setOwner()
  getPath()
  setPath()
  cleanPath()
  strip()
  match()


Class: FileInfo  - X-Ref

Class FileInfo

stores meta data about a file in an Archive

__construct($path = '')   X-Ref
initialize dynamic defaults

param: string $path The path of the file, can also be set later through setPath()

fromPath($path, $as = '')   X-Ref
Factory to build FileInfo from existing file or directory

return: FileInfo
param: string $path path to a file on the local file system
param: string $as   optional path to use inside the archive

getSize()   X-Ref

return: int the filesize. always 0 for directories

setSize($size)   X-Ref

param: int $size

getCompressedSize()   X-Ref

return: int

setCompressedSize($csize)   X-Ref

param: int $csize

getMtime()   X-Ref

return: int

setMtime($mtime)   X-Ref

param: int $mtime

getGid()   X-Ref

return: int

setGid($gid)   X-Ref

param: int $gid

getUid()   X-Ref

return: int

setUid($uid)   X-Ref

param: int $uid

getComment()   X-Ref

return: string

setComment($comment)   X-Ref

param: string $comment

getGroup()   X-Ref

return: string

setGroup($group)   X-Ref

param: string $group

getIsdir()   X-Ref

return: boolean

setIsdir($isdir)   X-Ref

param: boolean $isdir

getMode()   X-Ref

return: int

setMode($mode)   X-Ref

param: int $mode

getOwner()   X-Ref

return: string

setOwner($owner)   X-Ref

param: string $owner

getPath()   X-Ref

return: string

setPath($path)   X-Ref

param: string $path

cleanPath($path)   X-Ref
Cleans up a path and removes relative parts, also strips leading slashes

return: string
param: string $path

strip($strip)   X-Ref
Strip given prefix or number of path segments from the filename

The $strip parameter allows you to strip a certain number of path components from the filenames
found in the tar file, similar to the --strip-components feature of GNU tar. This is triggered when
an integer is passed as $strip.
Alternatively a fixed string prefix may be passed in $strip. If the filename matches this prefix,
the prefix will be stripped. It is recommended to give prefixes with a trailing slash.

param: int|string $strip

match($include = '', $exclude = '')   X-Ref
Does the file match the given include and exclude expressions?

Exclude rules take precedence over include rules

return: bool
param: string $include Regular expression of files to include
param: string $exclude Regular expression of files to exclude