Verta

https://github.com/hekmatinasser/verta
Admin
A PHP package for converting between Jalali (Persian) and Gregorian calendars, offering date and...
Tokens:38,835
Snippets:226
Trust Score:7.7
License:MIT
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Basic verta() usage examples

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/helpers.md

Examples of calling verta() with no arguments to get the current Jalali datetime, and with a Gregorian string to convert to Jalali.

```php
// Now, as Jalali
echo verta(); // 1401-05-24 00:00:00

// Gregorian → Jalali
echo verta('2022-08-15'); // 1401-05-24 00:00:00
```

--------------------------------

### boot()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Registers all validation rules via loadValidators() and installs the Carbon macro 'toJalali'.

```APIDOC
## boot()

### Description
Registers all validation rules via `loadValidators()` and installs the Carbon macro `'toJalali'`. The macro is installed on `Illuminate\Support\Carbon`, allowing every Carbon instance to convert to Verta.

### Method
boot

### Signature
`public function boot()`

### Parameters
#### Macro Parameters
- **timezone** (null | string IANA name) - Optional - Timezone for the resulting Verta.

### Request Example
```php
Carbon::macro('toJalali', function ($timezone = null) {
    return new Verta($this, $timezone);
});
```

### Response
Installs the `toJalali` macro on Carbon. Example usage: `echo now()->toJalali(); // 1401-05-24 00:00:00`
```

--------------------------------

### toCarbon() usage example with echo

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Shows a simple usage of toCarbon() with a comment indicating the output.

```php
echo verta()->toCarbon(); // 2022-08-15 00:00:00 (README)
```

--------------------------------

### Get week boundary with startWeek()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Gets the start of a week boundary for a Verta instance. The example calls 'startWeek' with an argument of 3.

```php
echo verta()->startWeek(3); 
```

--------------------------------

### toCarbon() round-trip example

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Demonstrates converting a Jalali datetime to Carbon and back using the registered macro.

```php
$carbon = verta('1401-05-24 14:12:32')->toCarbon();
echo $carbon; // 2022-08-15 14:12:32

// round-trip back via the Carbon macro registered by VertaServiceProvider::boot()
echo $carbon->toJalali()->formatJalaliDatetime(); // 1401/05/24 14:12:32
```

--------------------------------

### boot() Carbon macro

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Installs a toJalali macro on Illuminate\Support\Carbon. Inside the closure, $this is the receiving Carbon instance, so every Carbon gains a toJalali() method that converts it to Verta.

```php
Carbon::macro('toJalali', function ($timezone = null) {
    return new Verta($this, $timezone);
});
```

--------------------------------

### Comparison validator usage examples

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Usage examples for the comparison validators. Shows that validateDateEqual returns true when the candidate equals the reference and false otherwise, and that validateDateAfter can compare across formats by supplying a format in parameters[1].

```php
// jdate_equal — '1397/01/01' equals the reference
$v->validateDateEqual(null, '1397/01/01', ['1397/01/01']);      // true
$v->validateDateEqual(null, '1397/01/01', ['1397/01/02']);      // false

