https://github.com/smhg/date-frequency-php

PHP temporal frequency library
https://github.com/smhg/date-frequency-php

Last synced: about 2 months ago
JSON representation

PHP temporal frequency library

• Host: GitHub
• URL: https://github.com/smhg/date-frequency-php
• Owner: smhg
• Created: 2014-02-07T08:47:26.000Z (almost 11 years ago)
• Default Branch: master
• Last Pushed: 2024-03-11T12:50:24.000Z (10 months ago)
• Last Synced: 2024-10-31T12:45:11.160Z (2 months ago)
• Language: PHP
• Size: 61.5 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
date-frequency-php [![CI](https://github.com/smhg/date-frequency-php/workflows/CI/badge.svg)](https://github.com/smhg/date-frequency-php/actions)

==================

> Temporal frequency library

PHP clone of [JavaScript version](https://github.com/smhg/date-frequency-js).

## Installation

```bash

$ composer require smhg/date-frequency

```

## Methods

### Frequency

```php

use Frequency\Frequency;

$frequency = new Frequency();

$frequency->on('day', 3, 'week')

	->on('hour', 10)

	->on('minute', 0)

	->on('seconds', 0); // every Wednesday at 10:00:00

```

#### Frequency([string rules])

#### Frequency([array rules])

Pass rules as a string (see `__toString`) or an array to the constructor instead of setting them one-by-one with `on()`.

Example above as a string: `$frequency = new Frequency('F3D/WT10H0M0S');`

#### on(string unit, int|string value, [string scope])

Add a rule (fixed integer value or a string representing the name of a filter function) to the frequency for a unit, optionally linked to a scope (if not provided, a default scope is derived).

Filter functions need to be available in the static `Frequency::$fn` array when used.

Example filter: `$frequency = new Frequency('F(leap)Y1M1DT0H0M0S');` (Jan 1st, at midnight, of leap years)

See tests for more examples.

#### next(DateTime start = new DateTime())

Get the next occurence of the frequency on or after a date.

#### between(DateTime start, DateTime end)

Get all occurences of the frequency between 2 dates.

#### __toString()

Convert frequency to a string value.