README

Library for streaming contents of PHP arrays.

Requirements

PHP version >= 5.3

Installation

Add the following composer dependency: "jopic/php-streams": "1.0.3"

Usage

Initialization

The library distinguishes between Lists (array with numeric indices) and and other Arrays. Therefore two initializations are possible

$stream = Stream::ofList(array(1, 2, 3)); for Lists
$arrayStream = Stream::ofArray(array("key1" => "value1"")); for array with different key types

limit

the method allows you to define the maximum number of records used in the result functions (each, toArray, collect)

Stream::ofList(array(1, 2, 3))
    ->limit(1) // limits the stream to the first element

skip

the method allows you to define the number of matching elements to skip

Stream::ofList(array(1, 2, 3))
    ->skip(1) // the resulting elements are (2, 3)

step (ListStream only)

the method allows you to define the step width function for the for loop

Stream::ofList(array(1, 2, 3, 4, 5))
    ->step(function($i) { return $i + 2; }); // will iterate over the following elements (1, 3, 5)

filter

the method allows you to apply a filter method on the stream elements

Stream::ofList(array(1, 2, 3, 4, 5))
    ->filter(function($item) { return $item % 2 == 0; }); // will filter the elements (2, 4)

map

the method allows you to apply a map function on the stream elements

Stream::ofList(array(1, 2, 3))
    ->map(function($item) { return $item + 1; })
    ->toArray(); // will return the array(2, 3, 4)

reset

the method resets all actions done with limit, skip, step and filter

Stream::ofList(array(1, 2, 3, 4, 5))
    ->filter(function($item) { return $item % 2 == 0; }) // matching elements (2, 4)
    ->reset(); // matching elements (1, 2, 3, 4, 5)

each

the method iterates over all matching elements and executes the given function on each of them

Stream::ofList(array(1, 2, 3, 4, 5))
    ->each(function($item) { echo $item; }); // will print all items

Important: The ArrayStream implementation of each is called with two parameters key and value

toArray

the method collects all matching elements into a php array

Stream::ofList(array(1, 2, 3, 4, 5))
    ->skip(2)
    ->limit(2)
    ->toArray(); // will return array(3, 4)

collect (ListStream only)

the method collects all matching elements into a string seperated by the give seperator

Stream::ofList(array(1, 2, 3))
    ->collect(','); // will return "1,2,3"

sum

the method sums up all matching elements. This functionality is available either when all values within the array are of the same numeric datatype or if a map function is defined.

Stream::ofList(array(1, 2, 3))
    ->sum(); // will return 6

min

the method returns the minimum value of all matching elements. This functionality is available either when all values within the array are of the same numeric datatype or if a map function is defined.

Stream::ofList(array(1, 2, 3))
    ->min(); // will return 1

max

the method returns the maximum value of all matching elements. This functionality is available either when all values within the array are of the same numeric datatype or if a map function is defined.

Stream::ofList(array(1, 2, 3))
    ->max(); // will return 3

avg

the method returns the average value of all matching elements. This functionality is available either when all values within the array are of the same numeric datatype or if a map function is defined.

Stream::ofList(array(1, 2, 3, 4))
    ->avg(); // will return 2.5

Examples

Example to skip the first element, filter for odd values, limit the result to 3 and collect the matching elements into a concatinated string

Stream::ofList(array(1, 2, 3, 4, 5, 6))
    ->skip(1)
    ->filter(function($item) {
        return $item % 2 == 1;
    })
    ->limit(3)
    ->collect(', ') // will return "3, 5"

Example for associative array (filters for key is numeric and returns the matching elements as array

Stream::ofArray(array(
        "key1" => "value1",
        "key2" => 2,
        "key3" => 3,
        4 => "value 4"
    ))
    ->filter(function($key, $value) {
        return is_numeric($key);
    })
    ->toArray(); // will return array(4 => "value 4")

Issues or Improvements

If you find any issues or have ideas how to improve the library don't hesitate to open an issue on the github project.

Copyright & License

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

jopic / php-streams

Maintainers

Details