_colCell.php

<?php
declare(strict_types=1);

/*
 * This file is part of the QuidPHP package <https://quidphp.com>
 * Author: Pierre-Philippe Emond <emondpph@gmail.com>
 * License: https://github.com/quidphp/orm/blob/master/LICENSE
 */

namespace Quid\Orm;
use Quid\Main;

// _colCell
// trait that provides common methods for Col and Cell objects
trait _colCell
{
    // dynamique
    protected array $callback = []; // permet d'entreposer un ou plusieurs committed callback, lors d'une opération réussi
    protected ?\Exception $exception = null; // permet d'entreposer une exception, lors d'une opération raté


    // exception
    // retourne le message de l'exception
    // si lang est true, retourne le texte indiquant que le champ est requis
    final public function exception(bool $lang=false)
    {
        $return = true;
        $exception = $this->getException();

        if(is_array($exception) && array_key_exists('message',$exception) && array_key_exists('messageArgs',$exception))
        {
            $return = $exception['message'];

            if($lang === true)
            {
                $lang = $this->db()->lang();
                $message = $exception['messageArgs'];

                if(is_array($message))
                {
                    $safe = $lang->safe(...array_values($message));

                    if(is_string($safe))
                    $return = $safe;
                }
            }
        }

        return $return;
    }


    // ruleException
    // retourne l'exception si présente
    final public function ruleException(bool $lang=false):?string
    {
        $return = $this->exception($lang);

        if($return === true)
        $return = null;

        return $return;
    }


    // hasCommittedCallback
    // retourne vrai si l'objet contient un commited callback
    final public function hasCommittedCallback(string $key):bool
    {
        return !empty($this->getCommittedCallback($key));
    }


    // getCommittedCallback
    // retourne le commited callback
    final public function getCommittedCallback(string $key):?\Closure
    {
        return $this->callback[$key] ?? null;
    }


    // setCommittedCallback
    // ajoute un commited callback
    final public function setCommittedCallback(string $key,\Closure $closure):void
    {
        $this->callback[$key] = $closure;
    }


    // clearCommittedCallback
    // vide le callback à appeler après un commit, insert ou update
    final public function clearCommittedCallback():void
    {
        $this->callback = [];
    }


    // hasException
    // retourne vrai si l'objet contient une exception
    final public function hasException():bool
    {
        return !empty($this->exception);
    }


    // getException
    // retourne le message d'exception lié à l'objet
    final public function getException():?array
    {
        return $this->exception;
    }


    // setException
    // entrepose le message d'exception dans l'objet
    final public function setException(Main\CatchableException $exception):void
    {
        $message['message'] = $exception->getMessage();
        $message['messageArgs']  = $exception->messageArgs();
        $this->exception = $message;
    }


    // clearException
    // vide l'exception lié à une insertion raté
    final public function clearException():void
    {
        $this->exception = null;
    }
}
?>