// jdate_after — works across formats via parameters[1]
$v->validateDateAfter(null, '1398/01/02', ['1398-01-01', 'Y-m-d']); // true
```

--------------------------------

### Using toJalali macro

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Example usage of the toJalali macro on a Carbon instance, converting it to a Verta instance. The comment shows the expected output format.

```php
echo now()->toJalali(); // 1401-05-24 00:00:00  (README "Carbon to Jalali")
```

--------------------------------

### Get human-readable difference with formatDifference()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Calculates the difference between a Verta instance and the current date in a human-readable format. The example creates a Verta instance 13 months ago and outputs '1 سال قبل' (1 year ago).

```php
echo verta('-13 month')->formatDifference(); // 1 سال قبل
```

--------------------------------

### Boundary methods for Verta (startMinute, endYear, etc.)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Fluent boundary methods. `start*` zero lower units; `end*` push to last representable unit (day → `23:59:59`, month/year → last day of Jalali month, e.g. `1398-12-29 23:59:59`). README shows `verta()->startWeek(3)`, indicating `startWeek()` accepts an optional week-start offset.

```php
startMinute() endMinute() startHour()  endHour()
startDay()    endDay()    startWeek()  endWeek()
startMonth()  endMonth()  startQuarter() endQuarter()
startYear()   endYear()
```

--------------------------------

### replaceDateOrDatetime usage example

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Shows that replaceDateOrDatetime returns the input message without modification.

```php
$v->replaceDateOrDatetime('The :attribute is not a valid Jalali date.', null, null, null);
// 'The :attribute is not a valid Jalali date.'
```

--------------------------------

### Format a Verta instance with format() and formatWord()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Formats a Verta instance using the 'format' method with a custom format string, and the 'formatWord' method for a word-based format. The first example outputs '1401.05.24' and the second outputs a Persian word format.

```php
echo verta()->format('Y.m.d'); // 1401.05.24
echo verta()->formatWord('l dS F'); // دوشنبه بیست و چهارم مرداد
```

--------------------------------

### validateDate usage examples

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Usage examples for validateDate. The first call with format 'Y/m/d' returns true, the second with empty parameters uses the default format and returns true, the third with format 'Y' returns false, and the fourth with a non-string value returns false.

```php
$v = new JalaliValidator();
$v->validateDate(null, '1398/01/01', ['Y/m/d']);        // true
$v->validateDate(null, '1398/01/01', []);               // true (default Y/m/d)
$v->validateDate(null, '1398', ['Y']);                  // false
$v->validateDate(null, ['1398/01/01'], []);             // false (not a string)
```

--------------------------------

### Install Verta with Composer

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Installs the Verta package via Composer. The package version depends on the Laravel version, with Laravel 8.0 using 8.0, 9.0 using 8.2, 10.0 using 8.3, 11.0 using 8.4, and 12.0 using 8.5.

```shell
composer require hekmatinasser/verta
```

--------------------------------

### Set locale with setLocale()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Sets the locale for formatting Verta instances. The example sets the locale to 'ar' (Arabic).

```php
Verta::setLocale('ar');
```

--------------------------------

### replaceDateTimeAfterOrBeforeOrEqual usage example

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Demonstrates replacing :date with a provided datetime in English locale. The output retains Western digits.

```php
Verta::setLocale('en');
$v->replaceDateTimeAfterOrBeforeOrEqual(
    'Must be on or after :date', null, null, ['1398/01/01 20:00:00']
); // 'Must be on or after 1398/01/01 20:00:00'
```

--------------------------------

### validateDateTime usage examples

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Usage examples for validateDateTime. The first call with empty parameters uses the default format and returns true. The second call with explicit format 'Y/m/d H:i:s' also returns true. The third call with a date-only string and the datetime format returns false.

```php
$v->validateDateTime(null, '1398/01/01 20:00:00', []);               // true
$v->validateDateTime(null, '1398/01/01 20:00:00', ['Y/m/d H:i:s']);  // true
$v->validateDateTime(null, '1398/01/01', ['Y/m/d H:i:s']);           // false
```

--------------------------------

### Compare dates with gte()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Compares a Verta instance with another date using the 'gte' (greater than or equal) method. The example creates a Verta instance 2 days in the future and compares it to '2022-08-15'.

```php
echo verta('+2 day')->gte('2022-08-15');
```

--------------------------------

### Fluent setters for Verta (year, timestamp, timezone, setDateTime)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Fluent setters that each take a value and return the instance. `setDateTime` uses Jalali components; `setTimeString` is the README's fluent setter example.

```php
$v->year(1395)->month(8)->day(19)->hour(22)->minute(23)->second(56);
$v->timestamp(1546350635);
$v->timezone('Asia/Tehran');
$v->setDateTime(1397, 10, 11, 10, 20, 11);  // Jalali components
$v->setDateJalali(1397, 10, 11);
$v->setTime(10, 20, 11);
$v->setTimeString('10:20:11');               // README "fluent setter" example
```

--------------------------------

### Calculate month difference with diffMonths()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Calculates the difference in months between a Verta instance and another date. The example creates a Verta instance 13 days in the future and calculates the month difference with '2022-08-15'.

```php
echo verta('+13 day')->diffMonths('2022-08-15'); 
```

--------------------------------

### Set the year on a Verta instance

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Sets the year property of a Verta instance. The example creates a Verta instance, sets its 'year' property to 1395, and echoes the result.

```php
$v = verta(); // 1396-03-14 14:18:23
echo $v->year = 1395;
```

--------------------------------

### Set time with fluent setter setTimeString()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Sets the time part of a Verta instance using a fluent setter. The example creates a Verta instance and sets its time to '12:25:45'.

```php
$v = verta(); // 1396-03-14 14:18:23
echo $v->setTimeString('12:25:45');
```

--------------------------------

### Accessor/mutator properties (get and set)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Read and write Verta instance properties such as year, month, day, hour, minute, second, micro, dayOfWeek, dayOfYear, weekOfYear, daysInMonth, quarter, timestamp, and timezone.

```APIDOC
## Accessor/mutator properties (get and set)

### Description
Read and write individual date/time components of a Verta instance.

