Skip to content
This repository was archived by the owner on Aug 14, 2022. It is now read-only.

Commit c79d867

Browse files
josantoniusjosantonius
committedJan 17, 2017
Initial upload files
·
1.1.81.0.0
0 parents  commit c79d867

13 files changed

+486
-0
lines changed
 

‎.editorconfig

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
root = true
2+
3+
[*]
4+
charset = utf-8
5+
indent_size = 4
6+
indent_style = space
7+
end_of_line = lf
8+
insert_final_newline = true
9+
trim_trailing_whitespace = true
10+
11+
[*.md]
12+
trim_trailing_whitespace = false

‎.gitignore

+12
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
phpunit.xml
2+
composer.phar
3+
composer.lock
4+
composer-test.lock
5+
vendor/
6+
build/artifacts/
7+
artifacts/
8+
docs/_build
9+
docs/*.pyc
10+
.git*/
11+
.idea
12+
.DS_STORE

‎CHANGELOG.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
# CHANGELOG
2+
3+
## 1.0.0 - 2017-01-17
4+
* Added `Josantonius\File\File` class.
5+
* Added `Josantonius\File\File::searchString()` method.
6+
7+
## 1.0.0 - 2017-01-17
8+
* Added `Josantonius\File\Exception\FileException` class.
9+
* Added `Josantonius\File\Exception\Exceptions` abstract class.
10+
* Added `Josantonius\File\Exception\FileException->__construct()` method.
11+
12+
## 1.0.0 - 2017-01-17
13+
* Added `Josantonius\File\Tests\FileTest` class.
14+
* Added `Josantonius\File\Tests\FileTest::testSearchString()` method.

