How do I setup Birthdates using Yii3 and its Cycle-ORM integration?

Question

Preconditions

1. mySql database client_birthdate field set as DATE and nullable if user does not enter date.
2. User inputs Client's Birthdate on __form textbox as a string in mySql format YYYY/MM/DD or not.
3. Yii3's ClientForm gets the string or empty string and converts to DATETIME so that Cycle Orm can process it.
4. Yii3's ClientService saves the date using Cycle's Client Entity's getter and setter methods and annotations.
5. Php 7.4.9
6. Typed property. Previously php allowed this variable declaration below a class public $var; now inserting typed property between public and $var ie public ?string $var = '' excludes other types. Question mark before type allows for null value input. So only two alternatives.
7. Understanding mySql's '0000-00-00' for non date input.
8. Download fork of https://github.com/yiisoft/yii-demo

dateHelper.php (adapted from Invoiceplane)

/**
  * @return string|null
*/
public function date_from_mysql($date, $s)
{
       //if previous input was not a date mySql would have input '0000-00-00' 
       if ($date <> '0000-00-00') {
            //CYCLE converts all dates to DateTimeImmutable
             $date = DateTime::createFromImmutable($date);
            //$date = DateTime::createFromFormat('Y-m-d', $date);
            //eg. $date->format('Ymd') 
            return $date->format($s->setting('date_format'));
        }
        return $date;
    }
    return '';
}

__form.php caption

 <div class="mb-3 form-group has-feedback">
        <label form-label for="client_birthdate"><?= $s->trans('birthdate'); ?></label>
       <?php
            $bdate = $body['client_birthdate'] ?? null;
            if ($bdate && $bdate != "0000-00-00") {
                //use the DateHelper
                $datehelper = new DateHelper();
                $bdate = $datehelper->date_from_mysql($bdate, false, $s);
            } else {
                $bdate = null;
            }
        ?>        
        <div class="input-group">
            <input type="text" name="client_birthdate" id="client_birthdate" placeholder="1900/12/01"
                   class="form-control data-datepicker"
                   value="<?= Html::encode($bdate); ?>">
            <span class="input-group-addon">
            <i class="fa fa-calendar fa-fw"></i>
        </span>
        </div>        
    </div>  

Entity/Client.php

declare(strict_types=1);

namespace App\Invoice\Entity;
use \DateTime;

/**
 * @Entity(
 *     repository="App\Invoice\Client\ClientRepository",
 *     mapper="App\Invoice\Client\ClientMapper",
 *     constrain="App\Invoice\Client\Scope\activeScope"
 * )
 * @Table(
 *     indexes={
 *         @Index(columns={"client_active"}),
 *     }
 * )
 */
class Client
{
    /**
     * @Column(type="date", nullable=true)
     */
    private $client_birthdate = '';
    
    //CYCLE converts all date formats ie. DATE, DATETIME, to DateTimeImmutable so 
    work with DateTimeImmutable 
    
    public function __construct($client_birthdate = '')

    public function getClient_birthdate() : ?DateTimeImmutable  
    {
        if (isset($this->client_birthdate) && !empty($this->client_birthdate)){
            return $this->client_birthdate;            
        }
        if (empty($this->client_birthdate)){
            return $this->client_birthdate = null;
        }
    }    
    
    public function setClient_birthdate(?\DateTime $client_birthdate): void
    {
        $this->client_birthdate = $client_birthdate;
    }

Client/ClientForm.php

declare(strict_types=1);

namespace App\Invoice\Client;

use Yiisoft\Form\FormModel;
use Yiisoft\Validator\Rule\Required;
use \DateTimeImmutable;
use \DateTime;

final class ClientForm extends FormModel {

private ?string $client_birthdate = null;

public function getClient_birthdate(): ?\DateTime
    {
        if (isset($this->client_birthdate) && !empty($this->client_birthdate)){
            return new DateTime($this->client_birthdate);            
        }
        if (empty($this->client_birthdate)){
            return $this->client_birthdate = null;
        } 
    }

Client/ClientService

<?php

declare(strict_types=1);

namespace App\Invoice\Client;

use App\Invoice\Entity\Client;
use App\User\User;

final class ClientService
{
private ClientRepository $repository;

    public function __construct(ClientRepository $repository)
    {
        $this->repository = $repository;;
    }