### Properties
- **year** (int) - Read/write - Jalali year
- **month** (int) - Read/write - Jalali month (1-12)
- **day** (int) - Read/write - Day of month
- **hour** (int) - Read/write - Hour (0-23)
- **minute** (int) - Read/write - Minute (0-59)
- **second** (int) - Read/write - Second (0-59)
- **micro** (int) - Read/write - Microsecond
- **dayOfWeek** (int) - Read - Day of week (0=Saturday ... 6=Friday)
- **dayOfYear** (int) - Read - Day of year
- **weekOfYear** (int) - Read - Week of year
- **daysInMonth** (int) - Read - Number of days in the current month
- **quarter** (int) - Read - Quarter number (1-4)
- **timestamp** (int) - Read/write - Unix timestamp
- **timezone** (string) - Read/write - Timezone identifier (e.g. 'Asia/Tehran', 'UTC')

### Example Usage (from README)

```php
$v = new Verta('2019-01-01 17:20:35', 'Asia/Tehran');
$v->year;         // 1397
$v->month;        // 10
$v->day;          // 11
$v->hour;         // 17
$v->minute;       // 20
$v->second;       // 35
$v->micro;        // 0
$v->dayOfWeek;    // 3
$v->dayOfYear;    // 287
$v->weekOfYear;   // 42
$v->daysInMonth;  // 30
$v->quarter;      // 4
$v->timestamp;    // 1546350635
$v->timezone;     // 'Asia/Tehran'
```

All of the above are writable (e.g. `$v->year = 1395;`, `$v->timestamp = 1546382684;`, `$v->timezone = 'UTC';`).

### Fluent setters (each takes a value, returns the instance)

```php
$v->year(1395)->month(8)->day(19)->hour(22)->minute(23)->second(56);
$v->timestamp(1546350635);
$v->timezone('Asia/Tehran');
$v->setDateTime(1397, 10, 11, 10, 20, 11);  // Jalali components
$v->setDateJalali(1397, 10, 11);
$v->setTime(10, 20, 11);
$v->setTimeString('10:20:11');               // README 
```

--------------------------------

### Relative moments and timezone usage

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/helpers.md

Shows using relative moment strings like '-13 month' and '+2 day' with verta(), and passing an explicit timezone to get a Verta instance with that timezone.

```php
// Relative moment + conversion back to Carbon
echo verta('-13 month')->formatDifference();  // 1 سال قبل (README)
echo verta('+2 day')->gte('2022-08-15');      // comparison chaining (README)

// explicit timezone
$v = verta('2022-08-15 14:30:00', 'Asia/Tehran');
echo $v->timezone; // Asia/Tehran
```

--------------------------------

### Configure Laravel validation with Verta Jalali rules

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/configuration.md

Example Laravel validation rule configuration using Verta's Jalali date rules. Shows presence rules (jdate, jdatetime), comparison rules with reference and format parameters (jdatetime_after_equal), and multi-format rule (jdate_multi_format) with multiple formats.

```php
$request->validate([
    'birthday'    => ['required', 'jdate', 'jdate_before_equal'],
    'starts_at'   => ['jdatetime', 'jdatetime_after_equal' => ['1398/01/01 00:00:00', 'Y/m/d H:i:s']],
    'custom'      => ['jdate_multi_format' => ['Y/m/d', 'Y-m-d', 'Y.m.d']],
]);
```

--------------------------------

### Get the year from a Verta instance

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Accesses the year property of a Verta instance. The example creates a Verta instance and echoes its 'year' property, which returns the Jalali year.

```php
$v = verta(); // 1396-03-14 14:18:23
echo $v->year; // 1396
```

--------------------------------

### Instantiation Methods

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Static methods to create Verta instances from various inputs.

