Skip to content

Latest commit

 

History

History
113 lines (84 loc) · 1.92 KB

README.md

File metadata and controls

113 lines (84 loc) · 1.92 KB
Raw

deadline

締め日を取得する

Install

利用するプロジェクトの composer.json に以下を追加する。

"repositories": {
    "deadline": {
        "type": "vcs",
        "url": "https://github.com/shimoning/deadline.git"
    }
},

その後以下でインストールする。

composer require shimoning/deadline

Usage

Deadline

締め日を取得する

$deadline = new Deadline(2020, 4, 20);

// TODO: write

// get deadline
$deadline->get();   //

// set hour
$deadline->get(12);

// set hour and minute
$deadline->get(12, 30);

// set hour, minute and second
$deadline->get(11, 59, 59);

// check exceeded or not
$deadline->isExceeded();

Options

Holidays

祝日を設定する

$deadline->setHolidays(['2021-09-20', Carbon::parse('2021-09-23')]);

祝日か判定する

$deadline->isHoliday(); // true or false

Weekend

週末を設定する

$deadline->setWeekendDays([Carbon::SUNDAY])

週末か判定する。

$deadline->isWeekend(); // true or false

If not weekday

平日じゃない場合の振る舞い。

設定する

$deadline->setBehaviorIfNotWeekday(1);  // 次の日にずらす
$deadline->setBehaviorIfNotWeekday(-1);  // 前の日にずらす

例) 対象日が 2021-09-05 (日) かつ、週末設定が土日の場合。

  • 1 を設定すると、 2021-09-06 (月) になる。
  • -1 を設定すると、 2021-09-03 (金) になる。

基準日の設定

// 1日
$deadline->setBaseDay(1);

// 末日
$deadline->setBaseDay('t');

Specific utilities

ThisMonthLastBusinessDay

今月の最終営業日を取得する

NextMonthFirstBusinessDay

翌月の最初の営業日を取得する

CLI

コマンドラインでライブラリを試す

./psysh.php

Unit Test

ユニットテストを実行する

composer test