README

This package contains some basic data structures (ArrayList, LinkedList...), data types (such as Integer, String...) and formats (URL, Random, JSON, ...).

Installation

Using composer:

composer require zuffik/structures

Usage

ArrayList and LinkedList

Both structures interfaces are same. Difference is only between storing data. ArrayList uses continous php array structure to store data and LinkedList uses chain of objects (one linked to another).

Example:

$list = new \Zuffik\Structures\Data\ArrayList();
$list->add(2, 3);           // Contains 2,3
$list->add(4, 5);           // Contains 2,3,4,5
$list->addFirst(1);         // Contains 1,2,3,4,5
$list->delete(1);           // Contains 1,3,4,5
$list->deleteByValue(1);    // Contains 3,4,5
$list->map(function($item) {
  return $item + 1;
});                         // Contains 4,5,6
$list->filter(function() {
  return $item % 2 == 1;
});                         // Contains 5
$list->size();              // Returns 1
$list->add('a');            // Contains 5, 'a'
$list->join(';');           // Returns '5;a'
// All these methods can be chained (except of size, join, etc.)
// Full docs will be available in next release

String

or Str class (because string is reserved keyword) offers the most used string function. This class can be converted to string thanks to __toString method or can be chained, because every method in class returns object not string. If mbstring extension is installed, this class uses it over the native php functions.

Example:

$string = new \Zuffik\Structures\Types\Str('Hello world');
$string->toUppercase();     // HELLO WORLD
$string->camelCase();       // helloWorld
$string->slug();            // hello-world
// Full docs will be available in next release

Contribution

You can contribute simply by creating pull request.

Donation

If you are satisfied with this package feel free to donate me:

zuffik / structures

Maintainers

Details