    public function saveClient(User $user, Client $model, ClientForm $form): void
    {
    $model->setClient_birthdate($form->getClient_birthdate());

Answer 1

Things to look out for:

1. Ensure _form 'id' and 'name' values eg. client_birthdate correspond to Entity @column and Database tables fields. ie Use field names consistently through Entity, Annotations. The ClientForm's getter method will receive data from the __form which is a string or null. The getter will convert this to a DATETIME or null so that CYCLE ORM (Spiral Framework) can process it.
2. Ensure initialization in Entity/Client.php instantiation area ie. BEFORE construct and IN construct.

Tips

1. Annotations above function are read by Cycle's annotations.
2. use \DateTime; before Annotations. Don't forget backslash to indicate DateTime is a php class not in current Namespace.
3. mySql type DATE in database and 'date' included in annotation below. ie. * @Column(type="date", nullable=true) otherwise Cycle will not be able to read it.
4. I have elected to use a simple untyped, nullable string.

.../Entity/Client.php

   public function getClient_birthdate() : ?\DateTimeImmutable  

and

   public function setClient_birthdate(?\DateTime $client_birthdate): void

...src/Invoice/Entity/Client.php...

     /**
     * @Column(type="date", nullable=true)
     */
    private $client_birthdate = '';   

1. The value accepted from coalface __form uses a string so initialize ClientForm.php's private ?string $client_birthdate = null with a string not a DateTime function.
2. Question mark before ?\DateTime allows for null value. Use consistently in function declaration as well as seen below.

...src/Invoice/Client/ClientForm.php

    public function getClient_birthdate(): ?\DateTime
    {
        if (isset($this->client_birthdate) && !empty($this->client_birthdate)){
            return new DateTime($this->client_birthdate);            
        }
        if (empty($this->client_birthdate)){
            return $this->client_birthdate = null;
        } 
    }

The above code can be reduced to:

 public function getClient_birthdate() : ?\DateTime
    {
       // convert the input string on the form received by means of '$this->client_birthdate'
       // back into DateTime so that Cycle can deal with it and
       // save it in 'date' format in mysql behind the scenes
       return new DateTime($this->client_birthdate);
    }

Answer 2

Update 21 September 2022

Attributes are preferred now to annotations so above code has changed.

Essentially, to represent a DateTimeImmutable on a form it must be presented with the ->format() command. A suitable style of date must be between the brackets eg. Y-m-d or even d-m-Y. To accomplish this, additional code may be used eg.

__form.php

<div class="mb-3 form-group has-feedback">
        <?php
           $bdate = $datehelper->get_or_set_with_style($body['client_birthdate']);
        ?>
        <label form-label for="client_birthdate"><?= $s->trans('birthdate') .' ('.$datehelper->display().')'; ?></label>
        <div class="input-group">
            <input type="text" name="client_birthdate" id="client_birthdate" placeholder="<?= ' ('.$datehelper->display().')';?>"
                   class="form-control input-sm datepicker" readonly                   
                   value="<?= null!== $bdate ? Html::encode($bdate instanceof \DateTimeImmutable ? $bdate->format($datehelper->style()) : $bdate) : null; ?>" role="presentation" autocomplete="off">
            <span class="input-group-text">
            <i class="fa fa-calendar fa-fw"></i>
        </span>
        </div>        
    </div>  

Include the following datepicker jquery code in your layout file.

<?php
    // https://api.jqueryui.com/datepicker
    $js1 = "$(function () {".
       '$(".form-control.input-sm.datepicker").datepicker({dateFormat:"'.$datehelper->datepicker_dateFormat()
                                                        .'", firstDay:'.$datehelper->datepicker_firstDay()
                                                        .', changeMonth: true'
                                                        .', changeYear: true'
                                                        .', yearRange: "-50:+10"'
                                                        .', clickInput: true'
                                                        .', constrainInput: false'
                                                        .', highlightWeek: true'
                                                        .' });'.
    '});';
    echo Html::script($js1)->type('module');
?>

Here is reference to the styles.

Answer 3

INVOICEPLANE SOLUTION A Database Error Occurred Error Number: 1525 Incorrect DATE value: '0000-00-00' fix error 58 El error se debe al modo sql, que puede ser un modo estricto
solution permanent to Incorrect DATE value: '0000-00-00' change thsis data example > 1970-01-01
invoiceplane/application/modules/invoices/models/Mdl_invoices.php

or temporal solution mysql SET GLOBAL sql_mode = '';

ubuntu 20.04 mysql 8