https://github.com/uniwue-rz/lyra-io

Lyra Library IO implemetation
https://github.com/uniwue-rz/lyra-io

filesystem-library io lyra php symfony

Last synced: 4 days ago
JSON representation

Lyra Library IO implemetation

• Host: GitHub
• URL: https://github.com/uniwue-rz/lyra-io
• Owner: uniwue-rz
• License: mit
• Created: 2017-07-25T11:39:17.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-07-25T12:41:42.000Z (over 7 years ago)
• Last Synced: 2024-04-20T12:18:12.314Z (7 months ago)
• Topics: filesystem-library, io, lyra, php, symfony
• Language: PHP
• Size: 7.81 KB
• Stars: 0
• Watchers: 4
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
# Lyra IO

The Lyra/IO is a wrapper to the Symfony file system which allows the user to log actions and also run the changes in dryrun mode. This is good

for working with sensitive data. Every action can be simulated before being actually called.

## Installation

To install `rzuw/lyra-io` you only need to have composer installed. The composer can be downloaded and installed from the [composer website](https://getcomposer.org/download/). Afterwards you only need to add `rzuw/lyra-io` to your requirements. The `rzwu/lyra-io` will be downloaded from [packagist](https://packagist.org/).

```lang=bash

composer require rzuw/lyra-io

composer update

```

You can also clone this repository and add it as a filesystem to your composer system. This is a good choice if you want to test some changes in the original library:

```lang=json

{

    "repositories": [

        {

            "type": "path",

            "url": "/path-to-git-clone"

        }

    ],

    "require": {

        "rzuw/lyra-io": "*"

    }

}

```

Adding the repository directly to the composer.json is also possible.

```lang=json

{

    "require": {

        "rzuw/lyra-io": "*"

    },

    "repositories": [

        {

            "type": "vcs",

            "url":  "ssh://[email protected]/uniwue-rz/lyra-io.git"

        }

    ]

}

```

## Configuration

The configuration is very simple. You need to only a logger object which delivers the method:

```lang=php

public function log($level, $text, $context = array()){

    // do logging

}

```

If you want to log the actions by this library. You can also just run it without logger.

## Usage

After adding the library in composer.json and installing it with:

```lang=bash

composer install # or Update

```

To use this library create a new instance:

```lang=php

$logger = new Logger();

$io = new IO($logger);

$io->copy("/etc/passwd","/etc/passwd.back");

```

if there is an error the application will through an `IOException`.

## Test and Development

The test can be done using `phpunit`. The needed configuration and sample tests are available in `tests` folder.

## License

See LICENSE file