vfsStreamContainer.php in Zircon Profile 8

Namespace

org\bovigo\vfs

File

vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamContainer.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;


/**
 * Interface for stream contents that are able to store other stream contents.
 */
interface vfsStreamContainer extends \IteratorAggregate {

  /**
   * adds child to the directory
   *
   * @param  vfsStreamContent  $child
   */
  public function addChild(vfsStreamContent $child);

  /**
   * removes child from the directory
   *
   * @param   string  $name
   * @return  bool
   */
  public function removeChild($name);

  /**
   * checks whether the container contains a child with the given name
   *
   * @param   string  $name
   * @return  bool
   */
  public function hasChild($name);

  /**
   * returns the child with the given name
   *
   * @param   string  $name
   * @return  vfsStreamContent
   */
  public function getChild($name);

  /**
   * checks whether directory contains any children
   *
   * @return  bool
   * @since   0.10.0
   */
  public function hasChildren();

  /**
   * returns a list of children for this directory
   *
   * @return  vfsStreamContent[]
   */
  public function getChildren();

}

Interfaces

Name	Description
vfsStreamContainer	Interface for stream contents that are able to store other stream contents.