‎CONDUCT.md

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# Contributor Code of Conduct
2+
3+
As contributors and maintainers of this project, and in the interest of fostering an open and welcoming community, we pledge to respect all people who contribute through reporting issues, posting feature requests, updating documentation, submitting pull requests or patches, and other activities.
4+
5+
We are committed to making participation in this project a harassment-free experience for everyone, regardless of level of experience, gender, gender identity and expression, sexual orientation, disability, personal appearance, body size, race, ethnicity, age, religion, or nationality.
6+
7+
Examples of unacceptable behavior by participants include:
8+
9+
* The use of sexualized language or imagery
10+
* Personal attacks
11+
* Trolling or insulting/derogatory comments
12+
* Public or private harassment
13+
* Publishing other's private information, such as physical or electronic addresses, without explicit permission
14+
* Other unethical or unprofessional conduct.
15+
16+
Project maintainers have the right and responsibility to remove, edit, or reject comments, commits, code, wiki edits, issues, and other contributions that are not aligned to this Code of Conduct. By adopting this Code of Conduct, project maintainers commit themselves to fairly and consistently applying these principles to every aspect of managing this project. Project maintainers who do not follow or enforce the Code of Conduct may be permanently removed from the project team.
17+
18+
This code of conduct applies both within project spaces and in public spaces when an individual is representing the project or its community in a direct capacity. Personal views, beliefs and values of individuals do not necessarily reflect those of the organisation or affiliated individuals and organisations.
19+
20+
Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by opening an issue or contacting one or more of the project maintainers.
21+
22+
This Code of Conduct is adapted from the [Contributor Covenant](http://contributor-covenant.org), version 1.2.0, available at [http://contributor-covenant.org/version/1/2/0/](http://contributor-covenant.org/version/1/2/0/)

‎LICENSE

+22
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
The MIT License (MIT)
2+
=====================
3+
4+
Copyright (c) `2017` `Josantonius, https://github.com/Josantonius <info@josantonius.com>`
5+
6+
Permission is hereby granted, free of charge, to any person obtaining a copy of
7+
this software and associated documentation files (the "Software"), to deal in
8+
the Software without restriction, including without limitation the rights to
9+
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies
10+
of the Software, and to permit persons to whom the Software is furnished to do
11+
so, subject to the following conditions:
12+
13+
The above copyright notice and this permission notice shall be included in all
14+
copies or substantial portions of the Software.
15+
16+
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
17+
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
18+
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
19+
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
20+
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
21+
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
22+
SOFTWARE.

‎README-ES.md

+112
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,112 @@
1+
# PHP File library
2+
3+
[![Latest Stable Version](https://poser.pugx.org/josantonius/file/v/stable)](https://packagist.org/packages/josantonius/file) [![Total Downloads](https://poser.pugx.org/josantonius/file/downloads)](https://packagist.org/packages/josantonius/file) [![Latest Unstable Version](https://poser.pugx.org/josantonius/file/v/unstable)](https://packagist.org/packages/josantonius/file) [![License](https://poser.pugx.org/josantonius/file/license)](https://packagist.org/packages/josantonius/file)
4+
5+
[Spanish version](README-ES.md)
6+
7+
Librería PHP para manejo de archivos.
8+
9+
---
10+
11+
- [Instalación](#instalación)
12+
- [Requisitos](#requisitos)
13+
- [Cómo empezar y ejemplos](#cómo-empezar-y-ejemplos)
14+
- [Métodos disponibles](#métodos-disponibles)
15+
- [Uso](#uso)
16+
- [Tests](#tests)
17+
- [Manejador de excepciones](#manejador-de-excepciones)
18+
- [Contribuir](#contribuir)
19+
- [Repositorio](#repositorio)
20+
- [Autor](#autor)
21+
- [Licencia](#licencia)
22+
23+
---
24+
25+
### Instalación
26+
27+
La mejor forma de instalar esta extensión es a través de [composer](http://getcomposer.org/download/).
28+
29+
Para instalar PHP File library, simplemente escribe:
30+
31+
$ composer require Josantonius/File
32+
33+
### Requisitos
34+
35+
Esta ĺibrería es soportada por versiones de PHP 7.0 o superiores y es compatible con versiones de HHVM 3.0 o superiores.
36+
37+
Para utilizar esta librería en HHVM (HipHop Virtual Machine) tendrás que activar los tipos escalares. Añade la siguiente ĺínea "hhvm.php7.scalar_types = true" en tu "/etc/hhvm/php.ini".
38+
39+
### Cómo empezar y ejemplos
40+
41+
Para utilizar esta librería, simplemente:
42+
43+
```php
44+
require __DIR__ . '/vendor/autoload.php';
45+
46+
use Josantonius\File\File;
47+
```
48+
### Métodos disponibles
49+
50+
Métodos disponibles en esta librería:
51+
52+
```php
53+
File::searchString();
54+
```
55+
### Uso
56+
57+
Ejemplo de uso para esta librería:
58+
59+
```php
60+
<?php
61+
require __DIR__ . '/vendor/autoload.php';
62+
63+
use Josantonius\File\File;
64+
65+
$search = 'Morbi';
66+
67+
$filepath = getcwd() . '/' . 'resources/file.txt';
68+
69+
File::searchString($search, $filepath); /* bool(true) */
70+
```
71+
72+
### Tests
73+
74+
Para utilizar la clase de [pruebas](tests), simplemente:
75+
76+
```php
77+
<?php
78+
$loader = require __DIR__ . '/vendor/autoload.php';
79+
80+
$loader->addPsr4('Josantonius\\File\\Tests\\', __DIR__ . '/vendor/josantonius/file/tests');
81+
82+
use Josantonius\File\Tests\FileTest;
83+
```
84+
Métodos de prueba disponibles en esta librería:
85+
86+
```php
87+
FileTest::testSearchString();
88+
```
89+
90+
### Manejador de excepciones
91+
92+
Esta librería utiliza [control de excepciones](src/Exception) que puedes personalizar a tu gusto.
93+
### Contribuir
94+
1. Comprobar si hay incidencias abiertas o abrir una nueva para iniciar una discusión en torno a un fallo o función.
95+
1. Bifurca la rama del repositorio en GitHub para iniciar la operación de ajuste.
96+
1. Escribe una o más pruebas para la nueva característica o expón el error.
97+
1. Haz cambios en el código para implementar la característica o reparar el fallo.
98+
1. Envía pull request para fusionar los cambios y que sean publicados.
99+
100+
Esto está pensado para proyectos grandes y de larga duración.
101+
102+
### Repositorio
103+
104+
Los archivos de este repositorio se crearon y subieron automáticamente con [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit).
105+
106+
### Autor
107+
108+
Mantenido por [Josantonius](https://github.com/Josantonius/).
109+
110+
### Licencia
111+
112+
Este proyecto está licenciado bajo la **licencia MIT**. Consulta el archivo [LICENSE](LICENSE) para más información.

‎README.md

+113
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,113 @@
1+
# PHP File library
2+
3+
[![Latest Stable Version](https://poser.pugx.org/josantonius/file/v/stable)](https://packagist.org/packages/josantonius/file) [![Total Downloads](https://poser.pugx.org/josantonius/file/downloads)](https://packagist.org/packages/josantonius/file) [![Latest Unstable Version](https://poser.pugx.org/josantonius/file/v/unstable)](https://packagist.org/packages/josantonius/file) [![License](https://poser.pugx.org/josantonius/file/license)](https://packagist.org/packages/josantonius/file)
4+
5+
[Spanish version](README-ES.md)
6+
7+
PHP library for file management.
8+
9+
---
10+
11+
- [Installation](#installation)
12+
- [Requirements](#requirements)
13+
- [Quick Start and Examples](#quick-start-and-examples)
14+
- [Available Methods](#available-methods)
15+
- [Usage](#usage)
16+
- [Tests](#tests)
17+
- [Exception Handler](#exception-handler)
18+
- [Contribute](#contribute)
19+
- [Repository](#repository)
20+
- [Author](#author)
21+
- [Licensing](#licensing)
22+
23+
---
24+
25+
### Installation
26+
27+
The preferred way to install this extension is through [composer](http://getcomposer.org/download/).
28+
29+
To install PHP File library, simply:
30+
31+
$ composer require Josantonius/File
32+
33+
### Requirements
34+
35+
This library is supported by PHP versions 7.0 or higher and is compatible with HHVM versions 3.0 or higher.
36+
37+
To use this library in HHVM (HipHop Virtual Machine) you will have to activate the scalar types. Add the following line "hhvm.php7.scalar_types = true" in your "/etc/hhvm/php.ini".
38+
39+
### Quick Start and Examples
40+
41+
To use this class, simply:
42+
43+
```php
44+
require __DIR__ . '/vendor/autoload.php';
45+
46+
use Josantonius\File\File;
47+
```
48+
### Available Methods
49+
50+
Available methods in this library:
51+
52+
```php
53+
File::searchString();
54+
```
55+
### Usage
56+
57+
Example of use for this library:
58+
59+
```php
60+
<?php
61+
require __DIR__ . '/vendor/autoload.php';
62+
63+
use Josantonius\File\File;
64+
65+
$search = 'Morbi';
66+
67+
$filepath = getcwd() . '/' . 'resources/file.txt';
68+
69+
File::searchString($search, $filepath); /* bool(true) */
70+
```
71+
72+
### Tests
73+
74+
To use the [test](tests) class, simply:
75+
76+
```php
77+
<?php
78+
$loader = require __DIR__ . '/vendor/autoload.php';
79+
80+
$loader->addPsr4('Josantonius\\File\\Tests\\', __DIR__ . '/vendor/josantonius/file/tests');
81+
82+
use Josantonius\File\Tests\FileTest;
83+
84+
```
85+
Available test methods in this library:
86+
87+
```php
88+
FileTest::testSearchString();
89+
```
90+
91+
### Exception Handler
92+
93+
This library uses [exception handler](src/Exception) that you can customize.
94+
### Contribute
95+
1. Check for open issues or open a new issue to start a discussion around a bug or feature.
96+
1. Fork the repository on GitHub to start making your changes.
97+
1. Write one or more tests for the new feature or that expose the bug.
98+
1. Make code changes to implement the feature or fix the bug.
99+
1. Send a pull request to get your changes merged and published.
100+
101+
This is intended for large and long-lived objects.
102+
103+
### Repository
104+
105+
All files in this repository were created and uploaded automatically with [Reposgit Creator](https://github.com/Josantonius/BASH-Reposgit).
106+
107+
### Author
108+
109+
Maintained by [Josantonius](https://github.com/Josantonius/).
110+
111+
### Licensing
112+
113+
This project is licensed under **MIT license**. See the [LICENSE](LICENSE) file for more info.

‎composer.json

+43
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,43 @@
1+
{
2+
"name": "josantonius/file",
3+
"version": "1.0.0",
4+
"type": "library",
5+
"description": "PHP library for file management.",
6+
"keywords": [
7+
"File",
8+
"Search words in file",
9+
"File handler",
10+
"Strings",
11+
"HHVM",
12+
"PHP"
13+
],
14+
"license": "MIT",
15+
"authors": [
16+
{
17+
"name": "Josantonius",
18+
"email": "info@josantonius.com",
19+
"homepage": "https://github.com/josantonius",
20+
"role": "Developer"
21+
}
22+
],
23+
"minimum-stability": "dev",
24+
"prefer-stable" : true,
25+
"require": {
26+
"php" : ">=7.0"
27+
},
28+
"autoload": {
29+
"psr-4": {
30+
"Josantonius\\File\\": "src/"
31+
}
32+
},
33+
"autoload-dev": {
34+
"psr-4": {
35+
"Josantonius\\File\\Tests\\": "tests/"
36+
}
37+
},
38+
"extra": {
39+
"branch-alias": {
40+
"dev-master": "1.0-dev"
41+
}
42+
}
43+
}

‎contributors.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Josantonius

‎src/Exception/FileException.php

+44
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
<?php declare(strict_types=1);
2+
/**
3+
* PHP library for file management.
4+
*
5+
* @category JST
6+
* @package File
7+
* @subpackage FileException
8+
* @author Josantonius - info@josantonius.com
9+
* @copyright Copyright (c) 2017 JST PHP Framework
10+
* @license https://opensource.org/licenses/MIT - The MIT License (MIT)
11+
* @version 1.0.0
12+
* @link https://github.com/Josantonius/PHP-File
13+
* @since File available since 1.0.0 - Update: 2017-01-17
14+
*/
15+
16+
namespace Josantonius\File\Exception;
17+
18+
/**
19+
* Exception class for File library.
20+
*
21+
* You can use an exception and error handler with this library.
22+
*
23+
* @since 1.0.0
24+
*
25+
* @link https://github.com/Josantonius/PHP-ErrorHandler
26+
*/
27+
class FileException extends \Exception {
28+
29+
/**
30+
* Exception handler.
31+
*
32+
* @since 1.0.0
33+
*
34+
* @param string $msg → message error (Optional)
35+
* @param int $error → error code (Optional)
36+
* @param int $status → HTTP response status code (Optional)
37+
*/
38+
public function __construct(string $msg = '', int $error = 0, int $status = 0) {
39+
40+
$this->message = $msg;
41+
$this->code = $error;
42+
$this->statusCode = $status;
43+
}
44+
}

‎src/File.php

+50
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
<?php declare(strict_types=1);
2+
/**
3+
* PHP library for file management.
4+
*
5+
* @category JST
6+
* @package File
7+
* @subpackage File
8+
* @author Josantonius - info@josantonius.com
9+
* @copyright Copyright (c) 2017 JST PHP Framework
10+
* @license https://opensource.org/licenses/MIT - The MIT License (MIT)
11+
* @version 1.0.0
12+
* @link https://github.com/Josantonius/PHP-File
13+
* @since File available since 1.0.0 - Update: 2017-01-17
14+
*/
15+
16+
namespace Josantonius\File;
17+
18+
# use Josantonius\File\Exception\FileException;
19+
20+
/**
21+
* File handler.
22+
*
23+
* @since 1.0.0
24+
*/
25+
class File {
26+
27+
/**
28+
* Search for part of a string in a file.
29+
*
30+
* @since 1.0.0
31+
*
32+
* @param string $search → word or term to search
33+
* @param string $pathfile → full path to the file
34+
*
35+
* @return bool
36+
*/
37+
public static function searchString(string $search, string $pathfile): bool {
38+
39+
$file = fopen($pathfile, "r+");
40+
41+
while(!feof($file)) {
42+
43+
$result = fgets($file);
44+
}
45+
46+
fclose($file);
47+
48+
return (strpos($result, $search)) ? true : false;
49+
}
50+
}

‎tests/FileTest.php

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
<?php
2+
/**
3+
* PHP library for file management.
4+
*
5+
* @category JST
6+
* @package File
7+
* @subpackage FileTest
8+
* @author Josantonius - info@josantonius.com
9+
* @copyright Copyright (c) 2017 JST PHP Framework
10+
* @license https://opensource.org/licenses/MIT - The MIT License (MIT)
11+
* @version 1.0.0
12+
* @link https://github.com/Josantonius/PHP-File
13+
* @since File available since 1.0.0 - Update: 2017-01-17
14+
*/
15+
16+
namespace Josantonius\File\Tests;
17+
18+
use Josantonius\File\File;
19+
20+
/**
21+
* Tests class for File library.
22+
*
23+
* @since 1.0.0
24+
*/
25+
class FileTest {
26+
27+
/**
28+
* Search for part of a string in a file.
29+
*
30+
* @since 1.0.0
31+
*/
32+
public static function testSearchString() {
33+
34+
$search = 'Morbi';
35+
36+
$filepath = 'resources/file.txt';
37+
38+
var_dump(File::searchString($search, $filepath));
39+
}
40+
}

‎tests/resources/file.txt

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Quisque cursus magna vel egestas pellentesque. Cras semper leo nec nisi viverra iaculis. Fusce sit amet efficitur tellus. Pellentesque habitant morbi tristique senectus et netus et malesuada fames ac turpis egestas. Morbi eget eros dignissim, vulputate massa in, ultrices velit. Mauris condimentum venenatis molestie. Donec laoreet volutpat ante, eget elementum risus rutrum non.

0 commit comments

Comments
 (0)
This repository has been archived.