<?php

declare(strict_types=1);

namespace League\Flysystem;

use DateTimeInterface;

/**
 * This interface contains everything to read from and inspect
 * a filesystem. All methods containing are non-destructive.
 *
 * @method string publicUrl(string $path, array $config = []) Will be added in 4.0
 * @method string temporaryUrl(string $path, DateTimeInterface $expiresAt, array $config = []) Will be added in 4.0
 * @method string checksum(string $path, array $config = []) Will be added in 4.0
 */
interface FilesystemReader
{
    public const LIST_SHALLOW = false;
    public const LIST_DEEP = true;

    /**
     * @throws FilesystemException
     * @throws UnableToCheckExistence
     */
    public function fileExists(string $location): bool;

    /**
     * @throws FilesystemException
     * @throws UnableToCheckExistence
     */
    public function directoryExists(string $location): bool;

    /**
     * @throws FilesystemException
     * @throws UnableToCheckExistence
     */
    public function has(string $location): bool;

    /**
     * @throws UnableToReadFile
     * @throws FilesystemException
     */
    public function read(string $location): string;

    /**
     * @return resource
     *
     * @throws UnableToReadFile
     * @throws FilesystemException
     */
    public function readStream(string $location);

    /**
     * @return DirectoryListing<StorageAttributes>
     *
     * @throws FilesystemException
     * @throws UnableToListContents
     */
    public function listContents(string $location, bool $deep = self::LIST_SHALLOW): DirectoryListing;

    /**
     * @throws UnableToRetrieveMetadata
     * @throws FilesystemException
     */
    public function lastModified(string $path): int;

    /**
     * @throws UnableToRetrieveMetadata
     * @throws FilesystemException
     */
    public function fileSize(string $path): int;

    /**
     * @throws UnableToRetrieveMetadata
     * @throws FilesystemException
     */
    public function mimeType(string $path): string;

    /**
     * @throws UnableToRetrieveMetadata
     * @throws FilesystemException
     */
    public function visibility(string $path): string;
}

• [D] UnixVisibility
• [D] UrlGeneration
• [F] CalculateChecksumFromStream.php
  Delete
• [F] ChecksumAlgoIsNotSupported.php
  Delete
• [F] ChecksumProvider.php
  Delete
• [F] Config.php
  Delete
• [F] CorruptedPathDetected.php
  Delete
• [F] DecoratedAdapter.php
  Delete
• [F] DirectoryAttributes.php
  Delete
• [F] DirectoryListing.php
  Delete
• [F] FileAttributes.php
  Delete
• [F] Filesystem.php
  Delete
• [F] FilesystemAdapter.php
  Delete
• [F] FilesystemException.php
  Delete
• [F] FilesystemOperationFailed.php
  Delete
• [F] FilesystemOperator.php
  Delete
• [F] FilesystemReader.php
  Delete
• [F] FilesystemWriter.php
  Delete
• [F] InvalidStreamProvided.php
  Delete
• [F] InvalidVisibilityProvided.php
  Delete
• [F] MountManager.php
  Delete
• [F] PathNormalizer.php
  Delete
• [F] PathPrefixer.php
  Delete
• [F] PathTraversalDetected.php
  Delete
• [F] PortableVisibilityGuard.php
  Delete
• [F] ProxyArrayAccessToProperties.php
  Delete
• [F] ResolveIdenticalPathConflict.php
  Delete
• [F] StorageAttributes.php
  Delete
• [F] SymbolicLinkEncountered.php
  Delete
• [F] UnableToCheckDirectoryExistence.php
  Delete
• [F] UnableToCheckExistence.php
  Delete
• [F] UnableToCheckFileExistence.php
  Delete
• [F] UnableToCopyFile.php
  Delete
• [F] UnableToCreateDirectory.php
  Delete
• [F] UnableToDeleteDirectory.php
  Delete
• [F] UnableToDeleteFile.php
  Delete
• [F] UnableToGeneratePublicUrl.php
  Delete
• [F] UnableToGenerateTemporaryUrl.php
  Delete
• [F] UnableToListContents.php
  Delete
• [F] UnableToMountFilesystem.php
  Delete
• [F] UnableToMoveFile.php
  Delete
• [F] UnableToProvideChecksum.php
  Delete
• [F] UnableToReadFile.php
  Delete
• [F] UnableToResolveFilesystemMount.php
  Delete
• [F] UnableToRetrieveMetadata.php
  Delete
• [F] UnableToSetVisibility.php
  Delete
• [F] UnableToWriteFile.php
  Delete
• [F] UnreadableFileEncountered.php
  Delete
• [F] Visibility.php
  Delete
• [F] WhitespacePathNormalizer.php
  Delete

Blog Section

Discover the Latest in Digital Payments and NFC Technology

Dive into our blog to explore the cutting-edge trends in digital payments and NFC technology. Stay updated on the innovations that are revolutionizing transactions, boosting security, and making payments quicker and more convenient. Learn how these advancements are shaping the future of financial interactions and driving the global transition towards a cashless world.

The Rise of Contactless Payments:...

In recent years, contactless payments have surged in popularity, driven...

Visit Blog

March 27, 2024

Enhancing Payment Security: The Role...

As digital transactions proliferate, ensuring robust payment security is more critical than ever. Two foundational...

Visit Blog

March 27, 2024

The Future of Digital Wallets:...

Digital wallets have fundamentally transformed how we manage money, offering a streamlined, secure, and highly...

Visit Blog

March 27, 2024