interface FileContent in Zircon Profile 8

Interface for actual file contents.

@since 1.3.0

Hierarchy

• interface \org\bovigo\vfs\content\FileContent

1 file declares its use of FileContent

vfsStreamFile.php in vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/vfsStreamFile.php

File

vendor/mikey179/vfsStream/src/main/php/org/bovigo/vfs/content/FileContent.php, line 16

Namespace

org\bovigo\vfs\content

interface FileContent {

  /**
   * returns actual content
   *
   * @return  string
   */
  public function content();

  /**
   * returns size of content
   *
   * @return  int
   */
  public function size();

  /**
   * reads the given amount of bytes from content
   *
   * @param   int     $count
   * @return  string
   */
  public function read($count);

  /**
   * seeks to the given offset
   *
   * @param   int   $offset
   * @param   int   $whence
   * @return  bool
   */
  public function seek($offset, $whence);

  /**
   * checks whether pointer is at end of file
   *
   * @return  bool
   */
  public function eof();

  /**
   * writes an amount of data
   *
   * @param   string  $data
   * @return  amount of written bytes
   */
  public function write($data);

  /**
   * Truncates a file to a given length
   *
   * @param   int  $size length to truncate file to
   * @return  bool
   */
  public function truncate($size);

}

Members

Name	Modifiers	Type	Description	Overrides
FileContent::content	public	function	returns actual content	2
FileContent::eof	public	function	checks whether pointer is at end of file	1
FileContent::read	public	function	reads the given amount of bytes from content	1
FileContent::seek	public	function	seeks to the given offset	1
FileContent::size	public	function	returns size of content	2
FileContent::truncate	public	function	Truncates a file to a given length	2
FileContent::write	public	function	writes an amount of data	1