macsch15/codesnippet

CodeSnippet - 从文件中获取一些代码行

1.1.0 2016-07-20 22:22 UTC

This package is not auto-updated.

Last update: 2024-09-14 19:25:35 UTC


README

CodeSnippet 构建状态 覆盖率状态 StyleCI

CodeSnippet - 从文件中获取代码片段(例如,对异常处理很有帮助)

需求

  • PHP 7.2(或更高版本)
  • Composer
  • PHPUnit(用于自动化测试)

用法

$ 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

可用的返回方法

public function toArray($trim = false)
public function toJson($trim = false, $options = 0)
public function toString($new_line = '\n', $trim = false)

辅助方法

public function startsFrom()
public function getLength()
public function getFilename()

单元测试

$ composer install
$ phpunit

作者

Maciej Schmidt

MIT许可

版权所有 © 2016 Maciej Schmidt

在此授予任何人获得本软件及其相关文档副本(“软件”)的副本的权利,免费使用该软件,不受任何限制,包括但不限于使用、复制、修改、合并、发布、分发、再许可和/或销售软件副本的权利,并允许将软件提供给他人,以便他们可以这样做,前提是符合以下条件:上述版权声明和本许可声明应包含在软件的所有副本或实质性部分的副本中。

本软件按“原样”提供,不提供任何明示或暗示的保证,包括但不限于对适销性、针对特定目的的适用性和非侵权的保证。在任何情况下,作者或版权所有者不对任何索赔、损害或其他责任负责,无论是在合同行为、侵权行为或其他行为中产生的,无论是否与软件或其使用或其他交易有关。