scriptfusion / mapper Goto Github PK

CollectionMapper is currently undocumented in the readme.

The advanced mapping example needs to be rewritten to better demonstrate the usefulness of Mapper. The current example relies too heavily on the Callback strategy, which should seldom be used. Construct a better example utilising other strategies.

The method signature for CollectionMapper::mapCollection currently reads as follows.

public function mapCollection(\Iterator $collection, Mapping $mapping = null, $context = null)

This is unnecessarily restrictive because it requires a Mapping when any valid expression should suffice. It is proposed this signature be changed to the following.

/**
 * @param Strategy|Mapping|array|mixed $expression Expression.
 */
public function mapCollection(\Iterator $collection, $expression = null, $context = null)

Unfortunately this would be a BC-breaking change because of PHP's type invariance so it should target version 2.0.0.

When Mapper delegates to a strategy it places the burden on that strategy to propagate the key, which it does by invoking Mapper again with the key it received. If a strategy implements MapperAware but not KeyAware it will drop the key information, which is never desirable. Therefore, any strategy electing to be MapperAware should also accept the burden of being KeyAware, assuming we want to continue passing keys around in this fashion.

The reason they have been created as separate interfaces at this time is just to avoid breaking compatibility for code that currently implements MapperAware. In the next major version we should seek to either merge both interfaces into one or find a better way to propagate keys through the mapper altogether.

I'm trying to extend Mapping so that I can implement a reverse functionality, but the $mapping property is declared as private, which makes fully extending that class almost impossible. Could you please change private to protected so that child classes can change $mapping as they need?

Thanks!