honeycomb/method-sort

Misc framework/library agnostic utility classes and objects

3.0.3 2022-04-05 01:57 UTC

Requires

• php: >=5.6.0

Requires (Dev)

• codeception/codeception: ^2.4

MIT

• Brian Tam
• Matthew Sahagian

README

Honeycomb is a collection of useful utility objects that are framework/library agnostic. Each class aims to do one thing and do it well.

MethodSort

The MethodSort class is a stateful object which implements __invoke, such that an instance of the object can be passed as a preconfigured comparison function for standard sorting. Method sort enables ordering objects via the results of called methods.

For example. Let's say you have a Person:

class Person {
	public function __construct($firstname, $lastname) {
		$this->firstname = $firstname;
		$this->lastname  = $lastname;
	}

	public function getFirstName()
	{
		return $this->firstname;
	}

	public function getLastName()
	{
		return $this->lastname;
	}
}

Now let's say you have an array of people:

$objects     = [
	'ms' => new Person('Matthew', 'Sahagian'),
	'mj' => new Person('Matthew', 'Jones'),
	'bt' => new Person('Brian', 'Tam')
];

You can sort them, by first name, then by last name using MethodSort:

$method_sort = new Honeycomb\MethodSort();

$method_sort->setOrder([
	'getFirstName' => 'asc',
	'getLastName'  => 'asc'
]);

uasort($objects, $method_sort);

Objects now contains:

array (
  'bt' =>
  Person::__set_state(array(
     'firstname' => 'Brian',
     'lastname' => 'Tam',
  )),
  'mj' =>
  Person::__set_state(array(
     'firstname' => 'Matthew',
     'lastname' => 'Jones',
  )),
  'ms' =>
  Person::__set_state(array(
     'firstname' => 'Matthew',
     'lastname' => 'Sahagian',
  )),
)