```APIDOC
## Instantiation Methods

### Description
Static methods to create Verta instances from various inputs.

### Methods

#### now()
- **Signature**: `Verta::now()`
- **Description**: Returns the current moment.

#### today()
- **Signature**: `Verta::today()`
- **Description**: Returns today at 00:00:00.

#### yesterday()
- **Signature**: `Verta::yesterday()`
- **Description**: Returns yesterday at 00:00:00.

#### tomorrow()
- **Signature**: `Verta::tomorrow()`
- **Description**: Returns tomorrow at 00:00:00.

#### instance($datetime = null, $timezone = null)
- **Signature**: `Verta::instance($datetime = null, $timezone = null)`
- **Description**: Same as constructor.

#### parse($datetime, $timezone = null)
- **Signature**: `Verta::parse($datetime, $timezone = null)`
- **Description**: Parses a Jalali string (e.g., '1397 دی 11 10:20:11').

#### parseFormat($format, $value)
- **Signature**: `Verta::parseFormat($format, $value)`
- **Description**: Parses using an explicit format (e.g., 'Y-m-d H:i:s', '1397-10-11 10:20:11').

#### create($year, $month, $day, $hour, $minute, $second)
- **Signature**: `Verta::create($year, $month, $day, $hour, $minute, $second)`
- **Description**: Creates from Gregorian components.

#### createDate($year, $month, $day)
- **Signature**: `Verta::createDate($year, $month, $day)`
- **Description**: Creates from Gregorian date components, time from now.

#### createTime($hour, $minute, $second)
- **Signature**: `Verta::createTime($hour, $minute, $second)`
- **Description**: Creates from Gregorian time components, date from now.

#### createTimestamp($timestamp)
- **Signature**: `Verta::createTimestamp($timestamp)`
- **Description**: Creates from Unix seconds.

#### createGregorianDate($year, $month, $day)
- **Signature**: `Verta::createGregorianDate($year, $month, $day)`
- **Description**: Creates from Gregorian date components.

#### createGregorianTime($hour, $minute, $second)
- **Signature**: `Verta::createGregorianTime($hour, $minute, $second)`
- **Description**: Creates from Gregorian time components.

#### createJalali($year, $month, $day, $hour, $minute, $second)
- **Signature**: `Verta::createJalali($year, $month, $day, $hour, $minute, $second)`
- **Description**: Creates from Jalali components.

#### createJalaliDate($year, $month, $day)
- **Signature**: `Verta::createJalaliDate($year, $month, $day)`
- **Description**: Creates from Jalali date components.

#### createJalaliTime($hour, $minute, $second)
- **Signature**: `Verta::createJalaliTime($hour, $minute, $second)`
- **Description**: Creates from Jalali time components.

### Semantics
- `create`/`createGregorian*` treat components as Gregorian (e.g., `2019,1,1,...` → `1397-10-11 ...`).
- `createJalali*` treat components as Jalali.
- `createDate`/`createTime` fill the missing half from "now".
- `Verta::parse` accepts month-name strings such as `'1397 دی 11 10:20:11'`.
```

--------------------------------

### Instantiation static methods

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Lists the static instantiation methods inherited from Jalali, with comments showing usage.

```php
Verta::now();                                        // current moment
Verta::today();                                      // today 00:00:00
Verta::yesterday();                                  // yesterday 00:00:00
Verta::tomorrow();                                   // tomorrow 00:00:00
Verta::instance($datetime = null, $timezone = null); // same as constructor
Verta::parse($datetime, $timezone = null);           // parse Jalali string ('1397 دی 11 10:20:11' supported)
Verta::parseFormat($format, $value);                 // parse using explicit format ('Y-m-d H:i:s', '1397-10-11 10:20:11')
Verta::create($year, $month, $day, $hour, $minute, $second);        // Gregorian components
Verta::createDate($year, $month, $day);
Verta::createTime($hour, $minute, $second);
Verta::createTimestamp($timestamp);                  // unix seconds
Verta::createGregorianDate($year, $month, $day);
Verta::createGregorianTime($hour, $minute, $second);
Verta::createJalali($year, $month, $day, $hour, $minute, $second);  // Jalali components
Verta::createJalaliDate($year, $month, $day);
Verta::createJalaliTime($hour, $minute, $second);
```

--------------------------------

### validateDateMultiFormat usage examples

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Usage examples for validateDateMultiFormat. The first call with formats ['Y/m/d', 'Y-m-d'] returns true because the value matches the second format. The second call with only 'Y-m-d' returns false because the value uses slashes.

```php
$v->validateDateMultiFormat(null, '1398-01-01', ['Y/m/d', 'Y-m-d']); // true
$v->validateDateMultiFormat(null, '1398/01/01', ['Y-m-d']);          // false
```

--------------------------------

### Static configuration methods

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Shows static configuration methods for format, locale, and validation.

```php
Verta::setFormat('Y-m-d-H-i-s');   // global string cast/default format
Verta::resetFormat();
Verta::setLocale('fa');            // 'fa' | 'en' | 'ar' (README demonstrates 'ar')
Verta::getLocale();                // current locale
Verta::getMessages($locale = null); // messages array; ['numbers'] used for digit localization
Verta::isLeapYear(1394);           // false for 1394 (README)
Verta::isValidDate($y, $m, $d);    // false for -1365/12/15, 1365/13/15, 1365/12/32
Verta::isValidTime($h, $i, $s);    // false for 25/12/15, 14/65/15, 14/12/66
```

--------------------------------

### Verta::datetime()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/README.md

Instance method inherited from Hekmatinasser\Jalali\Jalali to get the underlying datetime object.

```APIDOC
## Verta::datetime()

### Description
Instance method inherited from Hekmatinasser\Jalali\Jalali to get the underlying datetime object.

### Method
Instance

### Signature
`datetime()`

### Returns
- **DateTime|Illuminate\Support\Carbon** - The underlying datetime object.

### Notes
Inherited from the parent class.
```

