peter279k / carbon-extended

The extended format for Carbon class instance

carbon-extended

Introduction

• It can use some extended format on Carbon::format method

Installation

Using the composer to install this package

composer require lee/carbon-extended:^1.0

Usage

• The CarbonExtended class extends Carbon and it can use createFromFormat to create the Carbon class instance and do format with extended foramts.

use Lee\CarbonExtended;

$date = '2013-03-17';
$customizedFormat = 'QTR.';

$carbonExtended = CarbonExtended::createFromFormat('Y-m-d', $date);
$result = $carbonExtended->extendedFormat($customizedFormat); // 1

Available extended date formats

• The customized format name is refer on SAS date format
• Here are available extended formats: (it will have more customized formats...)

customized format name	references
QTR.	QTR. reference
QTRR.	QTRR. reference
JULDAY3.	JULDAY3. reference
SAS_DATE_VALUE	SAS_DATE_VALUE reference
JULIAN5.	JULIAN5. reference
JULIAN7.	JULIAN7. reference
PDJULG4.	PDJULG4. reference
TIMEAMPM.	TIMEAMPM. reference

References

SAS date documentation

carbon-extended's Issues

Add YYQR and YYQRx format supports

The detailed descriptions are as follows:

• YYQR
• YYQRx

Add YYMM format support

The detailed YYMM. format description is available here.

Add TIMEAMPM. format support

Reference

• TIMEAMPM. format description
• TIMEAMPM. format description

Add customized TIME. format

References

• TIME. format
• TIME. format description

Add QTRR. format support

Reference

• QTRR. format
• Quarter explanation

Add YYQx format supports

The detailed description are available here.

Add YYQ. format supports

The detailed description is available here.

Provide carbon-extended as trait/mixin

Hello,

Classes that extend Carbon like jensseggers/date or this one have one major inconvenient. You have to choose one or the other. You can't benefit of both methods of 2 or more classes that extend a first one (Carbon in this case).

A more extensible approach is to use traits and Carbon provides out of the box the mixin() method which can take as much traits as you want as long as they don't use the same methods names:

trait BeerDayCarbonTrait
{
    public function nextBeerDay()
    {
        return $this->modify('next Wednesday');
    }

    public function previousBeerDay()
    {
        return $this->modify('previous Wednesday');
    }
}

Carbon::mixin(BeerDayCarbonTrait::class);

$date = Carbon::parse('First saturday of December 2018');

echo $date->previousBeerDay();                                                 // 2018-11-28 00:00:00
echo "\n";
echo $date->nextBeerDay();                                                     // 2018-12-05 00:00:00

Try on try-carbon.herokuapp.com

And this is a backward-compatible change as you can do:

<?php

namespace Lee;

use Carbon\Carbon;

// Optionally you can deprecate it for next version
@trigger_error('CarbonExtended class is deprecated and will be removed in carbon-extended 2, use Carbon::mixin(CarbonExtendedTrait::class) instead.', E_USER_DEPRECATED);

class CarbonExtended extends Carbon
{
  use CarbonExtendedTrait;
}

And Carbon documentation has a macro section where such mixins/macros can be promoted if you want by submitting a pull-request on gh-pages branch on https://github.com/briannesbitt/Carbon

Add YYQZ format support

The detailed description is here.