https://github.com/decodelabs/atlas

Easy filesystem and io functions for PHP
https://github.com/decodelabs/atlas

file filesystem php

Last synced: 1 day ago
JSON representation

Easy filesystem and io functions for PHP

• Host: GitHub
• URL: https://github.com/decodelabs/atlas
• Owner: decodelabs
• License: mit
• Created: 2019-10-03T21:48:11.000Z (over 5 years ago)
• Default Branch: develop
• Last Pushed: 2024-09-04T20:51:39.000Z (4 months ago)
• Last Synced: 2024-11-22T16:46:53.344Z (about 2 months ago)
• Topics: file, filesystem, php
• Language: PHP
• Homepage:
• Size: 302 KB
• Stars: 2
• Watchers: 3
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Atlas

[![PHP from Packagist](https://img.shields.io/packagist/php-v/decodelabs/atlas?style=flat)](https://packagist.org/packages/decodelabs/atlas)

[![Latest Version](https://img.shields.io/packagist/v/decodelabs/atlas.svg?style=flat)](https://packagist.org/packages/decodelabs/atlas)

[![Total Downloads](https://img.shields.io/packagist/dt/decodelabs/atlas.svg?style=flat)](https://packagist.org/packages/decodelabs/atlas)

[![GitHub Workflow Status](https://img.shields.io/github/actions/workflow/status/decodelabs/atlas/integrate.yml?branch=develop)](https://github.com/decodelabs/atlas/actions/workflows/integrate.yml)

[![PHPStan](https://img.shields.io/badge/PHPStan-enabled-44CC11.svg?longCache=true&style=flat)](https://github.com/phpstan/phpstan)

[![License](https://img.shields.io/packagist/l/decodelabs/atlas?style=flat)](https://packagist.org/packages/decodelabs/atlas)

### Easy filesystem and IO functions for PHP

Atlas provides an easy and accessible interface to file system interaction. Read, write, copy and move files without breaking a sweat.

_Get news and updates on the [DecodeLabs blog](https://blog.decodelabs.com)._

---

## Installation

Install via Composer:

```bash

composer require decodelabs/atlas

```

## Usage

### Importing

Atlas uses [Veneer](https://github.com/decodelabs/veneer) to provide a unified frontage under DecodeLabs\Atlas.

You can access all the primary functionality via this static frontage without compromising testing and dependency injection.

### Basic local filesystem functions

There are many standard filesystem functions represented by either File or Dir objects.

See [Context.php](./src/Atlas/Context.php), [File/Local.php](./src/Atlas/File/Local.php) and [Dir/Local.php](./src/Atlas/Dir/Local.php) for the full list.

```php

use DecodeLabs\Atlas;

Atlas::get('/path/to/dir_or_file')

    ->copyTo('/another/path/');

Atlas::createDir('some/dir/path', 0770);

Atlas::file('my/file')

    ->renameTo('file.txt')

    ->setOwner('user');

Atlas::gzFile('my/file.gz', 'w')

    ->write('hello world')

    ->close();

```

### Dir scanning

Scan the contents of a folder with optional filtering..

Replace "scan" for "list" to return an array rather than a Generator:

```php

use DecodeLabs\Atlas;

foreach(Atlas::scan('my/dir') as $name => $fileOrDir) {

    // All files and dirs in my/dir

}

foreach(Atlas::scanDirs('my/dir') as $name => $dir) {

    // All dirs in my/dir

}

foreach(Atlas::listFilesRecursive('my/dir', function($name, $file) {

    // Return true if you want the file to be output

    return $name !== 'BadFile.php';

}) as $name => $file) {

    // All files in all dirs in my/dir

}

```

See [Fs.php](./src/Atlas/Plugins/Fs.php) or [Dir/Local.php](./src/Atlas/Dir/ScannerTrait.php) for all scanning options.

---

### Channels & IO Broker

Looking for the IO Broker and Channel transfer interfaces?

This has been moved to its own project, [Deliverance](https://github.com/decodelabs/deliverance/).

### Mime types

Looking for the mime type detection stuff that used to be here?

This has been moved to its own project, [Typify](https://github.com/decodelabs/typify/).

---

## Licensing

Atlas is licensed under the MIT License. See [LICENSE](./LICENSE) for the full license text.