--------------------------------

### Static Configuration Methods

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Static methods to configure global format, locale, and validation.

```APIDOC
## Static Configuration Methods

### Description
Static methods to configure global format, locale, and validation.

### Methods

#### setFormat($format)
- **Signature**: `Verta::setFormat('Y-m-d-H-i-s')`
- **Description**: Sets the global string cast/default format.

#### resetFormat()
- **Signature**: `Verta::resetFormat()`
- **Description**: Resets the global format to default.

#### setLocale($locale)
- **Signature**: `Verta::setLocale('fa')`
- **Description**: Sets the locale ('fa' | 'en' | 'ar').

#### getLocale()
- **Signature**: `Verta::getLocale()`
- **Description**: Returns the current locale.

#### getMessages($locale = null)
- **Signature**: `Verta::getMessages($locale = null)`
- **Description**: Returns the messages array; ['numbers'] used for digit localization.

#### isLeapYear($year)
- **Signature**: `Verta::isLeapYear(1394)`
- **Description**: Returns whether the given Jalali year is a leap year.

#### isValidDate($y, $m, $d)
- **Signature**: `Verta::isValidDate($y, $m, $d)`
- **Description**: Returns whether the given Jalali date is valid.

#### isValidTime($h, $i, $s)
- **Signature**: `Verta::isValidTime($h, $i, $s)`
- **Description**: Returns whether the given time is valid.
```

--------------------------------

### Facade resolution diagram

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/facade.md

ASCII diagram illustrating how the facade proxies to the container binding 'verta' and then to a new Verta instance.

```text
Hekmatinasser\Verta\Facades\Verta   (static proxy — this class)
        │ getFacadeAccessor() → 'verta'
        ▼
container binding 'verta'           (registered in VertaServiceProvider::register())
        ▼
new Verta()                         (Hekmatinasser\Verta\Verta, "now")
```

--------------------------------

### provides()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Returns the service names this provider supplies, specifically ['verta'].

```APIDOC
## provides()

### Description
Returns the service names this provider supplies. The returned array contains `'verta'`.

### Method
provides

### Signature
`public function provides()`

### Response
Returns `['verta']`.
```

--------------------------------

### register()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Binds the container key 'verta' to a closure returning a new Verta() instance with the current datetime.

```APIDOC
## register()

### Description
Binds the container key `'verta'` to a closure returning `new Verta()` (now). Resolving `'verta'` from the container (or via the `Facades\Verta` facade) yields a `new Verta()` instance with the current datetime.

### Method
register

### Signature
`public function register()`

### Request Example
```php
$this->app->bind('verta', function ($app) {
    return new Verta();
});
```

### Response
Returns a `Verta` instance representing the current datetime.
```

--------------------------------

### Constructor signature (inherited from Jalali)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Shows the effective constructor signature for Verta, inherited from Jalali. Accepts optional datetime and timezone parameters.

```php
new Verta($datetime = null, $timezone = null)
```

--------------------------------

### Laravel Validation Rules Usage

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Example of using Jalali validation rules in a Laravel Form Request or controller validation.

```APIDOC
## [POST] /validate

### Description
Demonstrates how to use Jalali validation rules in a Laravel validation request.

### Method
POST

### Endpoint
/validate

### Parameters
#### Request Body
- **birthday** (string) - Required - The Jalali date to validate (format: Y/m/d).
- **birthday_multi** (string) - Optional - The Jalali date to validate against multiple formats.
- **starts_at** (string) - Optional - The Jalali datetime to validate.
- **ends_at** (string) - Optional - The Jalali datetime to validate.

### Request Example
{
  "birthday": "1370/01/01",
  "birthday_multi": "1370/01/01",
  "starts_at": "1398/01/01 00:00:00",
  "ends_at": "1398/01/01 00:00:00"
}

### Response
#### Success Response (200)
- **message** (string) - Validation passed.

#### Response Example
{
  "message": "Validation passed."
}
```

--------------------------------

### Using the Verta facade in application code

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/facade.md

Shows how to use the facade with an alias and call a static method like now(). The comment notes that Laravel resolves this to the container-bound Verta binding.

```php
use Hekmatinasser\Verta\Facades\Verta as VertaFacade;

// Laravel resolves this to the container-bound Verta binding ('verta')
$result = VertaFacade::now();        // resolves the bound Verta instance context
```

--------------------------------

### Validate leap year with isLeapYear()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Checks if a given Jalali year is a leap year. The example checks the year 1394 and outputs 'false'.

```php
echo Verta::isLeapYear(1394); // false
```

--------------------------------

