Created DateTime Formater strategy for hydrator

[ojhaujjwal]

I screwed up PR #6198

Removed Zend\Filter dependency.

class User
{
    protected $registrationDate;

    public function setRegistrationDate(DateTime $registrationDate)
    {
        $this->registrationDate = $registrationDate;
    }

    public function getRegistrationDate()
    {
        return $this->registrationDate;
    }
}

$user = new User;

$hydrator = new Zend\Stdlib\Hydrator\ClassMethods;
$strategy = new Zend\Stdlib\Hydrator\Strategy\DateTimeFormaterStrategy('Y-m-d');
$hydrator->addStrategy('registration_date', $strategy);
$hydrator->hydrate(array('registration_date' => '2014-04-26'), $user);

echo $user->getRegistrationDate()->format('Y-m-d'); // will print 2014-04-26
echo $hydrator->extract($user)['registration_date']; // will print 2014-04-26

[bakura10]

Not needed as if value is null it will be returned at the end of the method.

[ojhaujjwal]

I am stupid. Thanks.

[DASPRiD]

What about timezone handling, for both extraction and hydration? There should be a way to define the timezone of the string representation for both extraction and hydration, in case the datetime format does not define a timezone.

[ojhaujjwal]

@bakura10 Any idea how?

[devosc]

What about only returning $value only if the format function returns false? This would allow integer, and strings to be formatted also?

[bakura10]

I'm not sure about the timezone. Can't you set the timezone globally ? iirc format uses the server timezone, isn't it what we want in general?

[bakura10]

@devosc , good idea, you could add a check for int:

public function extract($value) {
    if (is_int($value)) {
        $timestamp = $value;
        $value         = new DateTime();
        $value->setTimestamp($timestamp);
   }
}

[DASPRiD]

To give a concrete example, why createFromFormat must know the timezone (note: the time given by a user my differ from the system timezone):

2014-10-26 02:30:00 can define two different points in time in the Europe/Berlin timezone, thanks to that stupid invention called DST. Thus it is required to know whether it is defined as CET or CEST.

[ojhaujjwal]

@DASPRiD What about this way?
For hydration:

public function hydrate($value)
{
    if ($value === '' || $value === null) {
        return null;
    }

    return DateTime::createFromFormat($this->format, $value, $this->hydrateTimeZone);
}

For extraction:

public function extract($value)
{
    if ($value instanceof DateTime) {
        if ($this->extractTimeZone instance DateTimeZone) {
              $value->setTimezone($this->extractTimeZone);
        }
        return $value->format($this->format);
    }

    return $value;
}

[DASPRiD]

I don't see a concrete reason to have two different timezones for extraction and hydration. A hydrator should always work synchronous in both way. If the extraction timezone would differ from the hydration timezone, then the following would be false, which is basically wrong:

$value === $strategy->extract($strategy->hydrate($value));

Apart from that, it sounds fine.

[ojhaujjwal]

@DASPRiD I have done some work for timezone. Please check out.

[DASPRiD]

Looks good.

[bakura10]

Looks good to me, @weierophinney , that should be ready for merging :).

[bakura10]

+1

[ojhaujjwal]

All is well

[Martin-P]

There is a method setTimezone and I think for debugging it is usefull to add a method getTimezone. Also I think setFormat and getFormat are usefull additions, because now only the DateTimeZone can be set via a setter.

[Ocramius]

Are the setters required?

[ojhaujjwal]

I think so. timezone is optional.

[Ocramius]

It's still a constructor argument, so I think it doesn't need a setter

[ojhaujjwal]

Ok. I will remove it.

[adamlundrigan]

What's the status of this? If it's ready to go, could you rebase and squash the commits?

[ojhaujjwal]

@adamlundrigan Thanks for reminding. I have rebased and squashed the commits.

[Ocramius]

I've made the class final, removed the setter and added some tests for edge cases (invalid hydrated string, invalid constructor args). Thanks @ojhaujjwal!

develop: 0871565