Experimental API for PHP Scalar Objects
Clone or download
Pull request Compare This branch is 11 commits behind rossriley:master.
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
examples
src
tests
.gitignore
README.md
RFC.txt
composer.json
phpunit.xml.dist

README.md

PHP Scalar Object Handlers

Wouldn't you prefer to write PHP like this?

$n = 12.5;
echo $n->floor()->toString()->length(); // 2

Or deal with strings, without remembering the parameter order?

$str = "Hello World";
echo $str->replace("World","PHP"); // Hello PHP

$str = "Hello World";
echo $str->length();  //  11

Or chain array operations, with a simpler syntax API?

$arr = ["k1"=>"val1","k2"=>"val2"];
print_r($arr->merge(["k3"=>"val3","k4"=>"val4"])->count()) // 4

$array = [1,2,3,4,5];
$array->each(function(&$value) {
  $value *= 2;
});  // [2,4,6,8,10]

PHP6 Gives us a chance to create a new API to streamline the language in a way that ensures all old code still runs in the same way. Here's how to see this in action right now!

An Experimental Proposal for PHP Scalar Objects

Based on the fantastic extension by nikic https://github.com/nikic/scalar_objects this project is designed to start the ball rolling on the future API for Scalar objects in PHP.

Discussions, arguments and pull requests are welcome. Once we get some consensus, we can send a pull request up to nikic and hopefully get some discussion going on the internals list. Let's make PHP6 Awesome.

Note, the handlers won't actually be implemented in PHP, but the handlers and methods can be built natively once the API is agreed. This is just a way to get contributions from the wider PHP community without the need to know the internals.

Getting started

The handlers are written in PHP so, you don't need to install the extension to contribute, however full instructions for getting started are on the extension readme file at: https://github.com/nikic/scalar_objects

Supported types

Object handlers are supported for string, integer, array, float, null and resource

The handlers are PSR-4 loaded under the namespace Spl\Scalars in the src directory.

Arrays

Syntax available is as follows.

chunk(chunk size)

$array = ["first", "second", "third", "fourth", "fifth"];
$array->chunk(2);   //  [["first","second"],["third","fourth"],["fifth"]]

column(column key)

$array = [["key1"=>"value","key2"=>"value2"],["key1"=>"value","key2"=>"value2"]];
$array->column("key2");   //  ["value2","value2"]

combine(Array)

$array = ["k1","k2","k3","k4"];
$array2 = ["val","val2","val3","val4"];
$array->combine($array2);  //  ["k1"=>"val","k2"=>"val2","k3"=>"val3","k4"=>"val4"]

count()

$array = ["k1"=>"val","k2"=>"val2"];
$array->count();  //  2

diff(Array)

$array  = ["k1"=>"val","k2"=>"val2"];
$array2 = ["k2"=>"val2","k3"=>"val3"];
$array->diff($array2);  // ["k1" => "val"]

hasKey(keyname)

$array = ["k1"=>"val","k2"=>"val2"];
$array->hasKey("k2");  //  true

keys()

$array = ["k1"=>"val","k2"=>"val2"];
$array->keys();  //  ["k1","k2"]

merge(Array)

$array = ["k1"=>"val","k2"=>"val2"];
$array2 = ["k2"=>"val2","k3"=>"val3"];
$array->merge($array2);  //  ["k1"=>"val","k2"=>"val2","k3"=>"val3"]

push(value)

$array = ["k1"=>"val","k2"=>"val2"];
$array->push("val3");  //  ["k1"=>"val","k2"=>"val2",0=>"val3"]

rand()

$array = ["k1"=>"val","k2"=>"val2","k3"=>"val3"];
$array->rand();  //  "val3"

reverse()

$array = ["k1"=>"val","k2"=>"val2","k3"=>"val3"];
$array->reverse();  //  ["k3"=>"va3","k2"=>"val2","k1"=>"val"]

reindex(null | function($row))

$arr = [
  ["id"=>5, "val"=>"first"],["id"=>6, "val"=>"second"],["id"=>7, "val"=>"third"]
];
$array->reindex();  //  [0=>["id"=>5, "val"=>"first"],1=>["id"=>6, "val"=>"second"],2=>["id"=>7, "val"=>"third"]]
$array->reindex(function($row){return $row["id"]});  //  [5=>["id"=>5, "val"=>"first"],6=>["id"=>6, "val"=>"second"],7=>["id"=>7, "val"=>"third"]]

toJSON()

$array = ["k1"=>"val","k2"=>"val2","k3"=>"val3"];
$array->toJSON();  //  {"k1":"val","k2":"val2","k3":"val3"}

Strings

Syntax available is as follows.

length()

$str = "Hello World";
$str->length();  //  11

slice()

$str = "Hello World";
$str->slice(0,4);  // Hell

contains()

$str = "Hello World";
$str->contains("Hell");  // true

startsWith()

$str = "Hello World";
$str->startsWith("Help");  // false

endsWith()

$str = "Hello World";
$str->endsWith("rld");   // true

split()

$str = "Hello World";
$str->split(" ");  // ["Hello", "World"]

repeat()

$str = "Hello World";
$str->repeat(3);   // "Hello WorldHello WorldHello World"

reverse()

$str = "Hello World";
$str->reverse();   //  "dlroW olleH";

lower()

$str = "Hello World";
$str->lower();   // "hello world"

upper()

$str = "Hello World";
$str->upper();   // "HELLO WORLD"

toArray()

$str = "Hello World";
$str->toArray();   // [0=>"Hello World"]

Floats / Integers

abs()

$n = -25;
$n->abs();  // 25

ceil()

$n = 12.5;
$n->ceil();  // 13

floor()

$n = 12.5;
$n->floor();  // 12

toInt()

$n = 12.5;
$n->toInt();  // 12

Integers

even()

$n = 10;
$n->even();  // true

odd()

$n = 10;
$n->odd();   // false

Nulls

Syntax available is as follows.

$a = null;
$a->toJSON();  // []