### Comparison predicates for Verta (eq, gt, between, closest, etc.)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Comparison predicates. All targets accept `Jalali`/`Verta` instances. `between($a, $b)` is inclusive; `between($a, $b, false)` excludes boundaries.

```php
$v->eq($other)      $v->ne($other)          $v->notEqualTo($other)
$v->gt($other)      $v->gte($other)         $v->greaterThanOrEqualTo($other)
$v->lt($other)      $v->lte($other)         $v->lessThanOrEqualTo($other)
$v->between($a, $b, $inclusive = true)      // third arg false → exclusive bounds
$v->closest($a, $b) // returns nearer of two
$v->farthest($a, $b)
$v->min($other)     $v->max($other)
```

--------------------------------

### Laravel validation rule for Jalali date

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Shows a Laravel validation rule for a date field. The example validates the 'birthday' field as required and uses the 'jdate_before_equal' rule.

```php
'birthday' => ['required', 'jdate_before_equal']
```

--------------------------------

### replaceDateAfterOrBeforeOrEqual implementation

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

Shows the logic for resolving the reference date and substituting :date. It uses parameters[0] as the date and parameters[1] as the format (default 'Y/m/d'), and maps digits for non-English locales.

```php
$format = count($parameters) > 1 ? $parameters[1] : 'Y/m/d';
$date = count($parameters) ? $parameters[0] : Verta::instance()->format($format);
if (Verta::getLocale() != 'en') {
    $en = Verta::getMessages('en');
    $to = Verta::getMessages();
    $date = str_replace(array_values($en['numbers']), array_values($to['numbers']), $date);
}

return str_replace(':date', $date, $message);
```

--------------------------------

### JalaliValidator Class Direct Instantiation

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/jalali-validator.md

How to instantiate JalaliValidator directly for unit testing without Laravel's service container.

```APIDOC
## [CLASS] JalaliValidator

### Description
JalaliValidator can be instantiated directly for unit testing. Call its methods with (null, $value, $parameters) to validate Jalali dates and datetimes.

### Method
validate

### Parameters
- **attribute** (mixed) - Always null when called directly.
- **value** (mixed) - The value to validate.
- **parameters** (array) - Additional parameters for the rule (e.g., format, reference value).

### Returns
- **bool** - True if validation passes, false otherwise.

### Example
```php
$validator = new JalaliValidator();
$result = $validator->validate(null, '1370/01/01', []);
```
```

--------------------------------

### Modify a Verta instance with addWeeks()

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Modifies a Verta instance by adding weeks. The example adds 3 weeks to the current date. The '...' indicates that more modification methods are available.

```php
echo verta()->addWeeks(3); 
...
```

--------------------------------

### toCarbon() method signature

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Declares the toCarbon() method that returns a Carbon instance.

```php
public function toCarbon(): Carbon
```

--------------------------------

### Verta State Predicates and Conversion Methods

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

State predicates and conversion/access methods for the Verta Jalali date library, including locale-aware digit localization.

