<?php

/**
* Hoa
*
*
* @license
*
* New BSD License
*
* Copyright © 2007-2017, Hoa community. All rights reserved.
*
* Redistribution and use in source and binary forms, with or without
* modification, are permitted provided that the following conditions are met:
* * Redistributions of source code must retain the above copyright
* notice, this list of conditions and the following disclaimer.
* * Redistributions in binary form must reproduce the above copyright
* notice, this list of conditions and the following disclaimer in the
* documentation and/or other materials provided with the distribution.
* * Neither the name of the Hoa nor the names of its contributors may be
* used to endorse or promote products derived from this software without
* specific prior written permission.
*
* THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
* AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
* IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
* ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS AND CONTRIBUTORS BE
* LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
* CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
* SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
* INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
* CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
* ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
* POSSIBILITY OF SUCH DAMAGE.
*/

namespace Hoa\Stream\Wrapper\IWrapper;

/**
* Interface \Hoa\Stream\Wrapper\IWrapper\File.
*
* Interface for “file stream wrapper” class.
*
* @copyright Copyright © 2007-2017 Hoa community
* @license New BSD License
*/
interface File
{
/**
* Close directory handle.
* This method is called in to closedir().
* Any resources which were locked, or allocated, during opening and use of
* the directory stream should be released.
*
* @return bool
*/
public function dir_closedir();

/**
* Open directory handle.
* This method is called in response to opendir().
*
* @param string $path Specifies the URL that was passed to opendir().
* @param int $options Whether or not to enforce safe_mode (0x04).
* @return bool
*/
public function dir_opendir($path, $options);

/**
* Read entry from directory handle.
* This method is called in response to readdir().
*
* @return mixed
*/
public function dir_readdir();

/**
* Rewind directory handle.
* This method is called in response to rewinddir().
* Should reset the output generated by self::dir_readdir, i.e. the next
* call to self::dir_readdir should return the first entry in the location
* returned by self::dir_opendir.
*
* @return bool
*/
public function dir_rewinddir();

/**
* Create a directory.
* This method is called in response to mkdir().
*
* @param string $path Directory which should be created.
* @param int $mode The value passed to mkdir().
* @param int $options A bitwise mask of values.
* @return bool
*/
public function mkdir($path, $mode, $options);

/**
* Rename a file or directory.
* This method is called in response to rename().
* Should attempt to rename $from to $to.
*
* @param string $from The URL to current file.
* @param string $to The URL which $from should be renamed to.
* @return bool
*/
public function rename($from, $to);

/**
* Remove a directory.
* This method is called in response to rmdir().
*
* @param string $path The directory URL which should be removed.
* @param int $options A bitwise mask of values.
* @return bool
*/
public function rmdir($path, $options);

/**
* Delete a file.
* This method is called in response to unlink().
*
* @param string $path The file URL which should be deleted.
* @return bool
*/
public function unlink($path);

/**
* Retrieve information about a file.
* This method is called in response to all stat() related functions.
*
* @param string $path The file URL which should be retrieve
* information about.
* @param int $flags Holds additional flags set by the streams API.
* It can hold one or more of the following
* values OR'd together.
* STREAM_URL_STAT_LINK: for resource with the
* ability to link to other resource (such as an
* HTTP location: forward, or a filesystem
* symlink). This flag specified that only
* information about the link itself should be
* returned, not the resource pointed to by the
* link. This flag is set in response to calls to
* lstat(), is_link(), or filetype().
* STREAM_URL_STAT_QUIET: if this flag is set,
* our wrapper should not raise any errors. If
* this flag is not set, we are responsible for
* reporting errors using the trigger_error()
* function during stating of the path.
* @return array
*/
public function url_stat($path, $flags);
}