Macsch15/CodeSnippet

CodeSnippet

CodeSnippet - get code snippet from file (helpful for exception handlers for example)

Requirements

PHP 7.2 (or above)
Composer
PHPUnit (for automated testing)

Usage

$ composer require macsch15/codesnippet 1.1.*

<?php
require './vendor/autoload.php';

use CodeSnippet\Snippet;

$snippet = new Snippet();
$snippet
    ->file(__DIR__ . '/myFile.ext') // Load file, throws NotFoundException if file not exists
    ->start(33) // Start from 33 line
    ->length(10) // Maximum snippet length is 10
    ->toArray(); // Return results as array, if first argument is set to true, returned lines will be trimmed

Available return methods:

public function toArray($trim = false)

public function toJson($trim = false, $options = 0)

public function toString($new_line = '\n', $trim = false)

Helper methods:

public function startsFrom()

public function getLength()

public function getFilename()

Unit testing

$ composer install
$ phpunit

Author

Maciej Schmidt

MIT Licence

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Macsch15 / CodeSnippet