Custom formatting of PHP exception with collected data

Question

I have regular use cases of PHP \Exception sub classes where I want to collect up data and then bundle it into a final error message. For example:

checking some data has contiguous days

 $missing = new MissingAdjustmentDataException('');        

 $testDate = $period->getPreviousPeriod()->getEnd();

 $z = 0;
 while ($testDate <= $period->getEnd() && $z < 500){
     if (!in_array($testDate, array_column($activationRedemptionAdjustmentDays, 'effective') )){
         $missing->addMissingRedemptionAdjustment($testDate);
     }
     if (!in_array($testDate, array_column($platformAdjustmentDays, 'effective') )){
         $missing->addMissingPlatformAdjustment($testDate);
     }
     $testDate->add(new \DateInterval('P1D'));
     $z++;
 }

Then in my exception, I'm collecting the data in arrays:

 class MissingAdjustmentDataException extends \Exception
 {
     private $missingRedemptionAdjustment = [];

     private $missingPlatformAdjustment = [];

     public function updateMessage()
     {
         $message = 'Missing Adjustment data: ';
         if ($this->missingRedemptionAdjustment){
             $ra = [];
             foreach ($this->missingRedemptionAdjustment as $item){
                 $ra[] = $item->format('Y-m-d');
             }
             $message .= 'RedemptionAdjustment: '.implode(',',$ra);
         }
         if ($this->missingPlatformAdjustment){
             $pl = [];
             foreach ($this->missingRedemptionAdjustment as $item){
                 $pl[] = $item->format('Y-m-d');
             }
             $message .= 'PlatformAdjustment: '.implode(',',$pl);
         }
         $this->message = $message;
     }

     public function inError() : bool
     {
         if ($this->missingRedemptionAdjustment || $this->missingPlatformAdjustment){
             return true;
         }else{
             return false;
         }
     }

     public function addMissingRedemptionAdjustment(\DateTime $dateTime){
         $this->missingRedemptionAdjustment[] = clone $dateTime;
         $this->updateMessage();
     }

     public function addMissingPlatformAdjustment(\DateTime $dateTime){
         $this->missingPlatformAdjustment[] = clone $dateTime;
         $this->updateMessage();
     }
 }

My main problem is that I cannot find a way to do the formatting of the message in a "lazy" way when $missing->getMessage() is called. It seems to have update $this->message inside the Exception every time I add a data point to the exception.

Is there a better way to do this?

Olivier · Accepted Answer · 2022-12-10 09:20:24Z

1

+100

The issue is that you are mixing two different things: the object that keeps track of the errors, and the exception. You should properly seperate them. For example:

class MissingDataCollector
{
    private $missingRedemptionAdjustment = [];
    private $missingPlatformAdjustment = [];

    public function addMissingRedemptionAdjustment(\DateTime $dateTime)
    {
        $this->missingRedemptionAdjustment[] = clone $dateTime;
    }

    public function addMissingPlatformAdjustment(\DateTime $dateTime)
    {
        $this->missingPlatformAdjustment[] = clone $dateTime;
    }

    public function check()
    {
        if ($this->missingRedemptionAdjustment || $this->missingPlatformAdjustment)
            throw new \Exception($this->getMessage());
    }

    private function getMessage()
    {
        $message = 'Missing Adjustment data:';
        if ($this->missingRedemptionAdjustment){
            $ra = [];
            foreach ($this->missingRedemptionAdjustment as $item){
                $ra[] = $item->format('Y-m-d');
            }
            $message .= ' RedemptionAdjustment: '.implode(',', $ra);
        }
        if ($this->missingPlatformAdjustment){
            $pl = [];
            foreach ($this->missingRedemptionAdjustment as $item){
                 $pl[] = $item->format('Y-m-d');
            }
            $message .= ' PlatformAdjustment: '.implode(',', $pl);
        }
        return $message;
    }
}

And the way to use it:

$missing = new MissingDataCollector();

// Some processing that may call addMissingRedemptionAdjustment() or addMissingPlatformAdjustment()
...

// Throw an exception in case of missing data
$missing->check();

answered Dec 10, 2022 at 9:20

Olivier

19.7k1 gold badge12 silver badges34 bronze badges

Sign up to request clarification or add additional context in comments.

5 Comments

jdog Over a year ago

this may go into codereview.stackexchange.com territory, but should an Exception be thrown at the first sign of trouble or collect up all issues so they can be resolved more efficiently. Am I wrong to expect this from a programming language

Olivier Over a year ago

@jdog To me, exceptions should be created and thrown immediately. They are not meant for anything else. Your code always creates an exception, even when there are no errors, which is weird.

jdog Over a year ago

it doesn't always create an exception, if the condition in the loop are not met, it just runs through. But clearly there can be different expectations by people.

Olivier Over a year ago

@jdog The first line of your code creates $missing, which is an exception.

jdog Over a year ago

I see how you mean that now.

Pols12 · Accepted Answer · 2022-11-28 00:05:06Z

-1

You can execute updateMessage() while catching the exception

catch(MissingAdjustmentDataException $e) {
    $e->updateMessage();
    echo $e->getMessage();
}

You will find some advices and hacks in How to change exception message of Exception object?

answered Nov 28, 2022 at 0:05

Pols12

1223 bronze badges

2 Comments

jdog Over a year ago

I came up with this method, but it breaks encapsulation of the exception which I find even worse than repeatedly updating the message

jdog Over a year ago

Using __toString also breaks encapsulation, as I then need to remember to echo($e), instead of being able to use $e->getMessage() in some way

Collectives™ on Stack Overflow

Custom formatting of PHP exception with collected data

2 Answers 2

5 Comments

2 Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

2 Answers 2

5 Comments

2 Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related