```APIDOC
## isWeekday()

### Description
Determines whether the current Verta instance falls on a weekday (Saturday through Wednesday in the Jalali calendar).

### Method
isWeekday

### Parameters
None

### Response
Returns `true` if the date is a weekday, `false` otherwise.

## isWeekend()

### Description
Determines whether the current Verta instance falls on a weekend (Thursday or Friday in the Jalali calendar).

### Method
isWeekend

### Parameters
None

### Response
Returns `true` if the date is a weekend, `false` otherwise.

## isYesterday()

### Description
Checks if the current Verta instance is yesterday relative to the current date.

### Method
isYesterday

### Parameters
None

### Response
Returns `true` if the date is yesterday, `false` otherwise.

## isToday()

### Description
Checks if the current Verta instance is today.

### Method
isToday

### Parameters
None

### Response
Returns `true` if the date is today, `false` otherwise.

## isTomorrow()

### Description
Checks if the current Verta instance is tomorrow relative to the current date.

### Method
isTomorrow

### Parameters
None

### Response
Returns `true` if the date is tomorrow, `false` otherwise.

## isNextWeek()

### Description
Checks if the current Verta instance falls within the next week.

### Method
isNextWeek

### Parameters
None

### Response
Returns `true` if the date is in the next week, `false` otherwise.

## isLastWeek()

### Description
Checks if the current Verta instance falls within the last week.

### Method
isLastWeek

### Parameters
None

### Response
Returns `true` if the date is in the last week, `false` otherwise.

## isNextMonth()

### Description
Checks if the current Verta instance falls within the next month.

### Method
isNextMonth

### Parameters
None

### Response
Returns `true` if the date is in the next month, `false` otherwise.

## isLastMonth()

### Description
Checks if the current Verta instance falls within the last month.

### Method
isLastMonth

### Parameters
None

### Response
Returns `true` if the date is in the last month, `false` otherwise.

## isNextYear()

### Description
Checks if the current Verta instance falls within the next year.

### Method
isNextYear

### Parameters
None

### Response
Returns `true` if the date is in the next year, `false` otherwise.

## isLastYear()

### Description
Checks if the current Verta instance falls within the last year.

### Method
isLastYear

### Parameters
None

### Response
Returns `true` if the date is in the last year, `false` otherwise.

## isFuture()

### Description
Checks if the current Verta instance is in the future relative to the current date.

### Method
isFuture

### Parameters
None

### Response
Returns `true` if the date is in the future, `false` otherwise.

## isPast()

### Description
Checks if the current Verta instance is in the past relative to the current date.

### Method
isPast

### Parameters
None

### Response
Returns `true` if the date is in the past, `false` otherwise.

## isCurrentYear()

### Description
Checks if the current Verta instance falls within the current year.

### Method
isCurrentYear

### Parameters
None

### Response
Returns `true` if the date is in the current year, `false` otherwise.

## isSameAs($format, $target = null)

### Description
Compares the current Verta instance against a target date using a given format token. If no target is provided, it compares against the current date.

### Method
isSameAs

### Parameters
- **$format** (string) - Required - The format token (e.g., 'm-d', 'Y-m-d') to compare.
- **$target** (mixed) - Optional - The target date to compare against. If omitted, the current date is used.

### Response
Returns `true` if the formatted date matches the target, `false` otherwise.

## isSameYear($target)

### Description
Checks if the current Verta instance is in the same year as the given target.

### Method
isSameYear

### Parameters
- **$target** (mixed) - Required - The target date to compare.

### Response
Returns `true` if the year matches, `false` otherwise.

## isSameDay($target)

### Description
Checks if the current Verta instance is on the same day as the given target.

### Method
isSameDay

### Parameters
- **$target** (mixed) - Required - The target date to compare.

### Response
Returns `true` if the day matches, `false` otherwise.

## isBirthday($target)

### Description
Checks if the current Verta instance falls on the same month and day as the given target, regardless of year.

### Method
isBirthday

### Parameters
- **$target** (mixed) - Required - The target date to compare.

### Response
Returns `true` if the month and day match, `false` otherwise.

## isSaturday()

### Description
Checks if the current Verta instance is a Saturday.

### Method
isSaturday

### Parameters
None

### Response
Returns `true` if the day is Saturday, `false` otherwise.

## isSunday()

### Description
Checks if the current Verta instance is a Sunday.

### Method
isSunday

### Parameters
None

### Response
Returns `true` if the day is Sunday, `false` otherwise.

## isMonday()

### Description
Checks if the current Verta instance is a Monday.

### Method
isMonday

### Parameters
None

### Response
Returns `true` if the day is Monday, `false` otherwise.

## isTuesday()

### Description
Checks if the current Verta instance is a Tuesday.

### Method
isTuesday

### Parameters
None

### Response
Returns `true` if the day is Tuesday, `false` otherwise.

## isWednesday()

### Description
Checks if the current Verta instance is a Wednesday.

### Method
isWednesday

### Parameters
None

### Response
Returns `true` if the day is Wednesday, `false` otherwise.

## isThursday()

### Description
Checks if the current Verta instance is a Thursday.

### Method
isThursday

### Parameters
None

### Response
Returns `true` if the day is Thursday, `false` otherwise.

## isFriday()

### Description
Checks if the current Verta instance is a Friday.

### Method
isFriday

### Parameters
None

### Response
Returns `true` if the day is Friday, `false` otherwise.

## datetime()

### Description
Returns the Gregorian DateTime equivalent of the current Verta instance.

### Method
datetime

### Parameters
None

### Response
Returns a `DateTime` object representing the Gregorian equivalent.

## getTimestamp()

### Description
Returns the Unix timestamp (seconds since epoch) of the current Verta instance.

### Method
getTimestamp

### Parameters
None

### Response
Returns an integer Unix timestamp.

## getTimezone()

### Description
Returns the timezone of the current Verta instance.

### Method
getTimezone

### Parameters
None

### Response
Returns a `DateTimeZone` object. Use `->getName()` to get the timezone name.

## __toString()

### Description
Returns the default-formatted Jalali string representation of the current Verta instance.

### Method
__toString

### Parameters
None

### Response
Returns a string in the default Jalali format.

## toCarbon()

### Description
Converts the current Verta instance to an Illuminate\Support\Carbon instance.

### Method
toCarbon

### Parameters
None

### Response
Returns an `Illuminate\Support\Carbon` instance.

## getLocale()

### Description
Returns the current locale used for digit localization.

### Method
getLocale

### Parameters
None

### Response
Returns a string representing the locale (e.g., 'en', 'fa').

## getMessages($key = null)

### Description
Returns the localization messages. When a key is provided, returns the messages for that key; otherwise returns all messages.

### Method
getMessages

### Parameters
- **$key** (string) - Optional - The key for the messages (e.g., 'en', 'numbers').

### Response
Returns an array of messages. For example, `getMessages('en')['numbers']` returns the English number mappings.

```

