vfsStreamVisitor.php in Zircon Profile 8

Namespace

org\bovigo\vfs\visitor

File

vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/visitor/vfsStreamVisitor.php

<?php

/**
 * 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
 */
namespace org\bovigo\vfs\visitor;

use org\bovigo\vfs\vfsStreamContent;
use org\bovigo\vfs\vfsStreamDirectory;
use org\bovigo\vfs\vfsStreamFile;
use org\bovigo\vfs\vfsStreamBlock;

/**
 * Interface for a visitor to work on a vfsStream content structure.
 *
 * @since  0.10.0
 * @see    https://github.com/mikey179/vfsStream/issues/10
 */
interface vfsStreamVisitor {

  /**
   * visit a content and process it
   *
   * @param   vfsStreamContent  $content
   * @return  vfsStreamVisitor
   */
  public function visit(vfsStreamContent $content);

  /**
   * visit a file and process it
   *
   * @param   vfsStreamFile  $file
   * @return  vfsStreamVisitor
   */
  public function visitFile(vfsStreamFile $file);

  /**
   * visit a directory and process it
   *
   * @param   vfsStreamDirectory  $dir
   * @return  vfsStreamVisitor
   */
  public function visitDirectory(vfsStreamDirectory $dir);

  /**
   * visit a block device and process it
   *
   * @param   vfsStreamBlock  $block
   * @return  vfsStreamVisitor
   */
  public function visitBlockDevice(vfsStreamBlock $block);

}

Interfaces

Name	Description
vfsStreamVisitor	Interface for a visitor to work on a vfsStream content structure.