Added array map naming strategy

[ojhaujjwal]

class User
{
    protected $name;

   public function setName($name)
   {
       $this->name = $name;  
   }

   public function getName() 
   {
        return $this->name;
    }
}

$hydrator = new Zend\Stdlib\Hydrator\ClassMethods;
$strategy = new Zend\Stdlib\Hydrator\NamingStrategy\ArrayMapNamingStrategy(array('name' => 'real_name'));
$hydrator->setNamingStrategy($strategy);

$user = new User();
$user->setName('Brad');

echo $hydrate->extract($user)['real_name']; // outputs Brad

[Ocramius]

@ojhaujjwal could you also see if you can write documentation for this feature?

[ojhaujjwal]

@Ocramius You mean here?

[Ocramius]

@ojhaujjwal yeap

[ojhaujjwal]

@Ocramius Consider it done 😄

[ojhaujjwal]

@Ocramius But, there is no any docs for Naming Strategy.
There is one for Strategy, but not for Naming Strategy.

[localheinz]

Please restart the build.

See #6205 (comment).

[Ocramius]

@ojhaujjwal correct, and we need docs, at least minimal ones.

[ojhaujjwal]

@Ocramius I am thinking of adding something. Hydration and extraction are quite symmetrical as @bakura10 said. So, I think that extraction and hydration map can be exactly opposite.

class User
{
    protected $name;

   public function setName($name)
   {
       $this->name = $name;  
   }

   public function getName() 
   {
        return $this->name;
    }
}

$hydrator = new Zend\Stdlib\Hydrator\ClassMethods;
$strategy = new Zend\Stdlib\Hydrator\NamingStrategy\ArrayMapNamingStrategy();
$strategy->setTwoWayMap(array('name' => 'real_name')); // this should be added
$hydrator->setNamingStrategy($strategy);

$user = new User();
$user->setName('Brad');
echo $hydrator->extract($user)['real_name']; // outputs Brad

$user = new User();
$hydrator->hydrate(['real_name' => 'Harry']);
echo $user->getName(); // outputs Harry

[ojhaujjwal]

@bakura @Ocramius The code I wrote in the last comment does not works because it not supported. The PR only supports two methods setExtractionMap and setHydrationMap. The above comment is RFC for adding a new method setTwoWayMap.

[texdc]

For bi-directional mapping:

/**
 * @param array $namingMap     [string source => string destination] (hydration-oriented)
 * @param bool  $biDirectional reverse the namingMap for extraction
 */
public function __construct(array $namingMap, $biDirectional = false)
{
    $this->hydrationMap  = $namingMap;
    $this->extractionMap = ($biDirectional) ? array_flip($namingMap) : $namingMap;
}

[texdc]

What's the use-case for 2 maps?

// this doesn't make any sense to me
$strategy = new ArrayMapNamingStrategy(['foo' => 'bar'], ['baz' => 'bat']);

The use-case I can think of for this class is for migrating old or external data. In which case, it's primarily one-directional. A single map suffices. If data is indeed moving both directions, the same single map is sufficient because it only needs to be flipped for the reverse direction.

[ojhaujjwal]

@texdc If there are more people who think that it does not make any sense, then, i will remove that feature. That is there for more flexibility.

ping @Ocramius, @bakura10.

[texdc]

Flexibility for the sake of flexibility is unnecessary complexity. Only code what is necessary.

On May 28, 2014, at 1:06 AM, Ujjwal Ojha [email protected] wrote:

@texdc If there are more people who think that it does not make any sense, then, i will remove that feature. That is there for more flexibility.

ping @Ocramius, @bakura10.

—
Reply to this email directly or view it on GitHub.

[ojhaujjwal]

Okay I will remove it if there are more people who think the same.

[Ocramius]

string[]

[adamlundrigan]

@ojhaujjwal what is the status of this?

I opened an issue on zf2-documentation regarding the lack of documentation for NamingStrategy (here)

[adamlundrigan]

@ojhaujjwal I agree with the suggestion to use a single map rather than separate hydration and extraction maps; IMO the hydrate and extract methods should be complimentary, so if you hydrate an object and then extract it the result of the extract should be the same as the initial input to hydrate.

My only suggestion there would be a better name than setTwoWayMap....setFieldMapping, maybe? or just setFieldMap ?

[ojhaujjwal]

@Ocramius @weierophinney What do you think about the use of single map rather than separate hydration and extraction maps?

[ojhaujjwal]

Ok, I created a single map. I realized that extracting and hydrating are meant to be exactly opposite.

[ojhaujjwal]

Please do comment. :D

[Ocramius]

@ojhaujjwal I am still thinking about all these new strategies, as I am very defensive against new features in general. The diff itself is quite clean.

[Ocramius]

private IMO

[Ocramius]

@ojhaujjwal I've merged this manually into develop after rebasing and making the newly introduced class final, thanks!

develop: 59ed600