https://github.com/mickaelandrieu/utils
Set of utilities from BackBee project
https://github.com/mickaelandrieu/utils
Last synced: 7 months ago
JSON representation
Set of utilities from BackBee project
- Host: GitHub
- URL: https://github.com/mickaelandrieu/utils
- Owner: mickaelandrieu
- License: gpl-3.0
- Created: 2015-06-04T14:06:21.000Z (over 10 years ago)
- Default Branch: master
- Last Pushed: 2015-06-27T21:06:47.000Z (over 10 years ago)
- Last Synced: 2025-02-03T22:38:15.961Z (8 months ago)
- Language: PHP
- Homepage: http://www.backbee.com
- Size: 149 KB
- Stars: 0
- Watchers: 2
- Forks: 5
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
utils library
=============
utils library was extracted from BackBee core project.
This contains a lot of useful methods to manipulate files, arrays and strings.
** Note that this library is still a work in progress. **
[](https://travis-ci.org/backbee/utils)
[](https://scrutinizer-ci.com/g/backbee/utils/?branch=master)
[](https://scrutinizer-ci.com/g/backbee/utils/?branch=master)
1) Collection
-------------
PHP is one of the more convenient programming language to work with arrays
despite the inconsistency of the API.
We have implemented some methods to ease the conversion of arrays in XML and CSV.
We also provide some useful method you can need when you work with associative arrays.
Example:
```php
require_once('some_autoloader.php');
use BackBee\Utils\Collection\Collection;
$users = [0 => ['name' => 'Charles', 'role' => 'lead developper'],
1 => ['name' => 'Eric', 'role' => 'developper'],
];
echo Collection::toCsv($users, ';');
/**
* Will return:
* Charles;lead developper
* Eric;developper
*/
$users = ['users' => [
0 => ['name' => 'Charles', 'role' => 'lead developper'],
1 => ['name' => 'Eric', 'role' => 'developper'],
],
];
echo Collection::toBasicXml($users, ';');
/**
*
* <0>
* Eric
* developper
* 0>
* <1>
* Charles
* lead developper
* 1>
*
*/
$tree = [
'root' => [
'child' => [
'subchild' => 'value',
],
],
];
Collection::has($tree, 'root:child:subchild'); // return true
Collection::has($tree, 'root::child::subchild', '::'); // return true
Collection::has($tree, 'root:child:foo'); // return false
```
2) Strings
----------
We have added to this library some methods to ease encoding operations.
We provide also some useful functions to handle with strings which have particular meanings like file size or path, urls.
Example:
```php
require_once('some_autoloader.php');
use BackBee\Utils\String;
/**
* Some helpers for encoding operations
*/
mb_detect_encoding(String::toASCII('BackBee')); // "ASCII"
mb_detect_encoding(String::toUTF8('w�ird')); // "UTF-8"
/**
* Some normalizers for filepaths and urls
*/
$options = ['extension' => '.txt', 'spacereplace' => '_'];
String::toPath('test path', $options)); // "test_path.txt"
$options = ['extension' => '.com', 'spacereplace' => '_'];
String::urlize('test`s url', $options); // "tests_url.com"
/**
* Convenients formatters for file size
*/
String::formatBytes(2000, 3); // "1.953 kb"
String::formatBytes(567000, 5); // "553.71094 kb"
String::formatBytes(567000); // "553.71 kb"
String::formatBytes(5670008902); // "5.28 gb"
```
3) Dir & File
-------------
We have added to this library some methods to folders manipulation.
We provide for now 4 methods: ``copy()``, ``delete()``, ``getContent()`` and ``move()``.
Example:
```php
require_once('some_autoloader.php');
use BackBee\Utils\File\Dir;
/**
* /src
* foo/
* bar.txt
* baz.xml
*/
$fooPath = __DIR__.DIRECTORY_SEPARATOR.'foo';
$fooFooPath = $fooPath.DIRECTORY_SEPARATOR.'foo';
$fooBazPath = $fooPath.DIRECTORY_SEPARATOR.'baz';
Dir::copy($fooPath, $fooFooPath);
/**
* /src
* foo/
* bar.txt
* baz.xml
* foo/
* bar.txt
* baz.xml
* baz/
* bar.txt
* baz.xml
*/
Dir::delete($fooFooPath);
/**
* /src
* foo/
* bar.txt
* baz.xml
* baz/
* bar.txt
* baz.xml
*/
Dir::getContent(__DIR__);
/**
* ['foo' =>
* ['bar.txt', 'bar.xml', 'baz' =>
* ['bar.txt', 'bar.xml']
* ]
* ]
*/
$backbeePath =$fooPath.DIRECTORY_SEPARATOR.'backbee';
Dir::move($fooBazPath, $backbeePath, 000);
/**
* /src
* foo/
* bar.txt
* baz.xml
* backbee/
* bar.txt
* baz.xml
*/
Dir::getContent($backbeePath); // throw Exception()
```