You are here

interface vfsStreamContainer in Zircon Profile 8

Same name and namespace in other branches
  1. 8.0 vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamContainer.php \org\bovigo\vfs\vfsStreamContainer

Interface for stream contents that are able to store other stream contents.

Hierarchy

Expanded class hierarchy of vfsStreamContainer

All classes that implement vfsStreamContainer

File

vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamContainer.php, line 14

Namespace

org\bovigo\vfs
View source
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();

}

Members

Namesort descending Modifiers Type Description Overrides
vfsStreamContainer::addChild public function adds child to the directory 1
vfsStreamContainer::getChild public function returns the child with the given name 1
vfsStreamContainer::getChildren public function returns a list of children for this directory 1
vfsStreamContainer::hasChild public function checks whether the container contains a child with the given name 1
vfsStreamContainer::hasChildren public function checks whether directory contains any children 1
vfsStreamContainer::removeChild public function removes child from the directory 1