visitor/vfsStreamPrintVisitor.php

Show: inherited
Table of Contents

Visitor which traverses a content structure recursively to print it to an output stream.

Package
bovigo_vfs  
Subpackage
visitor  

\vfsStreamPrintVisitor

Package: bovigo\vfs\visitor

Visitor which traverses a content structure recursively to print it to an output stream.

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

Properties

Propertyprotectedint  $depth= ''

current depth in directory tree

Details
Type
int
Propertyprotectedresource  $out= ''

target to write output to

Details
Type
resource

Methods

methodpublic__construct( resource $out = STDOUT ) : void

constructor

If no file pointer given it will fall back to STDOUT.

Parameters
Name Type Description
$out resource

optional

Throws
Exception Description
\InvalidArgumentException
methodprotectedprintContent( \vfsStreamContent $content ) : void

helper method to print the content

Parameters
Name Type Description
$content \vfsStreamContent
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 ) : \vfsStreamPrintVisitor

visit a directory and process it

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

visit a file and process it

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