vfsStreamContent.php

Show: inherited
    Table of Contents

    Interface for stream contents.

    Package
    bovigo_vfs  

    \vfsStreamContent

    Package: bovigo\vfs

    Interface for stream contents.

    Children
    \vfsStreamAbstractContent

    Constants

    Constant  TYPE_FILE = 0100000

    stream content type: file

    See
    \getType()  
    Constant  TYPE_DIR = 0040000

    stream content type: directory

    See
    \getType()  

    Methods

    methodpublicappliesTo( string $name ) : bool

    checks whether the container can be applied to given name

    Parameters
    Name Type Description
    $name string
    Returns
    Type Description
    bool
    methodpublicat( \vfsStreamContainer $container ) : \vfsStreamContent

    adds content to given container

    Parameters
    Name Type Description
    $container \vfsStreamContainer
    Returns
    Type Description
    \vfsStreamContent
    methodpublicchgrp( int $group ) : \vfsStreamContent

    change owner group of file to given group

    Parameters
    Name Type Description
    $group int
    Returns
    Type Description
    \vfsStreamContent
    methodpublicchmod( int $permissions ) : \vfsStreamContent

    change file mode to given permissions

    Parameters
    Name Type Description
    $permissions int
    Returns
    Type Description
    \vfsStreamContent
    methodpublicchown( int $user ) : \vfsStreamContent

    change owner of file to given user

    Parameters
    Name Type Description
    $user int
    Returns
    Type Description
    \vfsStreamContent
    methodpublicfilemtime( ) : int

    returns the last modification time of the stream content

    Returns
    Type Description
    int
    methodpublicgetGroup( ) : int

    returns owner group of file

    Returns
    Type Description
    int
    methodpublicgetName( ) : string

    returns the file name of the content

    Returns
    Type Description
    string
    methodpublicgetPermissions( ) : int

    returns permissions

    Returns
    Type Description
    int
    methodpublicgetType( ) : int

    returns the type of the container

    Returns
    Type Description
    int
    methodpublicgetUser( ) : int

    returns owner of file

    Returns
    Type Description
    int
    methodpublicisExecutable( int $user, int $group ) : bool

    checks whether content is executable

    Parameters
    Name Type Description
    $user int

    id of user to check for

    $group int

    id of group to check for

    Returns
    Type Description
    bool
    methodpublicisOwnedByGroup( int $group ) : bool

    checks whether file is owned by group

    Parameters
    Name Type Description
    $group int
    Returns
    Type Description
    bool
    methodpublicisOwnedByUser( int $user ) : bool

    checks whether file is owned by given user

    Parameters
    Name Type Description
    $user int
    Returns
    Type Description
    bool
    methodpublicisReadable( int $user, int $group ) : bool

    checks whether content is readable

    Parameters
    Name Type Description
    $user int

    id of user to check for

    $group int

    id of group to check for

    Returns
    Type Description
    bool
    methodpublicisWritable( int $user, int $group ) : bool

    checks whether content is writable

    Parameters
    Name Type Description
    $user int

    id of user to check for

    $group int

    id of group to check for

    Returns
    Type Description
    bool
    methodpubliclastModified( int $filemtime ) : \vfsStreamContent

    sets the last modification time of the stream content

    Parameters
    Name Type Description
    $filemtime int
    Returns
    Type Description
    \vfsStreamContent
    methodpublicrename( string $newName ) : void

    renames the content

    Parameters
    Name Type Description
    $newName string
    methodpublicsize( ) : int

    returns size of content

    Returns
    Type Description
    int
    Documentation was generated by DocBlox 0.18.1.