visitor/vfsStreamStructureVisitor.php

Show: inherited
Table of Contents

Visitor which traverses a content structure recursively to create an array structure from it.

Package
bovigo_vfs  
Subpackage
visitor  

\vfsStreamStructureVisitor

Package: bovigo\vfs\visitor

Visitor which traverses a content structure recursively to create an array structure from it.

Parent(s)
\vfsStreamAbstractVisitor < \vfsStreamVisitor
See
\https://github.com/mikey179/vfsStream/issues/10  
Since
0.10.0  

Properties

Propertyprotected\array<string,array|\string>  $current= ''

poiting to currently iterated directory

Details
Type
\array<string,array | \string>
Propertyprotected\array<string,array|\string>  $structure= 'array()'

collected structure

Default valuearray()Details
Type
\array<string,array | \string>

Methods

methodpublic__construct( ) : void

constructor

methodpublicgetStructure( ) : \array<string,array | \string>

returns structure of visited contents

Returns
Type Description
\array<string,array | \string>
methodpublicreset( ) : \vfsStreamStructureVisitor

resets structure so visitor could be reused

Returns
Type Description
\vfsStreamStructureVisitor
methodpublicvisit( \vfsStreamContent $content ) : \vfsStreamVisitor
inherited

visit a content and process it

Inherited from: \vfsStreamAbstractVisitor::visit()
Parameters
Name Type Description
$content \vfsStreamContent
Returns
Type Description
\vfsStreamVisitor
Throws
Exception Description
\InvalidArgumentException
methodpublicvisitDirectory( \vfsStreamDirectory $dir ) : \vfsStreamStructureVisitor

visit a directory and process it

Parameters
Name Type Description
$dir \vfsStreamDirectory
Returns
Type Description
\vfsStreamStructureVisitor
methodpublicvisitFile( \vfsStreamFile $file ) : \vfsStreamStructureVisitor

visit a file and process it

Parameters
Name Type Description
$file \vfsStreamFile
Returns
Type Description
\vfsStreamStructureVisitor
Documentation was generated by DocBlox 0.18.1.