third_party/vfsstream/vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamDirectory.php

Classes
- \org\bovigo\vfs\vfsStreamDirectory

Table of Contents

This file is part of vfsStream.

For the full copyright and license information, please view the LICENSE file that was distributed with this source code.

Package: org\bovigo\vfs

\org\bovigo\vfs\vfsStreamDirectory
jump to top

Package: Default

Directory container.

Implements: \org\bovigo\vfs\vfsStreamContainer
Parent(s): \org\bovigo\vfs\vfsStreamAbstractContent
Api

Constants

inherited

stream content type: file

Inherited from: \org\bovigo\vfs\vfsStreamContent::TYPE_FILE \org\bovigo\vfs\vfsStreamAbstractContent::TYPE_FILE

Inherited_from: \org\bovigo\vfs\vfsStreamContent::TYPE_FILE
Inherited_from: \org\bovigo\vfs\vfsStreamAbstractContent::TYPE_FILE
See: \org\bovigo\vfs\getType()

inherited

stream content type: directory

Inherited from: \org\bovigo\vfs\vfsStreamContent::TYPE_DIR \org\bovigo\vfs\vfsStreamAbstractContent::TYPE_DIR

Inherited_from: \org\bovigo\vfs\vfsStreamContent::TYPE_DIR
Inherited_from: \org\bovigo\vfs\vfsStreamAbstractContent::TYPE_DIR
See: \org\bovigo\vfs\getType()

Methods


       
       
       
        __construct
       
       
        (string $name, int $permissions = null)
       
       : void

constructor

Parameters

Name	Type	Description
$name	string
$permissions	int	optional

Throws

Exception	Description
\org\bovigo\vfs\vfsStreamException


       
       
       
        addChild
       
       
        (
        
         \org\bovigo\vfs\vfsStreamContent
        
        $child)
       
       : void

adds child to the directory

Parameters

Name	Type	Description
$child	\org\bovigo\vfs\vfsStreamContent


       
       
       
        appliesTo
       
       
        (string $name)
       
       : bool

inherited

checks whether the container can be applied to given name

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::appliesTo()

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool


       
       
       
        at
       
       
        (
        
         \org\bovigo\vfs\vfsStreamContainer
        
        $container)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

adds content to given container

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::at()

Parameters

Name	Type	Description
$container	\org\bovigo\vfs\vfsStreamContainer

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent


       
       
       
        chgrp
       
       
        (int $group)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

change owner group of file to given group

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::chgrp()

Parameters

Name	Type	Description
$group	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent


       
       
       
        chmod
       
       
        (int $permissions)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

change file mode to given permissions

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::chmod()

Parameters

Name	Type	Description
$permissions	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent


       
       
       
        chown
       
       
        (int $user)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

change owner of file to given user

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::chown()

Parameters

Name	Type	Description
$user	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent

inherited

returns the last access time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::fileatime()

Returns

Type	Description
int

Details

Since: 0.9

inherited

returns the last attribute modification time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::filectime()

Returns

Type	Description
int

Details

Since: 0.9

inherited

returns the last modification time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::filemtime()

Returns

Type	Description
int


       
       
       
        getChild
       
       
        (string $name)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

returns the child with the given name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent


       
       
       
        getChildren
       
       
        ()
       
       :
       
        \org\bovigo\vfs\vfsStreamContent[]

returns a list of children for this directory

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent[]

inherited

returns owner group of file

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::getGroup()

Returns

Type	Description
int


       
       
       
        getIterator
       
       
        ()
       
       :
       
        \org\bovigo\vfs\vfsStreamContainerIterator

returns iterator for the children

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContainerIterator

inherited

returns the file name of the content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::getName()

Returns

Type	Description
string


       
       
       
        getPermissions
       
       
        ()
       
       : int

inherited

returns permissions

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::getPermissions()

Returns

Type	Description
int

inherited

returns the type of the container

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::getType()

Returns

Type	Description
int

inherited

returns owner of file

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::getUser()

Returns

Type	Description
int


       
       
       
        hasChild
       
       
        (string $name)
       
       : bool

checks whether the container contains a child with the given name

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool


       
       
       
        hasChildren
       
       
        ()
       
       : bool

checks whether directory contains any children

Returns

Type	Description
bool

Details

Since: 0.10.0


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

inherited

checks whether content is executable

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::isExecutable()

Parameters

Name	Type	Description
$user	int	id of user to check for
$group	int	id of group to check for

Returns

Type	Description
bool


       
       
       
        isOwnedByGroup
       
       
        (int $group)
       
       : bool

inherited

checks whether file is owned by group

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::isOwnedByGroup()

Parameters

Name	Type	Description
$group	int

Returns

Type	Description
bool


       
       
       
        isOwnedByUser
       
       
        (int $user)
       
       : bool

inherited

checks whether file is owned by given user

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::isOwnedByUser()

Parameters

Name	Type	Description
$user	int

Returns

Type	Description
bool


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

inherited

checks whether content is readable

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::isReadable()

Parameters

Name	Type	Description
$user	int	id of user to check for
$group	int	id of group to check for

Returns

Type	Description
bool


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

inherited

checks whether content is writable

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::isWritable()

Parameters

Name	Type	Description
$user	int	id of user to check for
$group	int	id of group to check for

Returns

Type	Description
bool


       
       
       
        lastAccessed
       
       
        (int $fileatime)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

sets last access time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::lastAccessed()

Parameters

Name	Type	Description
$fileatime	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent

Details

Since: 0.9


       
       
       
        lastAttributeModified
       
       
        (int $filectime)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

sets the last attribute modification time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::lastAttributeModified()

Parameters

Name	Type	Description
$filectime	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent

Details

Since: 0.9


       
       
       
        lastModified
       
       
        (int $filemtime)
       
       :
       
        \org\bovigo\vfs\vfsStreamContent

inherited

sets the last modification time of the stream content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::lastModified()

Parameters

Name	Type	Description
$filemtime	int

Returns

Type	Description
\org\bovigo\vfs\vfsStreamContent

inherited

returns path to this content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::path()

Returns

Type	Description
string

Details

Since: 1.2.0


       
       
       
        removeChild
       
       
        (string $name)
       
       : bool

removes child from the directory

Parameters

Name	Type	Description
$name	string

Returns

Type	Description
bool


       
       
       
        rename
       
       
        (string $newName)
       
       : void

renames the content

Parameters

Name	Type	Description
$newName	string

Throws

Exception	Description
\org\bovigo\vfs\vfsStreamException

returns size of directory

The size of a directory is always 0 bytes. To calculate the summarized size of all children in the directory use sizeSummarized().

Returns

Type	Description
int


       
       
       
        sizeSummarized
       
       
        ()
       
       : int

returns summarized size of directory and its children

Returns

Type	Description
int

inherited

returns complete vfsStream url for this content

Inherited from: \org\bovigo\vfs\vfsStreamAbstractContent::url()

Returns

Type	Description
string

Details

Since: 1.2.0

third_party/vfsstream/vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamDirectory.php

\org\bovigo\vfs\vfsStreamDirectory jump to top

Constants

Methods

\org\bovigo\vfs\vfsStreamDirectory
jump to top