vfsStreamContent
in
Interface for stream contents.
Table of Contents
- TYPE_BLOCK = 060000
- stream content type: block
- TYPE_DIR = 040000
- stream content type: directory
- TYPE_FILE = 0100000
- stream content type: file
- appliesTo() : bool
- checks whether the container can be applied to given name
- at() : vfsStreamContent
- adds content to given container
- chgrp() : vfsStreamContent
- change owner group of file to given group
- chmod() : vfsStreamContent
- change file mode to given permissions
- chown() : vfsStreamContent
- change owner of file to given user
- 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
- lastModified() : vfsStreamContent
- sets the last modification time of the stream content
- path() : string
- returns path to this content
- rename() : mixed
- renames the content
- size() : int
- returns size of content
- url() : string
- returns complete vfsStream url for this content
Constants
TYPE_BLOCK
stream content type: block
public
mixed
TYPE_BLOCK
= 060000
Tags
TYPE_DIR
stream content type: directory
public
mixed
TYPE_DIR
= 040000
Tags
TYPE_FILE
stream content type: file
public
mixed
TYPE_FILE
= 0100000
Tags
Methods
appliesTo()
checks whether the container can be applied to given name
public
appliesTo(string $name) : bool
Parameters
- $name : string
Return values
bool —at()
adds content to given container
public
at(vfsStreamContainer $container) : vfsStreamContent
Parameters
- $container : vfsStreamContainer
Return values
vfsStreamContent —chgrp()
change owner group of file to given group
public
chgrp(int $group) : vfsStreamContent
Parameters
- $group : int
Return values
vfsStreamContent —chmod()
change file mode to given permissions
public
chmod(int $permissions) : vfsStreamContent
Parameters
- $permissions : int
Return values
vfsStreamContent —chown()
change owner of file to given user
public
chown(int $user) : vfsStreamContent
Parameters
- $user : int
Return values
vfsStreamContent —filemtime()
returns the last modification time of the stream content
public
filemtime() : int
Return values
int —getGroup()
returns owner group of file
public
getGroup() : int
Return values
int —getName()
returns the file name of the content
public
getName() : string
Return values
string —getPermissions()
returns permissions
public
getPermissions() : int
Return values
int —getType()
returns the type of the container
public
getType() : int
Return values
int —getUser()
returns owner of file
public
getUser() : 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 —lastModified()
sets the last modification time of the stream content
public
lastModified(int $filemtime) : vfsStreamContent
Parameters
- $filemtime : int
Return values
vfsStreamContent —path()
returns path to this content
public
path() : string
Tags
Return values
string —rename()
renames the content
public
rename(string $newName) : mixed
Parameters
- $newName : string
Return values
mixed —size()
returns size of content
public
size() : int
Return values
int —url()
returns complete vfsStream url for this content
public
url() : string