Documentation

vfsStreamAbstractContent
in package
implements vfsStreamContent

Base stream contents container.

Interfaces, Classes and Traits

vfsStreamContent
Interface for stream contents.

Table of Contents

$group  : mixed
owner group of the file
$lastAccessed  : mixed
timestamp of last access
$lastAttributeModified  : mixed
timestamp of last attribute modification
$lastModified  : mixed
timestamp of last modification
$name  : mixed
name of the container
$permissions  : mixed
permissions for content
$type  : mixed
type of the container
$user  : mixed
owner of the file
$parentPath  : mixed
path to to this content
__construct()  : mixed
constructor
appliesTo()  : bool
checks whether the container can be applied to given name
at()  : $this
adds content to given container
chgrp()  : $this
change owner group of file to given group
chmod()  : $this
change file mode to given permissions
chown()  : $this
change owner of file to given user
fileatime()  : int
returns the last access time of the stream content
filectime()  : int
returns the last attribute modification time of the stream content
filemtime()  : int
returns the last modification time of the stream content
getGroup()  : int
returns owner group of file
getName()  : string
returns the file name of the content
getPermissions()  : int
returns permissions
getType()  : int
returns the type of the container
getUser()  : int
returns owner of file
isExecutable()  : bool
checks whether content is executable
isOwnedByGroup()  : bool
checks whether file is owned by group
isOwnedByUser()  : bool
checks whether file is owned by given user
isReadable()  : bool
checks whether content is readable
isWritable()  : bool
checks whether content is writable
lastAccessed()  : $this
sets last access time of the stream content
lastAttributeModified()  : $this
sets the last attribute modification time of the stream content
lastModified()  : $this
sets the last modification time of the stream content
path()  : string
returns path to this content
rename()  : mixed
renames the content
url()  : string
returns complete vfsStream url for this content
getDefaultPermissions()  : int
returns default permissions for concrete implementation

Properties

$lastAttributeModified

timestamp of last attribute modification

protected mixed $lastAttributeModified
Tags
type

int

Methods

__construct()

constructor

public __construct(string $name[, int $permissions = null ]) : mixed
Parameters
$name : string
$permissions : int = null

optional

Return values
mixed —

appliesTo()

checks whether the container can be applied to given name

public appliesTo(string $name) : bool
Parameters
$name : string
Return values
bool —

chgrp()

change owner group of file to given group

public chgrp(int $group) : $this
Parameters
$group : int
Return values
$this —

chmod()

change file mode to given permissions

public chmod(int $permissions) : $this
Parameters
$permissions : int
Return values
$this —

chown()

change owner of file to given user

public chown(int $user) : $this
Parameters
$user : int
Return values
$this —

fileatime()

returns the last access time of the stream content

public fileatime() : int
Tags
since
0.9
Return values
int —

filectime()

returns the last attribute modification time of the stream content

public filectime() : int
Tags
since
0.9
Return values
int —

filemtime()

returns the last modification time of the stream content

public filemtime() : int
Return values
int —

isExecutable()

checks whether content is executable

public isExecutable(int $user, int $group) : bool
Parameters
$user : int

id of user to check for

$group : int

id of group to check for

Return values
bool —

isOwnedByGroup()

checks whether file is owned by group

public isOwnedByGroup(int $group) : bool
Parameters
$group : int
Return values
bool —

isOwnedByUser()

checks whether file is owned by given user

public isOwnedByUser(int $user) : bool
Parameters
$user : int
Return values
bool —

isReadable()

checks whether content is readable

public isReadable(int $user, int $group) : bool
Parameters
$user : int

id of user to check for

$group : int

id of group to check for

Return values
bool —

isWritable()

checks whether content is writable

public isWritable(int $user, int $group) : bool
Parameters
$user : int

id of user to check for

$group : int

id of group to check for

Return values
bool —

lastAccessed()

sets last access time of the stream content

public lastAccessed(int $fileatime) : $this
Parameters
$fileatime : int
Tags
since
0.9
Return values
$this —

lastAttributeModified()

sets the last attribute modification time of the stream content

public lastAttributeModified(int $filectime) : $this
Parameters
$filectime : int
Tags
since
0.9
Return values
$this —

lastModified()

sets the last modification time of the stream content

public lastModified(int $filemtime) : $this
Parameters
$filemtime : int
Return values
$this —

rename()

renames the content

public rename(string $newName) : mixed
Parameters
$newName : string
Return values
mixed —

url()

returns complete vfsStream url for this content

public url() : string
Tags
since
1.2.0
Return values
string —

getDefaultPermissions()

returns default permissions for concrete implementation

protected abstract getDefaultPermissions() : int
Tags
since
0.8.0
Return values
int —

Search results