--------------------------------

### Creating Verta instances from Gregorian strings

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Demonstrates creating Verta instances from Gregorian strings, with and without a timezone. Casting to string yields the Jalali formatted date. The timezone property is accessible.

```php
use Hekmatinasser\Verta\Verta;

// Gregorian string → Jalali instance
$v = new Verta('2022-08-15');
echo (string) $v;            // 1401-05-24 00:00:00

// With timezone
$v = new Verta('2019-01-01 17:20:35', 'Asia/Tehran');
echo $v->timezone;           // 'Asia/Tehran'
```

--------------------------------

### Verta::create*(...)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/README.md

Static factory methods inherited from Hekmatinasser\Jalali\Jalali to create Verta instances from various inputs.

```APIDOC
## Verta::create*(...)

### Description
Static factory methods inherited from Hekmatinasser\Jalali\Jalali to create Verta instances from various inputs.

### Method
Static

### Notes
Inherited from the parent class. Includes methods like `createFromFormat`, `createFromTimestamp`, etc.
```

--------------------------------

### Difference methods for Verta (diffYears, diffMonths, etc.)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Difference methods. With second argument `false` the result is signed (negative when `$other` is later); otherwise absolute difference is returned.

```php
$v->diffYears($other)   // absolute by default: diffYears('1395-…') → 3
$v->diffYears($other, false) // signed: → -1
diffMonths($other, $absolute = true)  diffWeeks(...)  diffDays(...)
diffHours(...)  diffMinutes(...)  diffSeconds(...)
```

--------------------------------

### Modify Verta dates (addYears, subMonths, addDays, etc.)

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Fluent modification methods that return the modified instance. Example: `$v->addMonths(2)->format('Y-m-d H:i:s')` → `'1398-12-29 21:30:50'` (month/day clamping observable in tests).

```php
addYears(2)   subYears(3)   addMonths(2)    subMonths(3)
addWeeks(2)   subWeeks(3)   addDays(20)     subDays(7)
addHour()     subHour()     addMinutes(6)   subMinute()
addSeconds(16) subSeconds(30)
```

--------------------------------

### Verta::format()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/README.md

Instance method inherited from Hekmatinasser\Jalali\Jalali to format the Jalali datetime.

```APIDOC
## Verta::format()

### Description
Instance method inherited from Hekmatinasser\Jalali\Jalali to format the Jalali datetime.

### Method
Instance

### Signature
`format($format)`

### Parameters
- **$format** (string) - Required - The format string.

### Returns
- **string** - The formatted Jalali datetime string.

### Notes
Inherited from the parent class.
```

--------------------------------

### loadValidators()

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Iterates over the provider's rules and registers each validation rule with Validator::extend and Validator::replacer.

```APIDOC
## loadValidators()

### Description
Iterates `$this->rules` and for each rule calls `Validator::extend($name, JalaliValidator::class . '@' . $methods['extend'])` and `Validator::replacer($name, JalaliValidator::class . '@' . $methods['replacer'])`.

### Method
loadValidators

### Signature
`public function loadValidators()`

### Response
Registers all validation rules and replacers.
```

--------------------------------

### Handling parse failures with try-catch

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-class.md

Shows catching an Exception when the datetime string cannot be parsed, falling back to Verta::now().

```php
use Hekmatinasser\Verta\Verta;

try {
    $v = new Verta('not-a-date-at-all');
} catch (Exception $e) {
    // parse failure — fall back to "now"
    $v = Verta::now();
}
```

--------------------------------

### Create a Verta instance for current date

Source: https://github.com/hekmatinasser/verta/blob/master/README.md

Creates a new Verta instance for the current date and time and echoes it in Jalali format. The output is a string like '1401-05-24 00:00:00'.

```php
echo verta(); //1401-05-24 00:00:00
```

--------------------------------

### register() container binding

Source: https://github.com/hekmatinasser/verta/blob/master/_autodocs/api-reference/verta-service-provider.md

Binds the container key 'verta' to a closure that returns a new Verta instance with the current datetime. Resolving 'verta' from the container or via the Facades\Verta facade yields this instance.

```php
$this->app->bind('verta', function ($app) {
    return new Verta();
});
```
Tokens:
Raw