Wallogit.com
2017 © Pedro Peláez
Library for Streaming contents of arrays/lists
, (*1)
Library for streaming contents of PHP arrays., (*2)
Add the following composer dependency: "jopic/php-streams": "1.0.3", (*3)
The library distinguishes between Lists (array with numeric indices) and and other Arrays. Therefore two initializations are possible, (*4)
$stream = Stream::ofList(array(1, 2, 3)); for Lists$arrayStream = Stream::ofArray(array("key1" => "value1"")); for array with different key typesthe method allows you to define the maximum number of records used in the result functions (each, toArray, collect), (*5)
Stream::ofList(array(1, 2, 3))
->limit(1) // limits the stream to the first element
the method allows you to define the number of matching elements to skip, (*6)
Stream::ofList(array(1, 2, 3))
->skip(1) // the resulting elements are (2, 3)
the method allows you to define the step width function for the for loop, (*7)
Stream::ofList(array(1, 2, 3, 4, 5))
->step(function($i) { return $i + 2; }); // will iterate over the following elements (1, 3, 5)
the method allows you to apply a filter method on the stream elements, (*8)
Stream::ofList(array(1, 2, 3, 4, 5))
->filter(function($item) { return $item % 2 == 0; }); // will filter the elements (2, 4)
the method allows you to apply a map function on the stream elements, (*9)
Stream::ofList(array(1, 2, 3))
->map(function($item) { return $item + 1; })
->toArray(); // will return the array(2, 3, 4)
the method resets all actions done with limit, skip, step and filter, (*10)
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)
the method iterates over all matching elements and executes the given function on each of them, (*11)
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, (*12)
the method collects all matching elements into a php array, (*13)
Stream::ofList(array(1, 2, 3, 4, 5))
->skip(2)
->limit(2)
->toArray(); // will return array(3, 4)
the method collects all matching elements into a string seperated by the give seperator, (*14)
Stream::ofList(array(1, 2, 3))
->collect(','); // will return "1,2,3"
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., (*15)
Stream::ofList(array(1, 2, 3))
->sum(); // will return 6
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., (*16)
Stream::ofList(array(1, 2, 3))
->min(); // will return 1
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., (*17)
Stream::ofList(array(1, 2, 3))
->max(); // will return 3
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., (*18)
Stream::ofList(array(1, 2, 3, 4))
->avg(); // will return 2.5
Example to skip the first element, filter for odd values, limit the result to 3 and collect the matching elements into a concatinated string, (*19)
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, (*20)
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")
If you find any issues or have ideas how to improve the library don't hesitate to open an issue on the github project., (*21)
Copyright 2015 Johannes Pichler, (*22)
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, (*23)
http://www.apache.org/licenses/LICENSE-2.0, (*24)
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., (*25)
Library for Streaming contents of arrays/lists
Apache-2.0
Library for Streaming contents of arrays/lists
Apache-2.0
Library for Streaming contents of arrays/lists
Apache-2.0
Library for Streaming contents of arrays/lists
Apache-2.0
Apache-2.0