Menurut ahli, cacar monyet paling mudah ditularkan lewat kontak kulit ke kulit. Dan bahwa penyebarannya bukan semata-mata disebabkan oleh hubungan intim semata
SELECT `category_id` as `catID`, `category_name` as `cat`
FROM `categories`
WHERE `category_slug` = 'kontak-langsung'
AND `category_type` = 'tag'
AND `categories`.`deleted_at` ISNULLLIMIT 1
Event: dbquery
Events
0.04 ms
Query
Database
1.08 ms
SELECTCOUNT(*) AS `numrows`
FROM `posts`
WHERE `post_type` = 'konten'
AND `post_status` = 'publish'
AND `post_date` < '2025-05-05 20:22:45'
AND `post_site_id` = '16'
AND deleted_at ISNULLAND MATCH(post_tag) AGAINST('"kontak-langsung"' IN BOOLEAN MODE)
AND `posts`.`deleted_at` ISNULL
Event: dbquery
Events
0.01 ms
Query
Database
0.69 ms
SELECT `post_title` as `title`, `post_id` as `id`, `post_name` as `slug`, `post_attribute` as `attr`, `post_image` as `thumb`, `post_date` as `date`, `post_category_name` as `cat`, `post_site_id` as `siteID`
FROM `posts`
WHERE `post_type` = 'konten'
AND `post_status` = 'publish'
AND `post_date` < '2025-05-05 20:22:45'
AND `post_site_id` = '16'
AND deleted_at ISNULLAND MATCH(post_tag) AGAINST('"kontak-langsung"' IN BOOLEAN MODE)
AND `posts`.`deleted_at` ISNULLLIMIT 25
Event: dbquery
Events
0.01 ms
View: pages/tag_layout.php
Views
2.48 ms
View: layout/main.php
Views
1.45 ms
View: layout/header.php
Views
1.21 ms
View: layout/footer.php
Views
0.19 ms
After Filters
Timer
0.00 ms
Required After Filters
Timer
0.12 ms
Database (3 total Queries, 3 of them unique across 1 Connection)
Time
Query String
14.13 ms
SELECT `category_id` as `catID`, `category_name` as `cat`
FROM `categories`
WHERE `category_slug` = 'kontak-langsung'
AND `category_type` = 'tag'
AND `categories`.`deleted_at` ISNULLLIMIT 1
SELECTCOUNT(*) AS `numrows`
FROM `posts`
WHERE `post_type` = 'konten'
AND `post_status` = 'publish'
AND `post_date` < '2025-05-05 20:22:45'
AND `post_site_id` = '16'
AND deleted_at ISNULLAND MATCH(post_tag) AGAINST('"kontak-langsung"' IN BOOLEAN MODE)
AND `posts`.`deleted_at` ISNULL
SELECT `post_title` as `title`, `post_id` as `id`, `post_name` as `slug`, `post_attribute` as `attr`, `post_image` as `thumb`, `post_date` as `date`, `post_category_name` as `cat`, `post_site_id` as `siteID`
FROM `posts`
WHERE `post_type` = 'konten'
AND `post_status` = 'publish'
AND `post_date` < '2025-05-05 20:22:45'
AND `post_site_id` = '16'
AND deleted_at ISNULLAND MATCH(post_tag) AGAINST('"kontak-langsung"' IN BOOLEAN MODE)
AND `posts`.`deleted_at` ISNULLLIMIT 25
protected format -> string (18) "dddd, DD MMMM YYYY"
protected localFormatFunction -> null
protected localGenericMacros -> null
protected localHumanDiffOptions -> null
protected localMacros -> null
protected localMonthsOverflow -> null
protected localSerializer -> null
protected localStrictModeEnabled -> null
protected localToStringFormat -> null
protected localTranslator -> null
protected localYearsOverflow -> null
protected optionsTimeAgo -> null
protected startOfTime -> boolean false
⇄⧉public __toString(): string
(string) $value
Defined in .../nim4n/date-format-indonesia/src/SimpleDate.php:75
⇄⧉public cast(string $className): DateTimeInterface Cast the current instance into the given class.
$value->cast(string $className)
/**
* Cast the current instance into the given class.
*
* @param string $className The $className::instance() method will be called to cast the current object.
*
* @return DateTimeInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Cast.php:31
⇄⧉public addRealUnit($unit, $value = 1): static Add seconds to the instance using timestamp. Positive $value travels forward ...
$value->addRealUnit($unit, $value = 1)
/**
* Add seconds to the instance using timestamp. Positive $value travels
* forward while negative $value travels into the past.
*
* @param string $unit
* @param int $value
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:39
⇄⧉public roundUnit($unit, $precision = 1, $function = 'round'): CarbonInterface Round the current instance at the given unit with given precision if specifie...
/**
* Round the current instance at the given unit with given precision if specified and the given function.
*
* @param string $unit
* @param float|int $precision
* @param string $function
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:40
⇄⧉public startOfDay(): static Resets the time to 00:00:00 start of day
$value->startOfDay()
/**
* Resets the time to 00:00:00 start of day
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfDay();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:46
⇄⧉public format($format): string Returns the formatted date string on success or FALSE on failure.
$value->format($format)
/**
* Returns the formatted date string on success or FALSE on failure.
*
* @see https://php.net/manual/en/datetime.format.php
*
* @param string $format
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:50
⇄⧉public isoWeekYear($year = null, $dayOfWeek = null, $dayOfYear = null): int|static Set/get the week number of year using given first day of week and first day o...
/**
* Set/get the week number of year using given first day of week and first
* day of year included in the first week. Or use ISO format if no settings
* given.
*
* @param int|null $year if null, act as a getter, if not null, set the year and return current instance.
* @param int|null $dayOfWeek first date of week from 0 (Sunday) to 6 (Saturday)
* @param int|null $dayOfYear first day of year included in the week #1
*
* @return int|static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:50
⇄⧉public toMutable(): Carbon Return a mutable copy of the instance.
$value->toMutable()
/**
* Return a mutable copy of the instance.
*
* @return Carbon
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mutability.php:51
⇄⧉public eq($date): bool Determines if the instance is equal to another
$value->eq($date)
/**
* Determines if the instance is equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->eq('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->eq(Carbon::parse('2018-07-25 12:45:16')); // true
* Carbon::parse('2018-07-25 12:45:16')->eq('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see equalTo()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:57
⇄⧉public __construct($time = null, $tz = null) Create a new Carbon instance.
new \Nim4n\SimpleDate($time = null, $tz = null)
/**
* Create a new Carbon instance.
*
* Please see the testing aids section (specifically static::setTestNow())
* for more on the possibility of this constructor returning a test instance.
*
* @param DateTimeInterface|string|null $time
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:60
⇄⧉public endOfDay(): static Resets the time to 23:59:59.999999 end of day
$value->endOfDay()
/**
* Resets the time to 23:59:59.999999 end of day
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfDay();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:61
⇄⧉public toImmutable(): CarbonImmutable Return a immutable copy of the instance.
$value->toImmutable()
/**
* Return a immutable copy of the instance.
*
* @return CarbonImmutable
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mutability.php:64
⇄⧉public midDay(): static Modify to midday, default to self::$midDayAt
$value->midDay()
/**
* Modify to midday, default to self::$midDayAt
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:65
⇄⧉public weekYear($year = null, $dayOfWeek = null, $dayOfYear = null): int|static Set/get the week number of year using given first day of week and first day o...
/**
* Set/get the week number of year using given first day of week and first
* day of year included in the first week. Or use US format if no settings
* given (Sunday / Jan 6).
*
* @param int|null $year if null, act as a getter, if not null, set the year and return current instance.
* @param int|null $dayOfWeek first date of week from 0 (Sunday) to 6 (Saturday)
* @param int|null $dayOfYear first day of year included in the week #1
*
* @return int|static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:70
⇄⧉public rawFormat($format): string
$value->rawFormat($format)
/**
* @see https://php.net/manual/en/datetime.format.php
*
* @param string $format
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:72
⇄⧉public serialize(): string Return a serialized string of the instance.
$value->serialize()
/**
* Return a serialized string of the instance.
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:73
⇄⧉public startOfMonth(): static Resets the date to the first day of the month and the time to 00:00:00
$value->startOfMonth()
/**
* Resets the date to the first day of the month and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfMonth();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:76
⇄⧉public equalTo($date): bool Determines if the instance is equal to another
$value->equalTo($date)
/**
* Determines if the instance is equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->equalTo('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->equalTo(Carbon::parse('2018-07-25 12:45:16')); // true
* Carbon::parse('2018-07-25 12:45:16')->equalTo('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:76
⇄⧉public next($modifier = null): static|false Modify to the next occurrence of a given modifier such as a day of the week. ...
$value->next($modifier = null)
/**
* Modify to the next occurrence of a given modifier such as a day of
* the week. If no modifier is provided, modify to the next occurrence
* of the current day of the week. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param string|int|null $modifier
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:80
⇄⧉public endOfMonth(): static Resets the date to end of the month and time to 23:59:59.999999
$value->endOfMonth()
/**
* Resets the date to end of the month and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfMonth();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:91
⇄⧉public ne($date): bool Determines if the instance is not equal to another
$value->ne($date)
/**
* Determines if the instance is not equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->ne('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->ne(Carbon::parse('2018-07-25 12:45:16')); // false
* Carbon::parse('2018-07-25 12:45:16')->ne('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see notEqualTo()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:100
⇄⧉public timestamp($unixTimestamp): static Set the instance's timestamp.
$value->timestamp($unixTimestamp)
/**
* Set the instance's timestamp.
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $unixTimestamp
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:103
⇄⧉public startOfQuarter(): static Resets the date to the first day of the quarter and the time to 00:00:00
$value->startOfQuarter()
/**
* Resets the date to the first day of the quarter and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfQuarter();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:106
⇄⧉public toDateString(): string Format the instance as date
$value->toDateString()
/**
* Format the instance as date
*
* @example
* ```
* echo Carbon::now()->toDateString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:110
⇄⧉public nextWeekday(): static Go forward to the next weekday.
$value->nextWeekday()
/**
* Go forward to the next weekday.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:117
⇄⧉public notEqualTo($date): bool Determines if the instance is not equal to another
$value->notEqualTo($date)
/**
* Determines if the instance is not equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->notEqualTo('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->notEqualTo(Carbon::parse('2018-07-25 12:45:16')); // false
* Carbon::parse('2018-07-25 12:45:16')->notEqualTo('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:119
⇄⧉public hasLocalMacro($name): bool Checks if macro is registered globally or locally.
$value->hasLocalMacro($name)
/**
* Checks if macro is registered globally or locally.
*
* @param string $name
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:120
⇄⧉public endOfQuarter(): static Resets the date to end of the quarter and time to 23:59:59.999999
$value->endOfQuarter()
/**
* Resets the date to end of the quarter and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfQuarter();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:123
⇄⧉public diff($date = null, $absolute = false): DateInterval Get the difference as a DateInterval instance. Return relative interval (nega...
$value->diff($date = null, $absolute = false)
/**
* Get the difference as a DateInterval instance.
* Return relative interval (negative if $absolute flag is not set to true and the given date is before
* current one).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return DateInterval
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:124
⇄⧉public toFormattedDateString(): string Format the instance as a readable date
$value->toFormattedDateString()
/**
* Format the instance as a readable date
*
* @example
* ```
* echo Carbon::now()->toFormattedDateString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:125
⇄⧉public getPreciseTimestamp($precision = 6): float Returns a timestamp rounded with the given precision (6 by default).
$value->getPreciseTimestamp($precision = 6)
/**
* Returns a timestamp rounded with the given precision (6 by default).
*
* @example getPreciseTimestamp() 1532087464437474 (microsecond maximum precision)
* @example getPreciseTimestamp(6) 1532087464437474
* @example getPreciseTimestamp(5) 153208746443747 (1/100000 second precision)
* @example getPreciseTimestamp(4) 15320874644375 (1/10000 second precision)
* @example getPreciseTimestamp(3) 1532087464437 (millisecond precision)
* @example getPreciseTimestamp(2) 153208746444 (1/100 second precision)
* @example getPreciseTimestamp(1) 15320874644 (1/10 second precision)
* @example getPreciseTimestamp(0) 1532087464 (second precision)
* @example getPreciseTimestamp(-1) 153208746 (10 second precision)
* @example getPreciseTimestamp(-2) 15320875 (100 second precision)
*
* @param int $precision
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:126
⇄⧉public previousWeekday(): static Go backward to the previous weekday.
$value->previousWeekday()
/**
* Go backward to the previous weekday.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:127
⧉public __sleep(): array Returns the list of properties to dump on serialize() called on.
/**
* Returns the list of properties to dump on serialize() called on.
*
* Only used by PHP < 7.4.
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:127
⇄⧉public __clone() Update constructedObjectId on cloned.
clone $value
/**
* Update constructedObjectId on cloned.
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:131
⇄⧉public getLocalMacro($name): callable|null Get the raw callable macro registered globally or locally for a given name.
$value->getLocalMacro($name)
/**
* Get the raw callable macro registered globally or locally for a given name.
*
* @param string $name
*
* @return callable|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:132
⇄⧉public isoWeeksInYear($dayOfWeek = null, $dayOfYear = null): int Get the number of weeks of the current week-year using given first day of wee...
/**
* Get the number of weeks of the current week-year using given first day of week and first
* day of year included in the first week. Or use ISO format if no settings
* given.
*
* @param int|null $dayOfWeek first date of week from 0 (Sunday) to 6 (Saturday)
* @param int|null $dayOfYear first day of year included in the week #1
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:132
⇄⧉public valueOf(): float Returns the milliseconds timestamps used amongst other by Date javascript obj...
$value->valueOf()
/**
* Returns the milliseconds timestamps used amongst other by Date javascript objects.
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:136
⇄⧉public nextWeekendDay(): static Go forward to the next weekend day.
$value->nextWeekendDay()
/**
* Go forward to the next weekend day.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:137
⇄⧉public startOfYear(): static Resets the date to the first day of the year and the time to 00:00:00
$value->startOfYear()
/**
* Resets the date to the first day of the year and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfYear();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:138
⇄⧉public hasLocalTranslator(): bool Return true if the current instance has its own translator.
$value->hasLocalTranslator()
/**
* Return true if the current instance has its own translator.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:138
⇄⧉public gt($date): bool Determines if the instance is greater (after) than another
$value->gt($date)
/**
* Determines if the instance is greater (after) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:15'); // true
* Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->gt('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see greaterThan()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:140
⇄⧉public toFormattedDayDateString(): string Format the instance with the day, and a readable date
$value->toFormattedDayDateString()
/**
* Format the instance with the day, and a readable date
*
* @example
* ```
* echo Carbon::now()->toFormattedDayDateString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:140
⇄⧉public subRealUnit($unit, $value = 1)
$value->subRealUnit($unit, $value = 1)
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:140
⇄⧉public __serialize(): array Returns the values to dump on serialize() called on.
$value->__serialize()
/**
* Returns the values to dump on serialize() called on.
*
* Only used by PHP >= 7.4.
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:146
⇄⧉public getTimestampMs(): int Returns the timestamp with millisecond precision.
$value->getTimestampMs()
/**
* Returns the timestamp with millisecond precision.
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:146
⇄⧉public previousWeekendDay(): static Go backward to the previous weekend day.
$value->previousWeekendDay()
/**
* Go backward to the previous weekend day.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:147
⇄⧉public getLocalTranslator(): \Symfony\Component\Translation\TranslatorInterface Get the translator of the current instance or the default if none set.
$value->getLocalTranslator()
/**
* Get the translator of the current instance or the default if none set.
*
* @return \Symfony\Component\Translation\TranslatorInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:148
⇄⧉public floorUnit($unit, $precision = 1): CarbonInterface Truncate the current instance at the given unit with given precision if speci...
$value->floorUnit($unit, $precision = 1)
/**
* Truncate the current instance at the given unit with given precision if specified.
*
* @param string $unit
* @param float|int $precision
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:149
⇄⧉public weeksInYear($dayOfWeek = null, $dayOfYear = null): int Get the number of weeks of the current week-year using given first day of wee...
/**
* Get the number of weeks of the current week-year using given first day of week and first
* day of year included in the first week. Or use US format if no settings
* given (Sunday / Jan 6).
*
* @param int|null $dayOfWeek first date of week from 0 (Sunday) to 6 (Saturday)
* @param int|null $dayOfYear first day of year included in the week #1
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:150
⇄⧉public diffAsCarbonInterval($date = null, $absolute = true, array $skip = array()): CarbonInterval Get the difference as a CarbonInterval instance. Return relative interval (ne...
/**
* Get the difference as a CarbonInterval instance.
* Return relative interval (negative if $absolute flag is not set to true and the given date is before
* current one).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return CarbonInterval
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:151
⇄⧉public endOfYear(): static Resets the date to end of the year and time to 23:59:59.999999
$value->endOfYear()
/**
* Resets the date to end of the year and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfYear();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:153
⇄⧉public toTimeString($unitPrecision = 'second'): string Format the instance as time
$value->toTimeString($unitPrecision = 'second')
/**
* Format the instance as time
*
* @example
* ```
* echo Carbon::now()->toTimeString();
* ```
*
* @param string $unitPrecision
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:157
⇄⧉public unix(): int
$value->unix()
/**
* @alias getTimestamp
*
* Returns the UNIX timestamp for the current date.
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:158
⇄⧉public greaterThan($date): bool Determines if the instance is greater (after) than another
$value->greaterThan($date)
/**
* Determines if the instance is greater (after) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:15'); // true
* Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->greaterThan('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:159
⇄⧉public setLocalTranslator(Symfony\Component\Translation\TranslatorInterface $translator): $this Set the translator for the current instance.
/**
* Set the translator for the current instance.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator
*
* @return $this
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:160
⇄⧉public previous($modifier = null): static|false Modify to the previous occurrence of a given modifier such as a day of the we...
$value->previous($modifier = null)
/**
* Modify to the previous occurrence of a given modifier such as a day of
* the week. If no dayOfWeek is provided, modify to the previous occurrence
* of the current day of the week. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param string|int|null $modifier
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:162
⇄⧉public ceilUnit($unit, $precision = 1): CarbonInterface Ceil the current instance at the given unit with given precision if specified.
$value->ceilUnit($unit, $precision = 1)
/**
* Ceil the current instance at the given unit with given precision if specified.
*
* @param string $unit
* @param float|int $precision
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:162
⇄⧉public diffInYears($date = null, $absolute = true): int Get the difference in years
/**
* Get the difference in years
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:164
⇄⧉public startOfDecade(): static Resets the date to the first day of the decade and the time to 00:00:00
$value->startOfDecade()
/**
* Resets the date to the first day of the decade and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfDecade();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:168
⇄⧉public toDateTimeString($unitPrecision = 'second'): string Format the instance as date and time
/**
* Format the instance as date and time
*
* @example
* ```
* echo Carbon::now()->toDateTimeString();
* ```
*
* @param string $unitPrecision
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:174
⇄⧉public round($precision = 1, $function = 'round'): CarbonInterface Round the current instance second with given precision if specified.
/**
* Round the current instance second with given precision if specified.
*
* @param float|int|string|\DateInterval|null $precision
* @param string $function
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:175
⇄⧉public diffInQuarters($date = null, $absolute = true): int Get the difference in quarters rounded down.
/**
* Get the difference in quarters rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:177
/**
* Call native PHP DateTime/DateTimeImmutable add() method.
*
* @param DateInterval $interval
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:179
⇄⧉public week($week = null, $dayOfWeek = null, $dayOfYear = null): int|static Get/set the week number using given first day of week and first day of year i...
/**
* Get/set the week number using given first day of week and first
* day of year included in the first week. Or use US format if no settings
* given (Sunday / Jan 6).
*
* @param int|null $week
* @param int|null $dayOfWeek
* @param int|null $dayOfYear
*
* @return int|static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:180
⇄⧉public isAfter($date): bool Determines if the instance is greater (after) than another
$value->isAfter($date)
/**
* Determines if the instance is greater (after) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:15'); // true
* Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->isAfter('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see greaterThan()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:183
⇄⧉public firstOfMonth($dayOfWeek = null): static Modify to the first occurrence of a given day of the week in the current mont...
$value->firstOfMonth($dayOfWeek = null)
/**
* Modify to the first occurrence of a given day of the week
* in the current month. If no dayOfWeek is provided, modify to the
* first day of the current month. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:183
⇄⧉public endOfDecade(): static Resets the date to end of the decade and time to 23:59:59.999999
$value->endOfDecade()
/**
* Resets the date to end of the decade and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfDecade();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:185
⇄⧉public floor($precision = 1): CarbonInterface Round the current instance second with given precision if specified.
$value->floor($precision = 1)
/**
* Round the current instance second with given precision if specified.
*
* @param float|int|string|\DateInterval|null $precision
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:187
⧉public __wakeup(): void Set locale if specified on unserialize() called.
/**
* Set locale if specified on unserialize() called.
*
* Only used by PHP < 7.4.
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:189
⇄⧉public diffInMonths($date = null, $absolute = true): int Get the difference in months rounded down.
/**
* Get the difference in months rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:190
⇄⧉public add($unit, $value = 1, $overflow = null): static Add given units or interval to the current instance.
$value->add($unit, $value = 1, $overflow = null)
/**
* Add given units or interval to the current instance.
*
* @example $date->add('hour', 3)
* @example $date->add(15, 'days')
* @example $date->add(CarbonInterval::days(4))
*
* @param string|DateInterval|Closure|CarbonConverterInterface $unit
* @param int $value
* @param bool|null $overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:198
⇄⧉public ceil($precision = 1): CarbonInterface Ceil the current instance second with given precision if specified.
$value->ceil($precision = 1)
/**
* Ceil the current instance second with given precision if specified.
*
* @param float|int|string|\DateInterval|null $precision
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:199
⇄⧉public startOfCentury(): static Resets the date to the first day of the century and the time to 00:00:00
$value->startOfCentury()
/**
* Resets the date to the first day of the century and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfCentury();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:202
⇄⧉public gte($date): bool Determines if the instance is greater (after) than or equal to another
$value->gte($date)
/**
* Determines if the instance is greater (after) than or equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:15'); // true
* Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->gte('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see greaterThanOrEqualTo()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:204
⇄⧉public lastOfMonth($dayOfWeek = null): static Modify to the last occurrence of a given day of the week in the current month...
$value->lastOfMonth($dayOfWeek = null)
/**
* Modify to the last occurrence of a given day of the week
* in the current month. If no dayOfWeek is provided, modify to the
* last day of the current month. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:204
⇄⧉public getTranslationMessage(string $key, ?string $locale = null, ?string $default = null, $translator = null): string Returns raw translation message for a given key.
/**
* Returns raw translation message for a given key.
*
* @param string $key key to find
* @param string|null $locale current locale used if null
* @param string|null $default default value if translation returns the key
* @param \Symfony\Component\Translation\TranslatorInterface $translator an optional translator to use
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:205
⇄⧉public roundWeek($weekStartsAt = null): CarbonInterface Round the current instance week.
$value->roundWeek($weekStartsAt = null)
/**
* Round the current instance week.
*
* @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:211
⇄⧉public isoWeek($week = null, $dayOfWeek = null, $dayOfYear = null): int|static Get/set the week number using given first day of week and first day of year i...
/**
* Get/set the week number using given first day of week and first
* day of year included in the first week. Or use ISO format if no settings
* given.
*
* @param int|null $week
* @param int|null $dayOfWeek
* @param int|null $dayOfYear
*
* @return int|static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Week.php:211
⇄⧉public diffInWeeks($date = null, $absolute = true): int Get the difference in weeks rounded down.
/**
* Get the difference in weeks rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:217
⇄⧉public toDateTimeLocalString($unitPrecision = 'second'): string Format the instance as date and time T-separated with no timezone
/**
* Format the instance as date and time T-separated with no timezone
*
* @example
* ```
* echo Carbon::now()->toDateTimeLocalString();
* echo "\n";
* echo Carbon::now()->toDateTimeLocalString('minute'); // You can specify precision among: minute, second, millisecond and microsecond
* ```
*
* @param string $unitPrecision
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:218
⇄⧉public endOfCentury(): static Resets the date to end of the century and time to 23:59:59.999999
$value->endOfCentury()
/**
* Resets the date to end of the century and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfCentury();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:219
⇄⧉public greaterThanOrEqualTo($date): bool Determines if the instance is greater (after) than or equal to another
$value->greaterThanOrEqualTo($date)
/**
* Determines if the instance is greater (after) than or equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:15'); // true
* Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->greaterThanOrEqualTo('2018-07-25 12:45:17'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:223
⇄⧉public __unserialize(array $data): void Set locale if specified on unserialize() called.
$value->__unserialize(array $data)
/**
* Set locale if specified on unserialize() called.
*
* Only used by PHP >= 7.4.
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:224
⇄⧉public nthOfMonth($nth, $dayOfWeek): mixed Modify to the given occurrence of a given day of the week in the current mont...
$value->nthOfMonth($nth, $dayOfWeek)
/**
* Modify to the given occurrence of a given day of the week
* in the current month. If the calculated occurrence is outside the scope
* of the current month, then return false and no modifications are made.
* Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:226
⇄⧉public floorWeek($weekStartsAt = null): CarbonInterface Truncate the current instance week.
$value->floorWeek($weekStartsAt = null)
/**
* Truncate the current instance week.
*
* @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:226
⇄⧉public diffInDays($date = null, $absolute = true): int Get the difference in days rounded down.
/**
* Get the difference in days rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:230
⇄⧉public addUnit($unit, $value = 1, $overflow = null): static Add given units to the current instance.
/**
* Add given units to the current instance.
*
* @param string $unit
* @param int $value
* @param bool|null $overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:232
⇄⧉public toDayDateTimeString(): string Format the instance with day, date and time
$value->toDayDateTimeString()
/**
* Format the instance with day, date and time
*
* @example
* ```
* echo Carbon::now()->toDayDateTimeString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:233
⇄⧉public startOfMillennium(): static Resets the date to the first day of the millennium and the time to 00:00:00
$value->startOfMillennium()
/**
* Resets the date to the first day of the millennium and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfMillennium();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:236
⇄⧉public ceilWeek($weekStartsAt = null): CarbonInterface Ceil the current instance week.
$value->ceilWeek($weekStartsAt = null)
/**
* Ceil the current instance week.
*
* @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week
*
* @return CarbonInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Rounding.php:238
⇄⧉public diffInDaysFiltered(Closure $callback, $date = null, $absolute = true): int Get the difference in days using a filter closure rounded down.
/**
* Get the difference in days using a filter closure rounded down.
*
* @param Closure $callback
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:244
⇄⧉public firstOfQuarter($dayOfWeek = null): static Modify to the first occurrence of a given day of the week in the current quar...
$value->firstOfQuarter($dayOfWeek = null)
/**
* Modify to the first occurrence of a given day of the week
* in the current quarter. If no dayOfWeek is provided, modify to the
* first day of the current quarter. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek day of the week default null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:245
⇄⧉public lt($date): bool Determines if the instance is less (before) than another
$value->lt($date)
/**
* Determines if the instance is less (before) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:15'); // false
* Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->lt('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see lessThan()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:247
⇄⧉public toAtomString(): string Format the instance as ATOM
$value->toAtomString()
/**
* Format the instance as ATOM
*
* @example
* ```
* echo Carbon::now()->toAtomString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:248
⇄⧉public endOfMillennium(): static Resets the date to end of the millennium and time to 23:59:59.999999
$value->endOfMillennium()
/**
* Resets the date to end of the millennium and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfMillennium();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:253
/**
* Translate using translation string or callback available.
*
* @param string $key
* @param array $parameters
* @param string|int|float|null $number
* @param \Symfony\Component\Translation\TranslatorInterface|null $translator
* @param bool $altNumbers
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:254
⇄⧉public jsonSerialize(): array|string Prepare the object for JSON serialization.
$value->jsonSerialize()
/**
* Prepare the object for JSON serialization.
*
* @return array|string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:255
⇄⧉public diffInHoursFiltered(Closure $callback, $date = null, $absolute = true): int Get the difference in hours using a filter closure rounded down.
/**
* Get the difference in hours using a filter closure rounded down.
*
* @param Closure $callback
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:258
⇄⧉public lastOfQuarter($dayOfWeek = null): static Modify to the last occurrence of a given day of the week in the current quart...
$value->lastOfQuarter($dayOfWeek = null)
/**
* Modify to the last occurrence of a given day of the week
* in the current quarter. If no dayOfWeek is provided, modify to the
* last day of the current quarter. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek day of the week default null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:260
⇄⧉public toCookieString(): string Format the instance as COOKIE
$value->toCookieString()
/**
* Format the instance as COOKIE
*
* @example
* ```
* echo Carbon::now()->toCookieString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:263
⇄⧉public lessThan($date): bool Determines if the instance is less (before) than another
$value->lessThan($date)
/**
* Determines if the instance is less (before) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:15'); // false
* Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->lessThan('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:266
⇄⧉public translateNumber(int $number): string Returns the alternative number for a given integer if available in the curren...
$value->translateNumber(int $number)
/**
* Returns the alternative number for a given integer if available in the current locale.
*
* @param int $number
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:272
⇄⧉public diffFiltered(Carbon\CarbonInterval $ci, Closure $callback, $date = null, $absolute = true): int Get the difference by the given interval using a filter closure.
/**
* Get the difference by the given interval using a filter closure.
*
* @param CarbonInterval $ci An interval to traverse by
* @param Closure $callback
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:273
⇄⧉public startOfWeek($weekStartsAt = null): static Resets the date to the first day of week (defined in $weekStartsAt) and the t...
$value->startOfWeek($weekStartsAt = null)
/**
* Resets the date to the first day of week (defined in $weekStartsAt) and the time to 00:00:00
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfWeek() . "\n";
* echo Carbon::parse('2018-07-25 12:45:16')->locale('ar')->startOfWeek() . "\n";
* echo Carbon::parse('2018-07-25 12:45:16')->startOfWeek(Carbon::SUNDAY) . "\n";
* ```
*
* @param int $weekStartsAt optional start allow you to specify the day of week to use to start the week
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:274
⇄⧉public nthOfQuarter($nth, $dayOfWeek): mixed Modify to the given occurrence of a given day of the week in the current quar...
$value->nthOfQuarter($nth, $dayOfWeek)
/**
* Modify to the given occurrence of a given day of the week
* in the current quarter. If the calculated occurrence is outside the scope
* of the current quarter, then return false and no modifications are made.
* Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:276
⇄⧉public toIso8601String(): string Format the instance as ISO8601
$value->toIso8601String()
/**
* Format the instance as ISO8601
*
* @example
* ```
* echo Carbon::now()->toIso8601String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:278
⇄⧉public isBefore($date): bool Determines if the instance is less (before) than another
$value->isBefore($date)
/**
* Determines if the instance is less (before) than another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:15'); // false
* Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:16'); // false
* Carbon::parse('2018-07-25 12:45:16')->isBefore('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see lessThan()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:290
⇄⧉public cleanupDumpProperties() Cleanup properties attached to the public scope of DateTime when a dump of th...
$value->cleanupDumpProperties()
/**
* Cleanup properties attached to the public scope of DateTime when a dump of the date is requested.
* foreach ($date as $_) {}
* serializer($date)
* var_export($date)
* get_object_vars($date)
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:290
⇄⧉public endOfWeek($weekEndsAt = null): static Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59....
$value->endOfWeek($weekEndsAt = null)
/**
* Resets the date to end of week (defined in $weekEndsAt) and time to 23:59:59.999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfWeek() . "\n";
* echo Carbon::parse('2018-07-25 12:45:16')->locale('ar')->endOfWeek() . "\n";
* echo Carbon::parse('2018-07-25 12:45:16')->endOfWeek(Carbon::SATURDAY) . "\n";
* ```
*
* @param int $weekEndsAt optional start allow you to specify the day of week to use to end the week
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:293
⇄⧉public toRfc822String(): string Format the instance as RFC822
$value->toRfc822String()
/**
* Format the instance as RFC822
*
* @example
* ```
* echo Carbon::now()->toRfc822String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:293
⇄⧉public firstOfYear($dayOfWeek = null): static Modify to the first occurrence of a given day of the week in the current year...
$value->firstOfYear($dayOfWeek = null)
/**
* Modify to the first occurrence of a given day of the week
* in the current year. If no dayOfWeek is provided, modify to the
* first day of the current year. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek day of the week default null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:296
⇄⧉public diffInWeekdays($date = null, $absolute = true): int Get the difference in weekdays rounded down.
/**
* Get the difference in weekdays rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:299
⇄⧉public startOfHour(): static Modify to start of current hour, minutes and seconds become 0
$value->startOfHour()
/**
* Modify to start of current hour, minutes and seconds become 0
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfHour();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:308
⇄⧉public toIso8601ZuluString($unitPrecision = 'second'): string Convert the instance to UTC and return as Zulu ISO8601
/**
* Convert the instance to UTC and return as Zulu ISO8601
*
* @example
* ```
* echo Carbon::now()->toIso8601ZuluString();
* ```
*
* @param string $unitPrecision
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:310
⇄⧉public lte($date): bool Determines if the instance is less (before) or equal to another
$value->lte($date)
/**
* Determines if the instance is less (before) or equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:15'); // false
* Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->lte('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see lessThanOrEqualTo()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:311
⇄⧉public lastOfYear($dayOfWeek = null): static Modify to the last occurrence of a given day of the week in the current year....
$value->lastOfYear($dayOfWeek = null)
/**
* Modify to the last occurrence of a given day of the week
* in the current year. If no dayOfWeek is provided, modify to the
* last day of the current year. Use the supplied constants
* to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int|null $dayOfWeek day of the week default null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:311
⇄⧉public diffInWeekendDays($date = null, $absolute = true): int Get the difference in weekend days using a filter rounded down.
/**
* Get the difference in weekend days using a filter rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:314
⇄⧉public endOfHour(): static Modify to end of current hour, minutes and seconds become 59
$value->endOfHour()
/**
* Modify to end of current hour, minutes and seconds become 59
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfHour();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:323
⇄⧉public toRfc850String(): string Format the instance as RFC850
$value->toRfc850String()
/**
* Format the instance as RFC850
*
* @example
* ```
* echo Carbon::now()->toRfc850String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:327
⇄⧉public nthOfYear($nth, $dayOfWeek): mixed Modify to the given occurrence of a given day of the week in the current year...
$value->nthOfYear($nth, $dayOfWeek)
/**
* Modify to the given occurrence of a given day of the week
* in the current year. If the calculated occurrence is outside the scope
* of the current year, then return false and no modifications are made.
* Use the supplied constants to indicate the desired dayOfWeek, ex. static::MONDAY.
*
* @param int $nth
* @param int $dayOfWeek
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:327
⇄⧉public diffInHours($date = null, $absolute = true): int Get the difference in hours rounded down.
/**
* Get the difference in hours rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:329
⇄⧉public lessThanOrEqualTo($date): bool Determines if the instance is less (before) or equal to another
$value->lessThanOrEqualTo($date)
/**
* Determines if the instance is less (before) or equal to another
*
* @example
* ```
* Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:15'); // false
* Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:16'); // true
* Carbon::parse('2018-07-25 12:45:16')->lessThanOrEqualTo('2018-07-25 12:45:17'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:330
⇄⧉public subUnit($unit, $value = 1, $overflow = null): static Subtract given units to the current instance.
/**
* Subtract given units to the current instance.
*
* @param string $unit
* @param int $value
* @param bool|null $overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:337
⇄⧉public startOfMinute(): static Modify to start of current minute, seconds become 0
$value->startOfMinute()
/**
* Modify to start of current minute, seconds become 0
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->startOfMinute();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:338
⇄⧉public toRfc1036String(): string Format the instance as RFC1036
$value->toRfc1036String()
/**
* Format the instance as RFC1036
*
* @example
* ```
* echo Carbon::now()->toRfc1036String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:342
⇄⧉public diffInRealHours($date = null, $absolute = true): int Get the difference in hours rounded down using timestamps.
/**
* Get the difference in hours rounded down using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:342
⇄⧉public average($date = null): static Modify the current instance to the average of a given instance (default now) ...
$value->average($date = null)
/**
* Modify the current instance to the average of a given instance (default now) and the current instance
* (second-precision).
*
* @param \Carbon\Carbon|\DateTimeInterface|null $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:342
/**
* Call native PHP DateTime/DateTimeImmutable sub() method.
*
* @param DateInterval $interval
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:349
⇄⧉public endOfMinute(): static Modify to end of current minute, seconds become 59
$value->endOfMinute()
/**
* Modify to end of current minute, seconds become 59
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16')->endOfMinute();
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:353
⇄⧉public diffInMinutes($date = null, $absolute = true): int Get the difference in minutes rounded down.
/**
* Get the difference in minutes rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:355
⇄⧉public closest($date1, $date2): static Get the closest date from the instance (second-precision).
$value->closest($date1, $date2)
/**
* Get the closest date from the instance (second-precision).
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:355
⇄⧉public toRfc1123String(): string Format the instance as RFC1123
$value->toRfc1123String()
/**
* Format the instance as RFC1123
*
* @example
* ```
* echo Carbon::now()->toRfc1123String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:357
⇄⧉public between($date1, $date2, $equal = true): bool Determines if the instance is between two others.
$value->between($date1, $date2, $equal = true)
/**
* Determines if the instance is between two others.
*
* The third argument allow you to specify if bounds are included or not (true by default)
* but for when you including/excluding bounds may produce different results in your application,
* we recommend to use the explicit methods ->betweenIncluded() or ->betweenExcluded() instead.
*
* @example
* ```
* Carbon::parse('2018-07-25')->between('2018-07-14', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->between('2018-08-01', '2018-08-20'); // false
* Carbon::parse('2018-07-25')->between('2018-07-25', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->between('2018-07-25', '2018-08-01', false); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
* @param bool $equal Indicates if an equal to comparison should be done
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:359
⇄⧉public settings(array $settings): $this|static Set specific options. - strictMode: true|false|null - monthOverflow: true|fal...
⇄⧉public sub($unit, $value = 1, $overflow = null): static Subtract given units or interval to the current instance.
$value->sub($unit, $value = 1, $overflow = null)
/**
* Subtract given units or interval to the current instance.
*
* @example $date->sub('hour', 3)
* @example $date->sub(15, 'days')
* @example $date->sub(CarbonInterval::days(4))
*
* @param string|DateInterval|Closure|CarbonConverterInterface $unit
* @param int $value
* @param bool|null $overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:368
⇄⧉public diffInRealMinutes($date = null, $absolute = true): int Get the difference in minutes rounded down using timestamps.
/**
* Get the difference in minutes rounded down using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:368
⇄⧉public farthest($date1, $date2): static Get the farthest date from the instance (second-precision).
$value->farthest($date1, $date2)
/**
* Get the farthest date from the instance (second-precision).
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:368
⇄⧉public startOfSecond(): static Modify to start of current second, microseconds become 0
$value->startOfSecond()
/**
* Modify to start of current second, microseconds become 0
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16.334455')
* ->startOfSecond()
* ->format('H:i:s.u');
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:370
⇄⧉public toRfc2822String(): string Format the instance as RFC2822
$value->toRfc2822String()
/**
* Format the instance as RFC2822
*
* @example
* ```
* echo Carbon::now()->toRfc2822String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:372
⇄⧉public min($date = null): static Get the minimum instance between a given instance (default now) and the curre...
$value->min($date = null)
/**
* Get the minimum instance between a given instance (default now) and the current instance.
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:380
⇄⧉public diffInSeconds($date = null, $absolute = true): int Get the difference in seconds rounded down.
/**
* Get the difference in seconds rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:381
⇄⧉public endOfSecond(): static Modify to end of current second, microseconds become 999999
$value->endOfSecond()
/**
* Modify to end of current second, microseconds become 999999
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16.334455')
* ->endOfSecond()
* ->format('H:i:s.u');
* ```
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:387
⇄⧉public betweenIncluded($date1, $date2): bool Determines if the instance is between two others, bounds included.
$value->betweenIncluded($date1, $date2)
/**
* Determines if the instance is between two others, bounds included.
*
* @example
* ```
* Carbon::parse('2018-07-25')->betweenIncluded('2018-07-14', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->betweenIncluded('2018-08-01', '2018-08-20'); // false
* Carbon::parse('2018-07-25')->betweenIncluded('2018-07-25', '2018-08-01'); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:390
⇄⧉public toRfc3339String($extended = false): string Format the instance as RFC3339
$value->toRfc3339String($extended = false)
/**
* Format the instance as RFC3339
*
* @param bool $extended
*
* @example
* ```
* echo Carbon::now()->toRfc3339String() . "\n";
* echo Carbon::now()->toRfc3339String(true) . "\n";
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:390
⇄⧉public minimum($date = null): static Get the minimum instance between a given instance (default now) and the curre...
$value->minimum($date = null)
/**
* Get the minimum instance between a given instance (default now) and the current instance.
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see min()
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:396
⇄⧉public subtract($unit, $value = 1, $overflow = null): static Subtract given units or interval to the current instance.
/**
* Subtract given units or interval to the current instance.
*
* @see sub()
*
* @param string|DateInterval $unit
* @param int $value
* @param bool|null $overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:404
⇄⧉public diffInMicroseconds($date = null, $absolute = true): int Get the difference in microseconds.
/**
* Get the difference in microseconds.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:405
⇄⧉public getSettings(): array Returns current local settings.
$value->getSettings()
/**
* Returns current local settings.
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:405
⇄⧉public startOf($unit, $params): static Modify to start of current given unit.
$value->startOf($unit, $params)
/**
* Modify to start of current given unit.
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16.334455')
* ->startOf('month')
* ->endOf('week', Carbon::FRIDAY);
* ```
*
* @param string $unit
* @param array<int, mixed> $params
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:407
⇄⧉public max($date = null): static Get the maximum instance between a given instance (default now) and the curre...
$value->max($date = null)
/**
* Get the maximum instance between a given instance (default now) and the current instance.
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:408
⇄⧉public betweenExcluded($date1, $date2): bool Determines if the instance is between two others, bounds excluded.
$value->betweenExcluded($date1, $date2)
/**
* Determines if the instance is between two others, bounds excluded.
*
* @example
* ```
* Carbon::parse('2018-07-25')->betweenExcluded('2018-07-14', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->betweenExcluded('2018-08-01', '2018-08-20'); // false
* Carbon::parse('2018-07-25')->betweenExcluded('2018-07-25', '2018-08-01'); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:410
⇄⧉public toRssString(): string Format the instance as RSS
$value->toRssString()
/**
* Format the instance as RSS
*
* @example
* ```
* echo Carbon::now()->toRssString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:410
⇄⧉public diffInMilliseconds($date = null, $absolute = true): int Get the difference in milliseconds rounded down.
/**
* Get the difference in milliseconds rounded down.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:424
⇄⧉public maximum($date = null): static Get the maximum instance between a given instance (default now) and the curre...
$value->maximum($date = null)
/**
* Get the maximum instance between a given instance (default now) and the current instance.
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date
*
* @see max()
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:424
⇄⧉public toW3cString(): string Format the instance as W3C
$value->toW3cString()
/**
* Format the instance as W3C
*
* @example
* ```
* echo Carbon::now()->toW3cString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:425
⇄⧉public isBetween($date1, $date2, $equal = true): bool Determines if the instance is between two others
$value->isBetween($date1, $date2, $equal = true)
/**
* Determines if the instance is between two others
*
* @example
* ```
* Carbon::parse('2018-07-25')->isBetween('2018-07-14', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->isBetween('2018-08-01', '2018-08-20'); // false
* Carbon::parse('2018-07-25')->isBetween('2018-07-25', '2018-08-01'); // true
* Carbon::parse('2018-07-25')->isBetween('2018-07-25', '2018-08-01', false); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date1
* @param \Carbon\Carbon|\DateTimeInterface|mixed $date2
* @param bool $equal Indicates if an equal to comparison should be done
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:432
⇄⧉public endOf($unit, $params): static Modify to end of current given unit.
$value->endOf($unit, $params)
/**
* Modify to end of current given unit.
*
* @example
* ```
* echo Carbon::parse('2018-07-25 12:45:16.334455')
* ->startOf('month')
* ->endOf('week', Carbon::FRIDAY);
* ```
*
* @param string $unit
* @param array<int, mixed> $params
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Boundaries.php:433
⇄⧉public translateTimeStringTo($timeString, $to = null): string Translate a time string from the current locale (`$date->locale()`) to an other.
/**
* Translate a time string from the current locale (`$date->locale()`) to an other.
*
* @param string $timeString time string to translate
* @param string|null $to output locale of the result returned ("en" by default)
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:434
⇄⧉public modify($modify): static|false Calls \DateTime::modify if mutable or \DateTimeImmutable::modify else.
$value->modify($modify)
/**
* Calls \DateTime::modify if mutable or \DateTimeImmutable::modify else.
*
* @see https://php.net/manual/en/datetime.modify.php
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:437
⇄⧉public diffInRealSeconds($date = null, $absolute = true): int Get the difference in seconds using timestamps.
/**
* Get the difference in seconds using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:437
⧉public __debugInfo(): array Show truthy properties on var_dump().
/**
* Show truthy properties on var_dump().
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:438
⇄⧉public toRfc7231String(): string Format the instance as RFC7231
$value->toRfc7231String()
/**
* Format the instance as RFC7231
*
* @example
* ```
* echo Carbon::now()->toRfc7231String();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:440
⇄⧉public locale(?string $locale = null, $fallbackLocales): $this|string Get/set the locale for the current instance.
/**
* Get/set the locale for the current instance.
*
* @param string|null $locale
* @param string ...$fallbackLocales
*
* @return $this|string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:447
⇄⧉public isWeekday(): bool Determines if the instance is a weekday.
$value->isWeekday()
/**
* Determines if the instance is a weekday.
*
* @example
* ```
* Carbon::parse('2019-07-14')->isWeekday(); // false
* Carbon::parse('2019-07-15')->isWeekday(); // true
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:448
⇄⧉public diffInRealMicroseconds($date = null, $absolute = true): int Get the difference in microseconds using timestamps.
/**
* Get the difference in microseconds using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:454
⇄⧉public change($modifier): static|false Similar to native modify() method of DateTime but can handle more grammars.
$value->change($modifier)
/**
* Similar to native modify() method of DateTime but can handle more grammars.
*
* @example
* ```
* echo Carbon::now()->change('next 2pm');
* ```
*
* @link https://php.net/manual/en/datetime.modify.php
*
* @param string $modifier
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:456
⇄⧉public toArray(): array Get default array representation.
$value->toArray()
/**
* Get default array representation.
*
* @example
* ```
* var_dump(Carbon::now()->toArray());
* ```
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:457
⇄⧉public isWeekend(): bool Determines if the instance is a weekend day.
$value->isWeekend()
/**
* Determines if the instance is a weekend day.
*
* @example
* ```
* Carbon::parse('2019-07-14')->isWeekend(); // true
* Carbon::parse('2019-07-15')->isWeekend(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:464
⇄⧉public diffInRealMilliseconds($date = null, $absolute = true): int Get the difference in milliseconds rounded down using timestamps.
/**
* Get the difference in milliseconds rounded down using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:472
⇄⧉public isYesterday(): bool Determines if the instance is yesterday.
$value->isYesterday()
/**
* Determines if the instance is yesterday.
*
* @example
* ```
* Carbon::yesterday()->isYesterday(); // true
* Carbon::tomorrow()->isYesterday(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:480
⇄⧉public toObject(): object Get default object representation.
$value->toObject()
/**
* Get default object representation.
*
* @example
* ```
* var_dump(Carbon::now()->toObject());
* ```
*
* @return object
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:485
⇄⧉public floatDiffInSeconds($date = null, $absolute = true): float Get the difference in seconds as float (microsecond-precision).
/**
* Get the difference in seconds as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:485
⇄⧉public isToday(): bool Determines if the instance is today.
$value->isToday()
/**
* Determines if the instance is today.
*
* @example
* ```
* Carbon::today()->isToday(); // true
* Carbon::tomorrow()->isToday(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:496
⇄⧉public floatDiffInMinutes($date = null, $absolute = true): float Get the difference in minutes as float (microsecond-precision).
/**
* Get the difference in minutes as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:498
⇄⧉public toString(): string Returns english human readable complete date string.
$value->toString()
/**
* Returns english human readable complete date string.
*
* @example
* ```
* echo Carbon::now()->toString();
* ```
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:500
⇄⧉public floatDiffInHours($date = null, $absolute = true): float Get the difference in hours as float (microsecond-precision).
/**
* Get the difference in hours as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:511
⇄⧉public isTomorrow(): bool Determines if the instance is tomorrow.
$value->isTomorrow()
/**
* Determines if the instance is tomorrow.
*
* @example
* ```
* Carbon::tomorrow()->isTomorrow(); // true
* Carbon::yesterday()->isTomorrow(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:512
⇄⧉public toISOString($keepOffset = false): null|string Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z, if $keepOffset truthy, ...
$value->toISOString($keepOffset = false)
/**
* Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z, if $keepOffset truthy, offset will be kept:
* 1977-04-22T01:00:00-05:00).
*
* @example
* ```
* echo Carbon::now('America/Toronto')->toISOString() . "\n";
* echo Carbon::now('America/Toronto')->toISOString(true) . "\n";
* ```
*
* @param bool $keepOffset Pass true to keep the date offset. Else forced to UTC.
*
* @return null|string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:519
⇄⧉public floatDiffInDays($date = null, $absolute = true): float Get the difference in days as float (microsecond-precision).
/**
* Get the difference in days as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:524
⇄⧉public isFuture(): bool Determines if the instance is in the future, ie. greater (after) than now.
$value->isFuture()
/**
* Determines if the instance is in the future, ie. greater (after) than now.
*
* @example
* ```
* Carbon::now()->addHours(5)->isFuture(); // true
* Carbon::now()->subHours(5)->isFuture(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:528
⇄⧉public toJSON(): null|string Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z) with UTC timezone.
$value->toJSON()
/**
* Return the ISO-8601 string (ex: 1977-04-22T06:00:00Z) with UTC timezone.
*
* @example
* ```
* echo Carbon::now('America/Toronto')->toJSON();
* ```
*
* @return null|string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:542
⇄⧉public isPast(): bool Determines if the instance is in the past, ie. less (before) than now.
$value->isPast()
/**
* Determines if the instance is in the past, ie. less (before) than now.
*
* @example
* ```
* Carbon::now()->subHours(5)->isPast(); // true
* Carbon::now()->addHours(5)->isPast(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:544
⇄⧉public floatDiffInWeeks($date = null, $absolute = true): float Get the difference in weeks as float (microsecond-precision).
/**
* Get the difference in weeks as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:546
⇄⧉public toDateTime(): DateTime Return native DateTime PHP object matching the current instance.
$value->toDateTime()
/**
* Return native DateTime PHP object matching the current instance.
*
* @example
* ```
* var_dump(Carbon::now()->toDateTime());
* ```
*
* @return DateTime
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:557
⇄⧉public floatDiffInMonths($date = null, $absolute = true): float Get the difference in months as float (microsecond-precision).
/**
* Get the difference in months as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:559
⇄⧉public isLeapYear(): bool Determines if the instance is a leap year.
$value->isLeapYear()
/**
* Determines if the instance is a leap year.
*
* @example
* ```
* Carbon::parse('2020-01-01')->isLeapYear(); // true
* Carbon::parse('2019-01-01')->isLeapYear(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:560
⇄⧉public toDateTimeImmutable(): DateTimeImmutable Return native toDateTimeImmutable PHP object matching the current instance.
$value->toDateTimeImmutable()
/**
* Return native toDateTimeImmutable PHP object matching the current instance.
*
* @example
* ```
* var_dump(Carbon::now()->toDateTimeImmutable());
* ```
*
* @return DateTimeImmutable
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:572
⇄⧉public isLongYear(): bool Determines if the instance is a long year (using calendar year).
$value->isLongYear()
/**
* Determines if the instance is a long year (using calendar year).
*
* ⚠️ This method completely ignores month and day to use the numeric year number,
* it's not correct if the exact date matters. For instance as `2019-12-30` is already
* in the first week of the 2020 year, if you want to know from this date if ISO week
* year 2020 is a long year, use `isLongIsoYear` instead.
*
* @example
* ```
* Carbon::create(2015)->isLongYear(); // true
* Carbon::create(2016)->isLongYear(); // false
* ```
*
* @see https://en.wikipedia.org/wiki/ISO_8601#Week_dates
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:583
⇄⧉public toDate(): DateTime
$value->toDate()
/**
* @alias toDateTime
*
* Return native DateTime PHP object matching the current instance.
*
* @example
* ```
* var_dump(Carbon::now()->toDate());
* ```
*
* @return DateTime
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:589
⇄⧉public floatDiffInYears($date = null, $absolute = true): float Get the difference in year as float (microsecond-precision).
/**
* Get the difference in year as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:594
⇄⧉public toPeriod($end = null, $interval = null, $unit = null): CarbonPeriod Create a iterable CarbonPeriod object from current date to a given end date (...
/**
* Create a iterable CarbonPeriod object from current date to a given end date (and optional interval).
*
* @param \DateTimeInterface|Carbon|CarbonImmutable|int|null $end period end date or recurrences count if int
* @param int|\DateInterval|string|null $interval period default interval or number of the given $unit
* @param string|null $unit if specified, $interval must be an integer
*
* @return CarbonPeriod
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:603
⇄⧉public isLongIsoYear(): bool Determines if the instance is a long year (using ISO 8601 year).
$value->isLongIsoYear()
/**
* Determines if the instance is a long year (using ISO 8601 year).
*
* @example
* ```
* Carbon::parse('2015-01-01')->isLongIsoYear(); // true
* Carbon::parse('2016-01-01')->isLongIsoYear(); // true
* Carbon::parse('2016-01-03')->isLongIsoYear(); // false
* Carbon::parse('2019-12-29')->isLongIsoYear(); // false
* Carbon::parse('2019-12-30')->isLongIsoYear(); // true
* ```
*
* @see https://en.wikipedia.org/wiki/ISO_8601#Week_dates
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:604
⇄⧉public isSameAs($format, $date = null): bool Compares the formatted values of the two dates.
$value->isSameAs($format, $date = null)
/**
* Compares the formatted values of the two dates.
*
* @example
* ```
* Carbon::parse('2019-06-13')->isSameAs('Y-d', Carbon::parse('2019-12-13')); // true
* Carbon::parse('2019-06-13')->isSameAs('Y-d', Carbon::parse('2019-06-14')); // false
* ```
*
* @param string $format date formats to compare.
* @param \Carbon\Carbon|\DateTimeInterface|string|null $date instance to compare with or null to use current day.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:623
⇄⧉public floatDiffInRealSeconds($date = null, $absolute = true): float Get the difference in seconds as float (microsecond-precision) using timestamps.
/**
* Get the difference in seconds as float (microsecond-precision) using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:629
⇄⧉public range($end = null, $interval = null, $unit = null): CarbonPeriod Create a iterable CarbonPeriod object from current date to a given end date (...
/**
* Create a iterable CarbonPeriod object from current date to a given end date (and optional interval).
*
* @param \DateTimeInterface|Carbon|CarbonImmutable|null $end period end date
* @param int|\DateInterval|string|null $interval period default interval or number of the given $unit
* @param string|null $unit if specified, $interval must be an integer
*
* @return CarbonPeriod
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:635
⇄⧉public getTimezone(): CarbonTimeZone Get the TimeZone associated with the Carbon instance (as CarbonTimeZone).
$value->getTimezone()
/**
* Get the TimeZone associated with the Carbon instance (as CarbonTimeZone).
*
* @return CarbonTimeZone
*
* @link https://php.net/manual/en/datetime.gettimezone.php
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:637
⇄⧉public floatDiffInRealMinutes($date = null, $absolute = true): float Get the difference in minutes as float (microsecond-precision) using timestamps.
/**
* Get the difference in minutes as float (microsecond-precision) using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:642
⇄⧉public isSameUnit($unit, $date = null): bool Determines if the instance is in the current unit given.
$value->isSameUnit($unit, $date = null)
/**
* Determines if the instance is in the current unit given.
*
* @example
* ```
* Carbon::parse('2019-01-13')->isSameUnit('year', Carbon::parse('2019-12-25')); // true
* Carbon::parse('2018-12-13')->isSameUnit('year', Carbon::parse('2019-12-25')); // false
* ```
*
* @param string $unit singular unit string
* @param \Carbon\Carbon|\DateTimeInterface|null $date instance to compare with or null to use current day.
*
* @throws BadComparisonUnitException
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:644
⇄⧉public floatDiffInRealHours($date = null, $absolute = true): float Get the difference in hours as float (microsecond-precision) using timestamps.
/**
* Get the difference in hours as float (microsecond-precision) using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:655
⇄⧉public floatDiffInRealDays($date = null, $absolute = true): float Get the difference in days as float (microsecond-precision).
/**
* Get the difference in days as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:668
⇄⧉public copy(): static Get a copy of the instance.
$value->copy()
/**
* Get a copy of the instance.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:672
⇄⧉public clone(): static
$value->clone()
/**
* @alias copy
*
* Get a copy of the instance.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:684
⇄⧉public floatDiffInRealWeeks($date = null, $absolute = true): float Get the difference in weeks as float (microsecond-precision).
/**
* Get the difference in weeks as float (microsecond-precision).
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:685
⇄⧉public isCurrentUnit($unit): bool Determines if the instance is in the current unit given.
$value->isCurrentUnit($unit)
/**
* Determines if the instance is in the current unit given.
*
* @example
* ```
* Carbon::now()->isCurrentUnit('hour'); // true
* Carbon::now()->subHours(2)->isCurrentUnit('hour'); // false
* ```
*
* @param string $unit The unit to test.
*
* @throws BadMethodCallException
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:695
⇄⧉public avoidMutation(): self Clone the current instance if it's mutable.
$value->avoidMutation()
/**
* Clone the current instance if it's mutable.
*
* This method is convenient to ensure you don't mutate the initial object
* but avoid to make a useless copy of it if it's already immutable.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:697
⇄⧉public floatDiffInRealMonths($date = null, $absolute = true): float Get the difference in months as float (microsecond-precision) using timestamps.
/**
* Get the difference in months as float (microsecond-precision) using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:698
⇄⧉public nowWithSameTz(): static Returns a present instance in the same timezone.
$value->nowWithSameTz()
/**
* Returns a present instance in the same timezone.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:711
⇄⧉public isSameQuarter($date = null, $ofSameYear = true): bool Checks if the passed in date is in the same quarter as the instance quarter (...
/**
* Checks if the passed in date is in the same quarter as the instance quarter (and year if needed).
*
* @example
* ```
* Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2019-03-01')); // true
* Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2019-04-01')); // false
* Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2018-03-01')); // false
* Carbon::parse('2019-01-12')->isSameQuarter(Carbon::parse('2018-03-01'), false); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|string|null $date The instance to compare with or null to use current day.
* @param bool $ofSameYear Check if it is the same month in the same year.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:716
⇄⧉public floatDiffInRealYears($date = null, $absolute = true): float Get the difference in year as float (microsecond-precision) using timestamps.
/**
* Get the difference in year as float (microsecond-precision) using timestamps.
*
* @param \Carbon\CarbonInterface|\DateTimeInterface|string|null $date
* @param bool $absolute Get the absolute of the difference
*
* @return float
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:733
⇄⧉public isSameMonth($date = null, $ofSameYear = true): bool Checks if the passed in date is in the same month as the instance´s month.
/**
* Checks if the passed in date is in the same month as the instance´s month.
*
* @example
* ```
* Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2019-01-01')); // true
* Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2019-02-01')); // false
* Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2018-01-01')); // false
* Carbon::parse('2019-01-12')->isSameMonth(Carbon::parse('2018-01-01'), false); // true
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use the current date.
* @param bool $ofSameYear Check if it is the same month in the same year.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:739
⇄⧉public isDayOfWeek($dayOfWeek): bool Checks if this day is a specific day of the week.
$value->isDayOfWeek($dayOfWeek)
/**
* Checks if this day is a specific day of the week.
*
* @example
* ```
* Carbon::parse('2019-07-17')->isDayOfWeek(Carbon::WEDNESDAY); // true
* Carbon::parse('2019-07-17')->isDayOfWeek(Carbon::FRIDAY); // false
* Carbon::parse('2019-07-17')->isDayOfWeek('Wednesday'); // true
* Carbon::parse('2019-07-17')->isDayOfWeek('Friday'); // false
* ```
*
* @param int $dayOfWeek
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:759
⇄⧉public secondsSinceMidnight(): int The number of seconds since midnight.
$value->secondsSinceMidnight()
/**
* The number of seconds since midnight.
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:765
⇄⧉public secondsUntilEndOfDay(): int The number of seconds until 23:59:59.
$value->secondsUntilEndOfDay()
/**
* The number of seconds until 23:59:59.
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:775
⇄⧉public isBirthday($date = null): bool Check if its the birthday. Compares the date/month values of the two dates.
$value->isBirthday($date = null)
/**
* Check if its the birthday. Compares the date/month values of the two dates.
*
* @example
* ```
* Carbon::now()->subYears(5)->isBirthday(); // true
* Carbon::now()->subYears(5)->subDay()->isBirthday(); // false
* Carbon::parse('2019-06-05')->isBirthday(Carbon::parse('2001-06-05')); // true
* Carbon::parse('2019-06-05')->isBirthday(Carbon::parse('2001-06-06')); // false
* ```
*
* @param \Carbon\Carbon|\DateTimeInterface|null $date The instance to compare with or null to use current day.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:783
⇄⧉public carbonize($date = null): static Return the Carbon instance passed through, a now instance in the same timezon...
$value->carbonize($date = null)
/**
* Return the Carbon instance passed through, a now instance in the same timezone
* if null given or parse the input if string given.
*
* @param Carbon|\Carbon\CarbonPeriod|\Carbon\CarbonInterval|\DateInterval|\DatePeriod|DateTimeInterface|string|null $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:794
⇄⧉public isLastOfMonth(): bool Check if today is the last day of the Month
$value->isLastOfMonth()
/**
* Check if today is the last day of the Month
*
* @example
* ```
* Carbon::parse('2019-02-28')->isLastOfMonth(); // true
* Carbon::parse('2019-03-28')->isLastOfMonth(); // false
* Carbon::parse('2019-03-30')->isLastOfMonth(); // false
* Carbon::parse('2019-03-31')->isLastOfMonth(); // true
* Carbon::parse('2019-04-30')->isLastOfMonth(); // true
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:802
⧉public __get($name): string|int|bool|DateTimeZone|null Get a part of the Carbon object
/**
* Get a part of the Carbon object
*
* @param string $name
*
* @throws UnknownGetterException
*
* @return string|int|bool|DateTimeZone|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:820
⇄⧉public isStartOfDay($checkMicroseconds = false): bool Check if the instance is start of day / midnight.
$value->isStartOfDay($checkMicroseconds = false)
/**
* Check if the instance is start of day / midnight.
*
* @example
* ```
* Carbon::parse('2019-02-28 00:00:00')->isStartOfDay(); // true
* Carbon::parse('2019-02-28 00:00:00.999999')->isStartOfDay(); // true
* Carbon::parse('2019-02-28 00:00:01')->isStartOfDay(); // false
* Carbon::parse('2019-02-28 00:00:00.000000')->isStartOfDay(true); // true
* Carbon::parse('2019-02-28 00:00:00.000012')->isStartOfDay(true); // false
* ```
*
* @param bool $checkMicroseconds check time at microseconds precision
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:823
⇄⧉public diffForHumans($other = null, $syntax = null, $short = false, $parts = 1, $options = null): string Get the difference in a human readable format in the current locale from curr...
/**
* Get the difference in a human readable format in the current locale from current instance to an other
* instance given (or now if null given).
*
* @example
* ```
* echo Carbon::tomorrow()->diffForHumans() . "\n";
* echo Carbon::tomorrow()->diffForHumans(['parts' => 2]) . "\n";
* echo Carbon::tomorrow()->diffForHumans(['parts' => 3, 'join' => true]) . "\n";
* echo Carbon::tomorrow()->diffForHumans(Carbon::yesterday()) . "\n";
* echo Carbon::tomorrow()->diffForHumans(Carbon::yesterday(), ['short' => true]) . "\n";
* ```
*
* @param Carbon|\DateTimeInterface|string|array|null $other if array passed, will be used as parameters array, see $syntax below;
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'skip' entry, list of units to skip (array of strings or a single string,
* ` it can be the unit name (singular or plural) or its shortcut
* ` (y, m, w, d, h, min, s, ms, µs).
* - 'aUnit' entry, prefer "an hour" over "1 hour" if true
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* - 'minimumUnit' entry determines the smallest unit of time to display can be long or
* ` short form of the units, e.g. 'hour' or 'h' (default value: s)
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single unit)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:827
⇄⧉public get($name): string|int|bool|DateTimeZone|null Get a part of the Carbon object
$value->get($name)
/**
* Get a part of the Carbon object
*
* @param string $name
*
* @throws UnknownGetterException
*
* @return string|int|bool|DateTimeZone|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:834
⇄⧉public isEndOfDay($checkMicroseconds = false): bool Check if the instance is end of day.
$value->isEndOfDay($checkMicroseconds = false)
/**
* Check if the instance is end of day.
*
* @example
* ```
* Carbon::parse('2019-02-28 23:59:59.999999')->isEndOfDay(); // true
* Carbon::parse('2019-02-28 23:59:59.123456')->isEndOfDay(); // true
* Carbon::parse('2019-02-28 23:59:59')->isEndOfDay(); // true
* Carbon::parse('2019-02-28 23:59:58.999999')->isEndOfDay(); // false
* Carbon::parse('2019-02-28 23:59:59.999999')->isEndOfDay(true); // true
* Carbon::parse('2019-02-28 23:59:59.123456')->isEndOfDay(true); // false
* Carbon::parse('2019-02-28 23:59:59')->isEndOfDay(true); // false
* ```
*
* @param bool $checkMicroseconds check time at microseconds precision
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:849
⇄⧉public isMidnight(): bool Check if the instance is start of day / midnight.
$value->isMidnight()
/**
* Check if the instance is start of day / midnight.
*
* @example
* ```
* Carbon::parse('2019-02-28 00:00:00')->isMidnight(); // true
* Carbon::parse('2019-02-28 00:00:00.999999')->isMidnight(); // true
* Carbon::parse('2019-02-28 00:00:01')->isMidnight(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:869
/**
* @alias diffForHumans
*
* Get the difference in a human readable format in the current locale from current instance to an other
* instance given (or now if null given).
*
* @param Carbon|\DateTimeInterface|string|array|null $other if array passed, will be used as parameters array, see $syntax below;
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single unit)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:886
⇄⧉public isMidday(): bool Check if the instance is midday.
$value->isMidday()
/**
* Check if the instance is midday.
*
* @example
* ```
* Carbon::parse('2019-02-28 11:59:59.999999')->isMidday(); // false
* Carbon::parse('2019-02-28 12:00:00')->isMidday(); // true
* Carbon::parse('2019-02-28 12:00:00.999999')->isMidday(); // true
* Carbon::parse('2019-02-28 12:00:01')->isMidday(); // false
* ```
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:887
/**
* @alias diffForHumans
*
* Get the difference in a human readable format in the current locale from current instance to an other
* instance given (or now if null given).
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:897
⇄⧉public to($other = null, $syntax = null, $short = false, $parts = 1, $options = null): string Get the difference in a human readable format in the current locale from an o...
/**
* Get the difference in a human readable format in the current locale from an other
* instance given (or now if null given) to current instance.
*
* When comparing a value in the past to default now:
* 1 hour from now
* 5 months from now
*
* When comparing a value in the future to default now:
* 1 hour ago
* 5 months ago
*
* When comparing a value in the past to another value:
* 1 hour after
* 5 months after
*
* When comparing a value in the future to another value:
* 1 hour before
* 5 months before
*
* @param Carbon|\DateTimeInterface|string|array|null $other if array passed, will be used as parameters array, see $syntax below;
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single unit)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:950
⇄⧉public is(string $tester): bool Returns true if the current date matches the given string.
$value->is(string $tester)
/**
* Returns true if the current date matches the given string.
*
* @example
* ```
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2018')); // false
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019-06')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('06-02')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('2019-06-02')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('Sunday')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('June')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23:45')); // true
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12:23:00')); // false
* var_dump(Carbon::parse('2019-06-02 12:23:45')->is('12h')); // true
* var_dump(Carbon::parse('2019-06-02 15:23:45')->is('3pm')); // true
* var_dump(Carbon::parse('2019-06-02 15:23:45')->is('3am')); // false
* ```
*
* @param string $tester day name, month name, hour, date, etc. as string
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:989
/**
* @alias to
*
* Get the difference in a human readable format in the current locale from an other
* instance given (or now if null given) to current instance.
*
* @param Carbon|\DateTimeInterface|string|array|null $other if array passed, will be used as parameters array, see $syntax below;
* if null passed, now will be used as comparison reference;
* if any other type, it will be converted to date and used as reference.
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* - 'other' entry (see above)
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single unit)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:993
⇄⧉public fromNow($syntax = null, $short = false, $parts = 1, $options = null): string Get the difference in a human readable format in the current locale from curr...
/**
* Get the difference in a human readable format in the current locale from current
* instance to now.
*
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single unit)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:1026
⇄⧉public toNow($syntax = null, $short = false, $parts = 1, $options = null): string Get the difference in a human readable format in the current locale from an o...
/**
* Get the difference in a human readable format in the current locale from an other
* instance given to now
*
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single part)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:1065
⧉public __isset($name): bool Check if an attribute exists on the object
/**
* Check if an attribute exists on the object
*
* @param string $name
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1090
⇄⧉public isStartOfTime(): bool Returns true if the date was created using CarbonImmutable::startOfTime()
$value->isStartOfTime()
/**
* Returns true if the date was created using CarbonImmutable::startOfTime()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:1097
⇄⧉public ago($syntax = null, $short = false, $parts = 1, $options = null): string Get the difference in a human readable format in the current locale from an o...
/**
* Get the difference in a human readable format in the current locale from an other
* instance given to now
*
* @param int|array $syntax if array passed, parameters will be extracted from it, the array may contains:
* - 'syntax' entry (see below)
* - 'short' entry (see below)
* - 'parts' entry (see below)
* - 'options' entry (see below)
* - 'join' entry determines how to join multiple parts of the string
* ` - if $join is a string, it's used as a joiner glue
* ` - if $join is a callable/closure, it get the list of string and should return a string
* ` - if $join is an array, the first item will be the default glue, and the second item
* ` will be used instead of the glue for the last item
* ` - if $join is true, it will be guessed from the locale ('list' translation file entry)
* ` - if $join is missing, a space will be used as glue
* if int passed, it add modifiers:
* Possible values:
* - CarbonInterface::DIFF_ABSOLUTE no modifiers
* - CarbonInterface::DIFF_RELATIVE_TO_NOW add ago/from now modifier
* - CarbonInterface::DIFF_RELATIVE_TO_OTHER add before/after modifier
* Default value: CarbonInterface::DIFF_ABSOLUTE
* @param bool $short displays short format of time units
* @param int $parts maximum number of parts to display (default value: 1: single part)
* @param int $options human diff options
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:1098
⇄⧉public isEndOfTime(): bool Returns true if the date was created using CarbonImmutable::endOfTime()
$value->isEndOfTime()
/**
* Returns true if the date was created using CarbonImmutable::endOfTime()
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:1107
⧉public __set($name, $value): void Set a part of the Carbon object
/**
* Set a part of the Carbon object
*
* @param string $name
* @param string|int|DateTimeZone $value
*
* @throws UnknownSetterException|ReflectionException
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1111
⇄⧉public timespan($other = null, $timezone = null): string Get the difference in a human readable format in the current locale from curr...
$value->timespan($other = null, $timezone = null)
/**
* Get the difference in a human readable format in the current locale from current instance to an other
* instance given (or now if null given).
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:1115
⇄⧉public set($name, $value = null): $this Set a part of the Carbon object
$value->set($name, $value = null)
/**
* Set a part of the Carbon object
*
* @param string|array $name
* @param string|int|DateTimeZone $value
*
* @throws ImmutableException|UnknownSetterException
*
* @return $this
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1132
⇄⧉public calendar($referenceTime = null, array $formats = array()): string Returns either day of week + time (e.g. "Last Friday at 3:30 PM") if referenc...
/**
* Returns either day of week + time (e.g. "Last Friday at 3:30 PM") if reference time is within 7 days,
* or a calendar date (e.g. "10/29/2017") otherwise.
*
* Language, date and time formats will change according to the current locale.
*
* @param Carbon|\DateTimeInterface|string|null $referenceTime
* @param array $formats
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:1140
⇄⧉public getTranslatedDayName($context = null, $keySuffix = '', $defaultValue = null): string Get the translation of the current week day name (with context for languages ...
/**
* Get the translation of the current week day name (with context for languages with multiple forms).
*
* @param string|null $context whole format string
* @param string $keySuffix "", "_short" or "_min"
* @param string|null $defaultValue default value if translation missing
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1282
⇄⧉public getTranslatedShortDayName($context = null): string Get the translation of the current short week day name (with context for lang...
/**
* Get the translation of the current short week day name (with context for languages with multiple forms).
*
* @param string|null $context whole format string
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1294
⇄⧉public getTranslatedMinDayName($context = null): string Get the translation of the current abbreviated week day name (with context fo...
$value->getTranslatedMinDayName($context = null)
/**
* Get the translation of the current abbreviated week day name (with context for languages with multiple forms).
*
* @param string|null $context whole format string
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1306
⇄⧉public getTranslatedMonthName($context = null, $keySuffix = '', $defaultValue = null): string Get the translation of the current month day name (with context for languages...
/**
* Get the translation of the current month day name (with context for languages with multiple forms).
*
* @param string|null $context whole format string
* @param string $keySuffix "" or "_short"
* @param string|null $defaultValue default value if translation missing
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1320
⇄⧉public getTranslatedShortMonthName($context = null): string Get the translation of the current short month day name (with context for lan...
/**
* Get the translation of the current short month day name (with context for languages with multiple forms).
*
* @param string|null $context whole format string
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1332
⇄⧉public dayOfYear($value = null): static|int Get/set the day of year.
$value->dayOfYear($value = null)
/**
* Get/set the day of year.
*
* @param int|null $value new value for day of year if using as setter.
*
* @return static|int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1344
⇄⧉public weekday($value = null): static|int Get/set the weekday from 0 (Sunday) to 6 (Saturday).
$value->weekday($value = null)
/**
* Get/set the weekday from 0 (Sunday) to 6 (Saturday).
*
* @param int|null $value new value for weekday if using as setter.
*
* @return static|int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1358
⇄⧉public isoWeekday($value = null): static|int Get/set the ISO weekday from 1 (Monday) to 7 (Sunday).
$value->isoWeekday($value = null)
/**
* Get/set the ISO weekday from 1 (Monday) to 7 (Sunday).
*
* @param int|null $value new value for weekday if using as setter.
*
* @return static|int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1377
⇄⧉public getDaysFromStartOfWeek(?int $weekStartsAt = null): int Return the number of days since the start of the week (using the current loca...
/**
* Return the number of days since the start of the week (using the current locale or the first parameter
* if explicitly given).
*
* @param int|null $weekStartsAt optional start allow you to specify the day of week to use to start the week,
* if not provided, start of week is inferred from the locale
* (Sunday for en_US, Monday for de_DE, etc.)
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1394
⇄⧉public setDaysFromStartOfWeek(int $numberOfDays, ?int $weekStartsAt = null): static Set the day (keeping the current time) to the start of the week + the number ...
/**
* Set the day (keeping the current time) to the start of the week + the number of days passed as the first
* parameter. First day of week is driven by the locale unless explicitly set with the second parameter.
*
* @param int $numberOfDays number of days to add after the start of the current week
* @param int|null $weekStartsAt optional start allow you to specify the day of week to use to start the week,
* if not provided, start of week is inferred from the locale
* (Sunday for en_US, Monday for de_DE, etc.)
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1412
⇄⧉public setUnitNoOverflow($valueUnit, $value, $overflowUnit): static Set any unit to a new value without overflowing current other unit given.
/**
* Set any unit to a new value without overflowing current other unit given.
*
* @param string $valueUnit unit name to modify
* @param int $value new value for the input unit
* @param string $overflowUnit unit name to not overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1426
⇄⧉public addUnitNoOverflow($valueUnit, $value, $overflowUnit): static Add any unit to a new value without overflowing current other unit given.
/**
* Add any unit to a new value without overflowing current other unit given.
*
* @param string $valueUnit unit name to modify
* @param int $value amount to add to the input unit
* @param string $overflowUnit unit name to not overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1455
⇄⧉public subUnitNoOverflow($valueUnit, $value, $overflowUnit): static Subtract any unit to a new value without overflowing current other unit given.
/**
* Subtract any unit to a new value without overflowing current other unit given.
*
* @param string $valueUnit unit name to modify
* @param int $value amount to subtract to the input unit
* @param string $overflowUnit unit name to not overflow
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1469
⇄⧉public utcOffset(?int $minuteOffset = null): int|static Returns the minutes offset to UTC if no arguments passed, else set the timezo...
$value->utcOffset(?int $minuteOffset = null)
/**
* Returns the minutes offset to UTC if no arguments passed, else set the timezone with given minutes shift passed.
*
* @param int|null $minuteOffset
*
* @return int|static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1481
⇄⧉public setDate($year, $month, $day): static Set the date with gregorian year, month and day numbers.
$value->setDate($year, $month, $day)
/**
* Set the date with gregorian year, month and day numbers.
*
* @see https://php.net/manual/en/datetime.setdate.php
*
* @param int $year
* @param int $month
* @param int $day
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1502
⇄⧉public setISODate($year, $week, $day = 1): static Set a date according to the ISO 8601 standard - using weeks and day offsets r...
$value->setISODate($year, $week, $day = 1)
/**
* Set a date according to the ISO 8601 standard - using weeks and day offsets rather than specific dates.
*
* @see https://php.net/manual/en/datetime.setisodate.php
*
* @param int $year
* @param int $week
* @param int $day
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1519
⇄⧉public setDateTime($year, $month, $day, $hour, $minute, $second0, $microseconds0): static Set the date and time all together.
/**
* Set the date and time all together.
*
* @param int $year
* @param int $month
* @param int $day
* @param int $hour
* @param int $minute
* @param int $second
* @param int $microseconds
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1537
⇄⧉public setTime($hour, $minute, $second0, $microseconds0): static Resets the current time of the DateTime object to a different time.
/**
* Resets the current time of the DateTime object to a different time.
*
* @see https://php.net/manual/en/datetime.settime.php
*
* @param int $hour
* @param int $minute
* @param int $second
* @param int $microseconds
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1555
⇄⧉public setTimestamp($unixTimestamp): static Set the instance's timestamp.
$value->setTimestamp($unixTimestamp)
/**
* Set the instance's timestamp.
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $unixTimestamp
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1570
⇄⧉public setTimeFromTimeString($time): static Set the time by time string.
$value->setTimeFromTimeString($time)
/**
* Set the time by time string.
*
* @param string $time
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1584
⇄⧉public timezone($value): static
$value->timezone($value)
/**
* @alias setTimezone
*
* @param DateTimeZone|string $value
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1600
⇄⧉public tz($value = null): static|string Set the timezone or returns the timezone name if no arguments passed.
$value->tz($value = null)
/**
* Set the timezone or returns the timezone name if no arguments passed.
*
* @param DateTimeZone|string $value
*
* @return static|string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1612
⇄⧉public setTimezone($value): static Set the instance's timezone from a string or object.
$value->setTimezone($value)
/**
* Set the instance's timezone from a string or object.
*
* @param DateTimeZone|string $value
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1629
⇄⧉public shiftTimezone($value): static Set the instance's timezone from a string or object and add/subtract the offs...
$value->shiftTimezone($value)
/**
* Set the instance's timezone from a string or object and add/subtract the offset difference.
*
* @param DateTimeZone|string $value
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1647
⇄⧉public utc(): static Set the instance's timezone to UTC.
$value->utc()
/**
* Set the instance's timezone to UTC.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1661
⇄⧉public setDateFrom($date = null): static Set the year, month, and date for this instance to that of the passed instance.
$value->setDateFrom($date = null)
/**
* Set the year, month, and date for this instance to that of the passed instance.
*
* @param Carbon|DateTimeInterface $date now if null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1673
⇄⧉public setTimeFrom($date = null): static Set the hour, minute, second and microseconds for this instance to that of th...
$value->setTimeFrom($date = null)
/**
* Set the hour, minute, second and microseconds for this instance to that of the passed instance.
*
* @param Carbon|DateTimeInterface $date now if null
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1687
⇄⧉public setDateTimeFrom($date = null): static Set the date and time for this instance to that of the passed instance.
$value->setDateTimeFrom($date = null)
/**
* Set the date and time for this instance to that of the passed instance.
*
* @param Carbon|DateTimeInterface $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1701
⇄⧉public formatLocalized($format): string Format the instance with the current locale. You can set the current locale ...
$value->formatLocalized($format)
/**
* Format the instance with the current locale. You can set the current
* locale using setlocale() https://php.net/setlocale.
*
* @deprecated It uses OS language package and strftime() which is deprecated since PHP 8.1.
* Use ->isoFormat() instead.
* Deprecated since 2.55.0
*
* @param string $format
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1885
⇄⧉public getIsoFormats($locale = null): array Returns list of locale formats for ISO formatting.
$value->getIsoFormats($locale = null)
/**
* Returns list of locale formats for ISO formatting.
*
* @param string|null $locale current locale used if null
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1913
⇄⧉public getCalendarFormats($locale = null): array Returns list of calendar formats for ISO formatting.
$value->getCalendarFormats($locale = null)
/**
* Returns list of calendar formats for ISO formatting.
*
* @param string|null $locale current locale used if null
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1936
⇄⧉public getPaddedUnit($unit, $length = 2, $padString = '0', $padType0): string Returns a unit of the instance padded with 0 by default or any other string i...
/**
* Returns a unit of the instance padded with 0 by default or any other string if specified.
*
* @param string $unit Carbon unit name
* @param int $length Length of the output (2 by default)
* @param string $padString String to use for padding ("0" by default)
* @param int $padType Side(s) to pad (STR_PAD_LEFT by default)
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2087
⇄⧉public ordinal(string $key, ?string $period = null): string Return a property with its ordinal.
/**
* Return a property with its ordinal.
*
* @param string $key
* @param string|null $period
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2100
⇄⧉public meridiem(bool $isLower = false): string Return the meridiem of the current time in the current locale.
$value->meridiem(bool $isLower = false)
/**
* Return the meridiem of the current time in the current locale.
*
* @param bool $isLower if true, returns lowercase variant if available in the current locale.
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2118
⇄⧉public getAltNumber(string $key): string Returns the alternative number for a given date property if available in the ...
$value->getAltNumber(string $key)
/**
* Returns the alternative number for a given date property if available in the current locale.
*
* @param string $key date property
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2158
⇄⧉public isoFormat(string $format, ?string $originalFormat = null): string Format in the current language using ISO replacement patterns.
/**
* Format in the current language using ISO replacement patterns.
*
* @param string $format
* @param string|null $originalFormat provide context if a chunk has been passed alone
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2171
⇄⧉public translatedFormat(string $format): string Format as ->format() do (using date replacements patterns from https://php.ne...
$value->translatedFormat(string $format)
/**
* Format as ->format() do (using date replacements patterns from https://php.net/manual/en/function.date.php)
* but translate words whenever possible (months, day names, etc.) using the current locale.
*
* @param string $format
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2328
⇄⧉public getOffsetString($separator = ':'): string Returns the offset hour and minute formatted with +/- and a given separator (...
$value->getOffsetString($separator = ':')
/**
* Returns the offset hour and minute formatted with +/- and a given separator (":" by default).
* For example, if the time zone is 9 hours 30 minutes, you'll get "+09:30", with "@@" as first
* argument, "+09@@30", with "" as first argument, "+0930". Negative offset will return something
* like "-12:00".
*
* @param string $separator string to place between hours and minutes (":" by default)
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2411
⇄⧉public setUnit($unit, $value = null): static Set specified unit to new given value.
$value->setUnit($unit, $value = null)
/**
* Set specified unit to new given value.
*
* @param string $unit year, month, day, hour, minute, second or microsecond
* @param int $value new value for given unit
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2473
⧉public __call($method, $parameters): mixed Dynamically handle calls to the class.
/**
* Dynamically handle calls to the class.
*
* @param string $method magic method name called
* @param array $parameters parameters list
*
* @throws UnknownMethodException|BadMethodCallException|ReflectionException|Throwable
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2577
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/IntervalRounding.php:23
⧉protected roundWith($precision, $function)
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/IntervalRounding.php:38
⧉protected addExtraDebugInfos(&$infos): void
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:455
⧉protected getTranslatorLocale($translator = null): ?string Get the locale of a given translator.
/**
* Get the locale of a given translator.
*
* If null or omitted, current local translator is used.
* If no local translator is in use, current global translator is used.
*
* @param null $translator
*
* @return string|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:719
⧉protected resolveCarbon($date = null): static Return the Carbon instance passed through, a now instance in the same timezon...
/**
* Return the Carbon instance passed through, a now instance in the same timezone
* if null given or parse the input if string given.
*
* @param Carbon|DateTimeInterface|string|null $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:747
⧉protected resolveUTC($date = null): self Return the Carbon instance passed through, a now instance in UTC if null give...
/**
* Return the Carbon instance passed through, a now instance in UTC
* if null given or parse the input if string given (using current timezone
* then switching to UTC).
*
* @param Carbon|DateTimeInterface|string|null $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:771
/**
* Create a Carbon instance from a timestamp and set the timezone (use default one if not specified).
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $timestamp
* @param \DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:29
⇄⧉public static resetToStringFormat(): void Reset the format used to the default when type juggling a Carbon instance to ...
\Carbon\Carbon::resetToStringFormat()
/**
* Reset the format used to the default when type juggling a Carbon instance to a string
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/ToStringFormat.php:35
⇄⧉public static getMidDayAt(): int get midday/noon hour
\Carbon\Carbon::getMidDayAt()
/**
* get midday/noon hour
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:36
⇄⧉public static isImmutable(): bool Returns true if the current class/instance is immutable.
\Carbon\Carbon::isImmutable()
/**
* Returns true if the current class/instance is immutable.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mutability.php:41
⇄⧉public static createFromTimestampUTC($timestamp): static Create a Carbon instance from an timestamp keeping the timezone to UTC.
/**
* Create a Carbon instance from an timestamp keeping the timezone to UTC.
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $timestamp
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:43
⇄⧉public static setToStringFormat($format): void
\Carbon\Carbon::setToStringFormat($format)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather let Carbon object being cast to string with DEFAULT_TO_STRING_FORMAT, and
* use other method or custom format passed to format() method if you need to dump another string
* format.
*
* Set the default format used when type juggling a Carbon instance to a string.
*
* @param string|Closure|null $format
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/ToStringFormat.php:52
⇄⧉public static setMidDayAt($hour): void
\Carbon\Carbon::setMidDayAt($hour)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather consider mid-day is always 12pm, then if you need to test if it's an other
* hour, test it explicitly:
* $date->format('G') == 13
* or to set explicitly to a given hour:
* $date->setTime(13, 0, 0, 0)
*
* Set midday/noon hour
*
* @param int $hour midday hour
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Modifiers.php:55
⇄⧉public static macro($name, $macro): void Register a custom macro.
/**
* Create a Carbon instance from a timestamp in milliseconds.
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $timestamp
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:63
⇄⧉public static setTestNow($testNow = null) Set a Carbon instance (real or mock) to be returned when a "now" instance is ...
\Carbon\Carbon::setTestNow($testNow = null)
/**
* Set a Carbon instance (real or mock) to be returned when a "now"
* instance is created. The provided instance will be returned
* specifically under the following conditions:
* - A call to the static now() method, ex. Carbon::now()
* - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
* - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
* - When a string containing the desired time is passed to Carbon::parse().
*
* Note the timezone parameter was left out of the examples above and
* has no affect as the mock value will be returned regardless of its value.
*
* Only the moment is mocked with setTestNow(), the timezone will still be the one passed
* as parameter of date_default_timezone_get() as a fallback (see setTestNowAndTimezone()).
*
* To clear the test instance call this method using the default
* parameter of null.
*
* /!\ Use this method for unit tests only.
*
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:64
⇄⧉public static resetMacros() Remove all macros and generic macros.
\Carbon\Carbon::resetMacros()
/**
* Remove all macros and generic macros.
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:65
⇄⧉public static mixin($mixin): void Mix another object into the class.
\Carbon\Carbon::mixin($mixin)
/**
* Mix another object into the class.
*
* @example
* ```
* Carbon::mixin(new class {
* public function addMoon() {
* return function () {
* return $this->addDays(30);
* };
* }
* public function subMoon() {
* return function () {
* return $this->subDays(30);
* };
* }
* });
* $fullMoon = Carbon::create('2018-12-22');
* $nextFullMoon = $fullMoon->addMoon();
* $blackMoon = Carbon::create('2019-01-06');
* $previousBlackMoon = $blackMoon->subMoon();
* echo "$nextFullMoon\n";
* echo "$previousBlackMoon\n";
* ```
*
* @param object|string $mixin
*
* @throws ReflectionException
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mixin.php:69
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* @see settings
*
* @param int $humanDiffOptions
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:72
⇄⧉public static genericMacro($macro, $priority0): void Register a custom macro.
\Carbon\Carbon::genericMacro($macro, $priority0)
/**
* Register a custom macro.
*
* @param object|callable $macro
* @param int $priority marco with higher priority is tried first
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:79
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* @see settings
*
* @param int $humanDiffOption
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:84
⇄⧉public static fromSerialized($value): static Create an instance from a serialized string.
\Carbon\Carbon::fromSerialized($value)
/**
* Create an instance from a serialized string.
*
* @param string $value
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:87
⇄⧉public static createFromTimestampMs($timestamp, $tz = null): static Create a Carbon instance from a timestamp in milliseconds.
/**
* Create a Carbon instance from a timestamp in milliseconds.
*
* Timestamp input can be given as int, float or a string containing one or more numbers.
*
* @param float|int|string $timestamp
* @param \DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Timestamp.php:88
⇄⧉public static setTestNowAndTimezone($testNow = null, $tz = null) Set a Carbon instance (real or mock) to be returned when a "now" instance is ...
/**
* Set a Carbon instance (real or mock) to be returned when a "now"
* instance is created. The provided instance will be returned
* specifically under the following conditions:
* - A call to the static now() method, ex. Carbon::now()
* - When a null (or blank string) is passed to the constructor or parse(), ex. new Carbon(null)
* - When the string "now" is passed to the constructor or parse(), ex. new Carbon('now')
* - When a string containing the desired time is passed to Carbon::parse().
*
* It will also align default timezone (e.g. call date_default_timezone_set()) with
* the second argument or if null, with the timezone of the given date object.
*
* To clear the test instance call this method using the default
* parameter of null.
*
* /!\ Use this method for unit tests only.
*
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:90
⇄⧉public static hasMacro($name): bool Checks if macro is registered globally.
\Carbon\Carbon::hasMacro($name)
/**
* Checks if macro is registered globally.
*
* @param string $name
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:96
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* @see settings
*
* @param int $humanDiffOption
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:96
⧉public static __set_state($dump): static The __set_state handler.
/**
* The __set_state handler.
*
* @param string|array $dump
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:106
⇄⧉public static getHumanDiffOptions(): int Return default humanDiff() options (merged flags as integer).
\Carbon\Carbon::getHumanDiffOptions()
/**
* Return default humanDiff() options (merged flags as integer).
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:106
⇄⧉public static getMacro($name): callable|null Get the raw callable macro registered globally for a given name.
\Carbon\Carbon::getMacro($name)
/**
* Get the raw callable macro registered globally for a given name.
*
* @param string $name
*
* @return callable|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Macro.php:108
⇄⧉public static getTranslator(): \Symfony\Component\Translation\TranslatorInterface Get the default translator instance in use.
\Carbon\Carbon::getTranslator()
/**
* Get the default translator instance in use.
*
* @return \Symfony\Component\Translation\TranslatorInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:116
⇄⧉public static setTranslator(Symfony\Component\Translation\TranslatorInterface $translator): void Set the default translator instance to use.
/**
* Set the default translator instance to use.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:128
⇄⧉public static withTestNow($testNow, $callback): T Temporarily sets a static date to be used within the callback. Using setTestN...
\Carbon\Carbon::withTestNow($testNow, $callback)
/**
* Temporarily sets a static date to be used within the callback.
* Using setTestNow to set the date, executing the callback, then
* clearing the test instance.
*
* /!\ Use this method for unit tests only.
*
* @template T
*
* @param DateTimeInterface|Closure|static|string|false|null $testNow real or mock Carbon instance
* @param Closure(): T $callback
*
* @return T
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:129
⇄⧉public static instance($date): static Create a Carbon instance from a DateTime one.
\Carbon\Carbon::instance($date)
/**
* Create a Carbon instance from a DateTime one.
*
* @param DateTimeInterface $date
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:143
⇄⧉public static getTestNow(): Closure|static the current instance used for testing Get the Carbon instance (real or mock) to be returned when a "now" instance i...
\Carbon\Carbon::getTestNow()
/**
* Get the Carbon instance (real or mock) to be returned when a "now"
* instance is created.
*
* @return Closure|static the current instance used for testing
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:148
⇄⧉public static isModifiableUnit($unit): bool Returns true if a property can be changed via setter.
\Carbon\Carbon::isModifiableUnit($unit)
/**
* Returns true if a property can be changed via setter.
*
* @param string $unit
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Units.php:152
⇄⧉public static hasTestNow(): bool true if there is a test instance, otherwise false Determine if there is a valid test instance set. A valid test instance is any...
\Carbon\Carbon::hasTestNow()
/**
* Determine if there is a valid test instance set. A valid test instance
* is anything that is not null.
*
* @return bool true if there is a test instance, otherwise false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:159
⇄⧉public static getTranslationMessageWith($translator, string $key, ?string $locale = null, ?string $default = null): string Returns raw translation message for a given key.
/**
* Returns raw translation message for a given key.
*
* @param \Symfony\Component\Translation\TranslatorInterface $translator the translator to use
* @param string $key key to find
* @param string|null $locale current locale used if null
* @param string|null $default default value if translation returns the key
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:177
⇄⧉public static rawParse($time = null, $tz = null): static Create a carbon instance from a string.
/**
* Create a carbon instance from a string.
*
* This is an alias for the constructor that allows better fluent syntax
* as it allows you to do Carbon::parse('Monday next week')->fn() rather
* than (new Carbon('Monday next week'))->fn().
*
* @param string|DateTimeInterface|null $time
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:180
⇄⧉public static getTimeFormatByPrecision($unitPrecision): string Return a format from H:i to H:i:s.u according to given unit precision.
/**
* Return a format from H:i to H:i:s.u according to given unit precision.
*
* @param string $unitPrecision "minute", "second", "millisecond" or "microsecond"
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Converter.php:186
⇄⧉public static parse($time = null, $tz = null): static Create a carbon instance from a string.
\Carbon\Carbon::parse($time = null, $tz = null)
/**
* Create a carbon instance from a string.
*
* This is an alias for the constructor that allows better fluent syntax
* as it allows you to do Carbon::parse('Monday next week')->fn() rather
* than (new Carbon('Monday next week'))->fn().
*
* @param string|DateTimeInterface|null $time
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:219
/**
* Create a carbon instance from a localized string (in French, Japanese, Arabic, etc.).
*
* @param string $time date/time string in the given language (may also contain English).
* @param string|null $locale if locale is null or not specified, current global locale will be
* used instead.
* @param DateTimeZone|string|null $tz optional timezone for the new instance.
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:246
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* @see settings
*
* Enable the strict mode (or disable with passing false).
*
* @param bool $strictModeEnabled
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:246
⇄⧉public static isStrictModeEnabled(): bool Returns true if the strict mode is globally in use, false else. (It can be ov...
\Carbon\Carbon::isStrictModeEnabled()
/**
* Returns true if the strict mode is globally in use, false else.
* (It can be overridden in specific instances.)
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:257
⇄⧉public static now($tz = null): static Get a Carbon instance for the current date and time.
\Carbon\Carbon::now($tz = null)
/**
* Get a Carbon instance for the current date and time.
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:258
⇄⧉public static today($tz = null): static Create a Carbon instance for today.
\Carbon\Carbon::today($tz = null)
/**
* Create a Carbon instance for today.
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:270
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* Or you can use method variants: addMonthsWithOverflow/addMonthsNoOverflow, same variants
* are available for quarters, years, decade, centuries, millennia (singular and plural forms).
* @see settings
*
* Indicates if months should be calculated with overflow.
*
* @param bool $monthsOverflow
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:275
⇄⧉public static serializeUsing($callback): void
\Carbon\Carbon::serializeUsing($callback)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather transform Carbon object before the serialization.
*
* JSON serialize all Carbon instances using the given callback.
*
* @param callable $callback
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Serialization.php:278
⇄⧉public static tomorrow($tz = null): static Create a Carbon instance for tomorrow.
\Carbon\Carbon::tomorrow($tz = null)
/**
* Create a Carbon instance for tomorrow.
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:282
⇄⧉public static resetMonthsOverflow(): void
\Carbon\Carbon::resetMonthsOverflow()
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* Or you can use method variants: addMonthsWithOverflow/addMonthsNoOverflow, same variants
* are available for quarters, years, decade, centuries, millennia (singular and plural forms).
* @see settings
*
* Reset the month overflow behavior.
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:291
⇄⧉public static yesterday($tz = null): static Create a Carbon instance for yesterday.
\Carbon\Carbon::yesterday($tz = null)
/**
* Create a Carbon instance for yesterday.
*
* @param DateTimeZone|string|null $tz
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:294
⇄⧉public static shouldOverflowMonths(): bool Get the month overflow global behavior (can be overridden in specific instanc...
\Carbon\Carbon::shouldOverflowMonths()
/**
* Get the month overflow global behavior (can be overridden in specific instances).
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:301
⇄⧉public static maxValue(): static Create a Carbon instance for the greatest supported date.
\Carbon\Carbon::maxValue()
/**
* Create a Carbon instance for the greatest supported date.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:304
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
* are available for quarters, years, decade, centuries, millennia (singular and plural forms).
* @see settings
*
* Indicates if years should be calculated with overflow.
*
* @param bool $yearsOverflow
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:319
⇄⧉public static minValue(): static Create a Carbon instance for the lowest supported date.
\Carbon\Carbon::minValue()
/**
* Create a Carbon instance for the lowest supported date.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:320
⇄⧉public static translateTimeString($timeString, $from = null, $to = null, $mode = 31): string Translate a time string from a locale to an other.
/**
* Translate a time string from a locale to an other.
*
* @param string $timeString date/time/duration string to translate (may also contain English)
* @param string|null $from input locale of the $timeString parameter (`Carbon::getLocale()` by default)
* @param string|null $to output locale of the result returned (`"en"` by default)
* @param int $mode specify what to translate with options:
* - CarbonInterface::TRANSLATE_ALL (default)
* - CarbonInterface::TRANSLATE_MONTHS
* - CarbonInterface::TRANSLATE_DAYS
* - CarbonInterface::TRANSLATE_UNITS
* - CarbonInterface::TRANSLATE_MERIDIEM
* You can use pipe to group: CarbonInterface::TRANSLATE_MONTHS | CarbonInterface::TRANSLATE_DAYS
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:331
⇄⧉public static resetYearsOverflow(): void
\Carbon\Carbon::resetYearsOverflow()
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use the ->settings() method.
* Or you can use method variants: addYearsWithOverflow/addYearsNoOverflow, same variants
* are available for quarters, years, decade, centuries, millennia (singular and plural forms).
* @see settings
*
* Reset the month overflow behavior.
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:335
⇄⧉public static shouldOverflowYears(): bool Get the month overflow global behavior (can be overridden in specific instanc...
\Carbon\Carbon::shouldOverflowYears()
/**
* Get the month overflow global behavior (can be overridden in specific instances).
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Options.php:345
⇄⧉public static create($year0, $month = 1, $day = 1, $hour0, $minute0, $second0, $tz = null): static|false Create a new Carbon instance from a specific date and time.
/**
* Create a new Carbon instance from a specific date and time.
*
* If any of $year, $month or $day are set to null their now() values will
* be used.
*
* If $hour is null it will be set to its now() value and the default
* values for $minute and $second will be their now() values.
*
* If $hour is not null then the default values for $minute and $second
* will be 0.
*
* @param DateTimeInterface|int|null $year
* @param int|null $month
* @param int|null $day
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:377
⇄⧉public static createSafe($year = null, $month = null, $day = null, $hour = null, $minute = null, $second = null, $tz = null): static|false Create a new safe Carbon instance from a specific date and time.
/**
* Create a new safe Carbon instance from a specific date and time.
*
* If any of $year, $month or $day are set to null their now() values will
* be used.
*
* If $hour is null it will be set to its now() value and the default
* values for $minute and $second will be their now() values.
*
* If $hour is not null then the default values for $minute and $second
* will be 0.
*
* If one of the set values is not valid, an InvalidDateException
* will be thrown.
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @throws InvalidDateException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:461
⇄⧉public static getLocale(): string Get the current translator locale.
\Carbon\Carbon::getLocale()
/**
* Get the current translator locale.
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:479
⇄⧉public static setLocale($locale): bool Set the current translator locale and indicate if the source locale file exis...
\Carbon\Carbon::setLocale($locale)
/**
* Set the current translator locale and indicate if the source locale file exists.
* Pass 'auto' as locale to use closest language from the current LC_TIME locale.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:492
⇄⧉public static setFallbackLocale($locale) Set the fallback locale.
\Carbon\Carbon::setFallbackLocale($locale)
/**
* Set the fallback locale.
*
* @see https://symfony.com/doc/current/components/translation.html#fallback-locales
*
* @param string $locale
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:504
⇄⧉public static createStrict(?int $year0, ?int $month = 1, ?int $day = 1, ?int $hour0, ?int $minute0, ?int $second0, $tz = null): self Create a new Carbon instance from a specific date and time using strict valid...
/**
* Create a new Carbon instance from a specific date and time using strict validation.
*
* @see create()
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:507
⇄⧉public static isMutable(): bool Returns true if the current class/instance is mutable.
\Carbon\Carbon::isMutable()
/**
* Returns true if the current class/instance is mutable.
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Carbon.php:519
⇄⧉public static getFallbackLocale(): string|null Get the fallback locale.
\Carbon\Carbon::getFallbackLocale()
/**
* Get the fallback locale.
*
* @see https://symfony.com/doc/current/components/translation.html#fallback-locales
*
* @return string|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:529
⇄⧉public static createFromDate($year = null, $month = null, $day = null, $tz = null): static Create a Carbon instance from just a date. The time portion is set to now.
/**
* Create a Carbon instance from just a date. The time portion is set to now.
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:533
⇄⧉public static executeWithLocale($locale, $func): mixed Set the current locale to the given, execute the passed function, reset the l...
\Carbon\Carbon::executeWithLocale($locale, $func)
/**
* Set the current locale to the given, execute the passed function, reset the locale to previous one,
* then return the result of the closure (or null if the closure was void).
*
* @param string $locale locale ex. en
* @param callable $func
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:549
⇄⧉public static createMidnightDate($year = null, $month = null, $day = null, $tz = null): static Create a Carbon instance from just a date. The time portion is set to midnight.
/**
* Create a Carbon instance from just a date. The time portion is set to midnight.
*
* @param int|null $year
* @param int|null $month
* @param int|null $day
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:550
⇄⧉public static localeHasShortUnits($locale): bool Returns true if the given locale is internally supported and has short-units ...
\Carbon\Carbon::localeHasShortUnits($locale)
/**
* Returns true if the given locale is internally supported and has short-units support.
* Support is considered enabled if either year, day or hour has a short variant translated.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:566
⇄⧉public static createFromTime($hour0, $minute0, $second0, $tz = null): static Create a Carbon instance from just a time. The date portion is set to today.
/**
* Create a Carbon instance from just a time. The date portion is set to today.
*
* @param int|null $hour
* @param int|null $minute
* @param int|null $second
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:567
⇄⧉public static createFromTimeString($time, $tz = null): static Create a Carbon instance from a time string. The date portion is set to today.
/**
* Create a Carbon instance from a time string. The date portion is set to today.
*
* @param string $time
* @param DateTimeZone|string|null $tz
*
* @throws InvalidFormatException
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:582
⇄⧉public static localeHasDiffSyntax($locale): bool Returns true if the given locale is internally supported and has diff syntax ...
\Carbon\Carbon::localeHasDiffSyntax($locale)
/**
* Returns true if the given locale is internally supported and has diff syntax support (ago, from now, before, after).
* Support is considered enabled if the 4 sentences are translated in the given locale.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:587
⇄⧉public static localeHasDiffOneDayWords($locale): bool Returns true if the given locale is internally supported and has words for 1-...
\Carbon\Carbon::localeHasDiffOneDayWords($locale)
/**
* Returns true if the given locale is internally supported and has words for 1-day diff (just now, yesterday, tomorrow).
* Support is considered enabled if the 3 words are translated in the given locale.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:618
⇄⧉public static rawCreateFromFormat($format, $time, $tz = null): static|false Create a Carbon instance from a specific format.
/**
* Create a Carbon instance from a specific format.
*
* @param string $format Datetime format
* @param string $time
* @param DateTimeZone|string|false|null $tz
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:631
⇄⧉public static localeHasDiffTwoDayWords($locale): bool Returns true if the given locale is internally supported and has words for 2-...
\Carbon\Carbon::localeHasDiffTwoDayWords($locale)
/**
* Returns true if the given locale is internally supported and has words for 2-days diff (before yesterday, after tomorrow).
* Support is considered enabled if the 2 words are translated in the given locale.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:636
⇄⧉public static localeHasPeriodSyntax($locale): bool Returns true if the given locale is internally supported and has period synta...
\Carbon\Carbon::localeHasPeriodSyntax($locale)
/**
* Returns true if the given locale is internally supported and has period syntax support (X times, every X, from X, to X).
* Support is considered enabled if the 4 sentences are translated in the given locale.
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:653
⇄⧉public static getAvailableLocales(): array Returns the list of internally available locales and already loaded custom lo...
\Carbon\Carbon::getAvailableLocales()
/**
* Returns the list of internally available locales and already loaded custom locales.
* (It will ignore custom translator dynamic loading.)
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:670
⇄⧉public static getAvailableLocalesInfo(): Language[] Returns list of Language object for each available locale. This object allow ...
\Carbon\Carbon::getAvailableLocalesInfo()
/**
* Returns list of Language object for each available locale. This object allow you to get the ISO name, native
* name, region and variant of the locale.
*
* @return Language[]
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:685
⇄⧉public static createFromFormat($format, $time, $tz = null): static|false Create a Carbon instance from a specific format.
/**
* Create a Carbon instance from a specific format.
*
* @param string $format Datetime format
* @param string $time
* @param DateTimeZone|string|false|null $tz
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:708
⇄⧉public static createFromIsoFormat($format, $time, $tz = null, $locale = 'en', $translator = null): static|false Create a Carbon instance from a specific ISO format (same replacements as ->i...
/**
* Create a Carbon instance from a specific ISO format (same replacements as ->isoFormat()).
*
* @param string $format Datetime format
* @param string $time
* @param DateTimeZone|string|false|null $tz optional timezone
* @param string|null $locale locale to be used for LTS, LT, LL, LLL, etc. macro-formats (en by fault, unneeded if no such macro-format in use)
* @param \Symfony\Component\Translation\TranslatorInterface $translator optional custom translator to use for macro-formats
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:736
⇄⧉public static createFromLocaleFormat($format, $locale, $time, $tz = null): static|false Create a Carbon instance from a specific format and a string in a given langu...
/**
* Create a Carbon instance from a specific format and a string in a given language.
*
* @param string $format Datetime format
* @param string $locale
* @param string $time
* @param DateTimeZone|string|false|null $tz
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:877
⇄⧉public static hasFormat($date, $format): bool Checks if the (date)time string is in a given format.
\Carbon\Carbon::hasFormat($date, $format)
/**
* Checks if the (date)time string is in a given format.
*
* @example
* ```
* Carbon::hasFormat('11:12:45', 'h:i:s'); // true
* Carbon::hasFormat('13:12:45', 'h:i:s'); // false
* ```
*
* @param string $date
* @param string $format
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:907
⇄⧉public static createFromLocaleIsoFormat($format, $locale, $time, $tz = null): static|false Create a Carbon instance from a specific ISO format and a string in a given l...
/**
* Create a Carbon instance from a specific ISO format and a string in a given language.
*
* @param string $format Datetime ISO format
* @param string $locale
* @param string $time
* @param DateTimeZone|string|false|null $tz
*
* @throws InvalidFormatException
*
* @return static|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:907
⇄⧉public static make($var): static|null Make a Carbon instance from given variable if possible.
\Carbon\Carbon::make($var)
/**
* Make a Carbon instance from given variable if possible.
*
* Always return a new instance. Parse only strings and only these likely to be dates (skip intervals
* and recurrences). Throw an exception for invalid format, but otherwise return null.
*
* @param mixed $var
*
* @throws InvalidFormatException
*
* @return static|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:926
⇄⧉public static hasFormatWithModifiers($date, $format): bool Checks if the (date)time string is in a given format.
/**
* Checks if the (date)time string is in a given format and valid to create a
* new instance.
*
* @example
* ```
* Carbon::canBeCreatedFromFormat('11:12:45', 'h:i:s'); // true
* Carbon::canBeCreatedFromFormat('13:12:45', 'h:i:s'); // false
* ```
*
* @param string $date
* @param string $format
*
* @return bool
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Comparison.php:950
/**
* {@inheritdoc}
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Creator.php:973
⇄⧉public static getDays(): array Get the days of the week
\Carbon\Carbon::getDays()
/**
* Get the days of the week
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1713
⇄⧉public static getWeekStartsAt(): int Get the first day of week
\Carbon\Carbon::getWeekStartsAt()
/**
* Get the first day of week
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1735
⇄⧉public static setWeekStartsAt($day): void
\Carbon\Carbon::setWeekStartsAt($day)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* Use $weekEndsAt optional parameter instead when using endOfWeek method. You can also use the
* 'first_day_of_week' locale setting to change the start of week according to current locale
* selected and implicitly the end of week.
*
* Set the first day of week
*
* @param int|string $day week start day (or 'auto' to get the first day of week from Carbon::getLocale() culture).
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1756
⇄⧉public static getWeekEndsAt(): int Get the last day of week
\Carbon\Carbon::getWeekEndsAt()
/**
* Get the last day of week
*
* @return int
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1766
⇄⧉public static setWeekEndsAt($day): void
\Carbon\Carbon::setWeekEndsAt($day)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* Use $weekStartsAt optional parameter instead when using startOfWeek, floorWeek, ceilWeek
* or roundWeek method. You can also use the 'first_day_of_week' locale setting to change the
* start of week according to current locale selected and implicitly the end of week.
*
* Set the last day of week
*
* @param int|string $day week end day (or 'auto' to get the day before the first day of week
* from Carbon::getLocale() culture).
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1788
⇄⧉public static getWeekendDays(): array Get weekend days
\Carbon\Carbon::getWeekendDays()
/**
* Get weekend days
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1798
⇄⧉public static setWeekendDays($days): void
\Carbon\Carbon::setWeekendDays($days)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather consider week-end is always saturday and sunday, and if you have some custom
* week-end days to handle, give to those days an other name and create a macro for them:
*
* ```
* Carbon::macro('isDayOff', function ($date) {
* return $date->isSunday() || $date->isMonday();
* });
* Carbon::macro('isNotDayOff', function ($date) {
* return !$date->isDayOff();
* });
* if ($someDate->isDayOff()) ...
* if ($someDate->isNotDayOff()) ...
* // Add 5 not-off days
* $count = 5;
* while ($someDate->isDayOff() || ($count-- > 0)) {
* $someDate->addDay();
* }
* ```
*
* Set weekend days
*
* @param array $days
*
* @return void
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1830
⇄⧉public static hasRelativeKeywords($time): bool true if time match a relative date, false if absolute or invalid time string Determine if a time string will produce a relative date.
\Carbon\Carbon::hasRelativeKeywords($time)
/**
* Determine if a time string will produce a relative date.
*
* @param string $time
*
* @return bool true if time match a relative date, false if absolute or invalid time string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1842
⇄⧉public static setUtf8($utf8)
\Carbon\Carbon::setUtf8($utf8)
/**
* @deprecated To avoid conflict between different third-party libraries, static setters should not be used.
* You should rather use UTF-8 language packages on every machine.
*
* Set if UTF8 will be used for localized date/time.
*
* @param bool $utf8
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1868
⇄⧉public static getIsoUnits(): array Returns list of locale units for ISO formatting.
\Carbon\Carbon::getIsoUnits()
/**
* Returns list of locale units for ISO formatting.
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:1953
⇄⧉public static getFormatsToIsoReplacements(): array List of replacements from date() format to isoFormat().
\Carbon\Carbon::getFormatsToIsoReplacements()
/**
* List of replacements from date() format to isoFormat().
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2266
⇄⧉public static singularUnit(string $unit): string Returns standardized singular of a given singular/plural unit name (in English).
\Carbon\Carbon::singularUnit(string $unit)
/**
* Returns standardized singular of a given singular/plural unit name (in English).
*
* @param string $unit
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2503
⇄⧉public static pluralUnit(string $unit): string Returns standardized plural of a given singular/plural unit name (in English).
\Carbon\Carbon::pluralUnit(string $unit)
/**
* Returns standardized plural of a given singular/plural unit name (in English).
*
* @param string $unit
*
* @return string
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:2525
/**
* @codeCoverageIgnore
*
* @param CarbonInterval $diff
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:42
/**
* @param DateInterval $diff
* @param bool $absolute
*
* @return CarbonInterval
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Difference.php:86
⧉protected static getMockedTestNow($tz): \Carbon\CarbonImmutable|\Carbon\Carbon|null Get the mocked date passed in setTestNow() and if it's a Closure, execute it.
/**
* Get the mocked date passed in setTestNow() and if it's a Closure, execute it.
*
* @param string|\DateTimeZone $tz
*
* @return \Carbon\CarbonImmutable|\Carbon\Carbon|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:171
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Test.php:189
⧉protected static bindMacroContext($context, callable $callable): mixed Stack a Carbon context from inside calls of self::this() and execute a given ...
/**
* Stack a Carbon context from inside calls of self::this() and execute a given action.
*
* @param static|null $context
* @param callable $callable
*
* @throws Throwable
*
* @return mixed
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mixin.php:196
⧉protected static context(): static|null Return the current context from inside a macro callee or a null if static.
/**
* Return the current context from inside a macro callee or a null if static.
*
* @return static|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mixin.php:212
⧉protected static this(): static Return the current context from inside a macro callee or a new one if static.
/**
* Return the current context from inside a macro callee or a new one if static.
*
* @return static
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Mixin.php:222
⧉protected static safeCreateDateTimeZone($object, $objectDump = null): CarbonTimeZone|false Creates a DateTimeZone from a string, DateTimeZone or integer offset.
/**
* Creates a DateTimeZone from a string, DateTimeZone or integer offset.
*
* @param DateTimeZone|string|int|null $object original value to get CarbonTimeZone from it.
* @param DateTimeZone|string|int|null $objectDump dump of the object for error messages.
*
* @throws InvalidTimeZoneException
*
* @return CarbonTimeZone|false
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:624
⧉protected static getRangesByUnit(int $daysInMonth = 31): array List of minimum and maximums for each unit.
/**
* List of minimum and maximums for each unit.
*
* @param int $daysInMonth
*
* @return array
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:649
⧉protected static translator(): \Symfony\Component\Translation\TranslatorInterface Initialize the default translator instance if necessary.
/**
* Initialize the default translator instance if necessary.
*
* @return \Symfony\Component\Translation\TranslatorInterface
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:700
⧉protected static expectDateTime($date, $other = array()) Throws an exception if the given object is not a DateTime and does not implem...
/**
* Throws an exception if the given object is not a DateTime and does not implement DateTimeInterface.
*
* @param mixed $date
* @param string|array $other
*
* @throws InvalidTypeException
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Date.php:724
⧉protected static getLocaleAwareTranslator($translator = null): LocaleAwareInterface|null Throw an error if passed object is not LocaleAwareInterface.
/**
* Throw an error if passed object is not LocaleAwareInterface.
*
* @param LocaleAwareInterface|null $translator
*
* @return LocaleAwareInterface|null
*/
Inherited from Carbon\Carbon
Defined in .../nesbot/carbon/src/Carbon/Traits/Localization.php:737
Defined in .../symfony/translation-contracts/TranslatorTrait.php:38
⧉private getPluralizationRule(float $number, string $locale): int Returns the plural position to use for the given locale and number.
/**
* Returns the plural position to use for the given locale and number.
*
* The plural rules are derived from code of the Zend Framework (2010-09-25),
* which is subject to the new BSD license (http://framework.zend.com/license/new-bsd).
* Copyright (c) 2005-2010 Zend Technologies USA Inc. (http://www.zend.com)
*/
Defined in .../symfony/translation-contracts/TranslatorTrait.php:133
/**
* @param TranslatorInterface|null $translator An identity translator to use as selector for pluralization
*/
Defined in .../symfony/translation/Formatter/MessageFormatter.php:31
Inherited from Carbon\MessageFormatter\LazyMessageFormatter
Defined in .../nesbot/carbon/lazy/Carbon/MessageFormatter/MessageFormatterMapperStrongType.php:19
Defined in .../symfony/translation/Loader/ArrayLoader.php:23
⧉private flatten(array $messages): array Flattens an nested array of translations.
/**
* Flattens an nested array of translations.
*
* The scheme used is:
* 'key' => ['key2' => ['key3' => 'value']]
* Becomes:
* 'key.key2.key3' => 'value'
*/
Defined in .../symfony/translation/Loader/ArrayLoader.php:40
private locale -> string (5) "id_ID"
⧉private parentLocales -> array (140)
az_Cyrl => string (4) "root"
bs_Cyrl => string (4) "root"
en_150 => string (6) "en_001"
en_AG => string (6) "en_001"
en_AI => string (6) "en_001"
en_AT => string (6) "en_150"
en_AU => string (6) "en_001"
en_BB => string (6) "en_001"
en_BE => string (6) "en_150"
en_BM => string (6) "en_001"
en_BS => string (6) "en_001"
en_BW => string (6) "en_001"
en_BZ => string (6) "en_001"
en_CC => string (6) "en_001"
en_CH => string (6) "en_150"
en_CK => string (6) "en_001"
en_CM => string (6) "en_001"
en_CX => string (6) "en_001"
en_CY => string (6) "en_001"
en_DE => string (6) "en_150"
en_DG => string (6) "en_001"
en_DK => string (6) "en_150"
en_DM => string (6) "en_001"
en_ER => string (6) "en_001"
en_FI => string (6) "en_150"
en_FJ => string (6) "en_001"
en_FK => string (6) "en_001"
en_FM => string (6) "en_001"
en_GB => string (6) "en_001"
en_GD => string (6) "en_001"
en_GG => string (6) "en_001"
en_GH => string (6) "en_001"
en_GI => string (6) "en_001"
en_GM => string (6) "en_001"
en_GY => string (6) "en_001"
en_HK => string (6) "en_001"
en_ID => string (6) "en_001"
en_IE => string (6) "en_001"
en_IL => string (6) "en_001"
en_IM => string (6) "en_001"
en_IN => string (6) "en_001"
en_IO => string (6) "en_001"
en_JE => string (6) "en_001"
en_JM => string (6) "en_001"
en_KE => string (6) "en_001"
en_KI => string (6) "en_001"
en_KN => string (6) "en_001"
en_KY => string (6) "en_001"
en_LC => string (6) "en_001"
en_LR => string (6) "en_001"
en_LS => string (6) "en_001"
en_MG => string (6) "en_001"
en_MO => string (6) "en_001"
en_MS => string (6) "en_001"
en_MT => string (6) "en_001"
en_MU => string (6) "en_001"
en_MV => string (6) "en_001"
en_MW => string (6) "en_001"
en_MY => string (6) "en_001"
en_NA => string (6) "en_001"
en_NF => string (6) "en_001"
en_NG => string (6) "en_001"
en_NL => string (6) "en_150"
en_NR => string (6) "en_001"
en_NU => string (6) "en_001"
en_NZ => string (6) "en_001"
en_PG => string (6) "en_001"
en_PK => string (6) "en_001"
en_PN => string (6) "en_001"
en_PW => string (6) "en_001"
en_RW => string (6) "en_001"
en_SB => string (6) "en_001"
en_SC => string (6) "en_001"
en_SD => string (6) "en_001"
en_SE => string (6) "en_150"
en_SG => string (6) "en_001"
en_SH => string (6) "en_001"
en_SI => string (6) "en_150"
en_SL => string (6) "en_001"
en_SS => string (6) "en_001"
en_SX => string (6) "en_001"
en_SZ => string (6) "en_001"
en_TC => string (6) "en_001"
en_TK => string (6) "en_001"
en_TO => string (6) "en_001"
en_TT => string (6) "en_001"
en_TV => string (6) "en_001"
en_TZ => string (6) "en_001"
en_UG => string (6) "en_001"
en_VC => string (6) "en_001"
en_VG => string (6) "en_001"
en_VU => string (6) "en_001"
en_WS => string (6) "en_001"
en_ZA => string (6) "en_001"
en_ZM => string (6) "en_001"
en_ZW => string (6) "en_001"
es_AR => string (6) "es_419"
es_BO => string (6) "es_419"
es_BR => string (6) "es_419"
es_BZ => string (6) "es_419"
es_CL => string (6) "es_419"
es_CO => string (6) "es_419"
es_CR => string (6) "es_419"
es_CU => string (6) "es_419"
es_DO => string (6) "es_419"
es_EC => string (6) "es_419"
es_GT => string (6) "es_419"
es_HN => string (6) "es_419"
es_MX => string (6) "es_419"
es_NI => string (6) "es_419"
es_PA => string (6) "es_419"
es_PE => string (6) "es_419"
es_PR => string (6) "es_419"
es_PY => string (6) "es_419"
es_SV => string (6) "es_419"
es_US => string (6) "es_419"
es_UY => string (6) "es_419"
es_VE => string (6) "es_419"
ff_Adlm => string (4) "root"
hi_Latn => string (5) "en_IN"
ks_Deva => string (4) "root"
nb => string (2) "no"
nn => string (2) "no"
pa_Arab => string (4) "root"
pt_AO => string (5) "pt_PT"
pt_CH => string (5) "pt_PT"
pt_CV => string (5) "pt_PT"
pt_GQ => string (5) "pt_PT"
pt_GW => string (5) "pt_PT"
pt_LU => string (5) "pt_PT"
pt_MO => string (5) "pt_PT"
pt_MZ => string (5) "pt_PT"
pt_ST => string (5) "pt_PT"
pt_TL => string (5) "pt_PT"
sd_Deva => string (4) "root"
sr_Latn => string (4) "root"
uz_Arab => string (4) "root"
uz_Cyrl => string (4) "root"
zh_Hant => string (4) "root"
zh_Hant_MO => string (10) "zh_Hant_HK"
⧉private resources -> array (3)
⧉en => array (1)
⧉0 => array (3)
0 => string (5) "array"
⧉1 => array (50)
year => string (50) "{1}:count year|{0}:count years|]1,Inf[:count years"
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:81
⧉public getDirectories(): array Returns the list of directories translation files are searched in.
/**
* Returns the list of directories translation files are searched in.
*
* @return array
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:96
⧉public setDirectories(array $directories): $this Set list of directories translation files are searched in.
/**
* Set list of directories translation files are searched in.
*
* @param array $directories new directories list
*
* @return $this
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:108
⧉public addDirectory(string $directory): $this Add a directory to the list translation files are searched in.
/**
* Add a directory to the list translation files are searched in.
*
* @param string $directory new directory
*
* @return $this
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:122
⧉public removeDirectory(string $directory): $this Remove a directory from the list translation files are searched in.
/**
* Remove a directory from the list translation files are searched in.
*
* @param string $directory directory path
*
* @return $this
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:136
⧉public resetMessages($locale = null): bool Reset messages of a locale (all locale if no locale passed). Remove custom me...
/**
* Reset messages of a locale (all locale if no locale passed).
* Remove custom messages and reload initial messages from matching
* file in Lang directory.
*
* @param string|null $locale
*
* @return bool
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:154
⧉public getLocalesFiles($prefix = ''): array Returns the list of files matching a given locale prefix (or all if empty).
/**
* Returns the list of files matching a given locale prefix (or all if empty).
*
* @param string $prefix prefix required to filter result
*
* @return array
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:183
⧉public getAvailableLocales($prefix = ''): array Returns the list of internally available locales and already loaded custom lo...
/**
* Returns the list of internally available locales and already loaded custom locales.
* (It will ignore custom translator dynamic loading.)
*
* @param string $prefix prefix required to filter result
*
* @return array
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:206
⧉public setMessages($locale, $messages): $this Set messages of a locale and take file first if present.
/**
* Set messages of a locale and take file first if present.
*
* @param string $locale
* @param array $messages
*
* @return $this
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:265
⧉public setTranslations($messages): $this Set messages of the current locale and take file first if present.
/**
* Set messages of the current locale and take file first if present.
*
* @param array $messages
*
* @return $this
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:284
⧉public getMessages($locale = null): array Get messages of a locale, if none given, return all the languages.
/**
* Get messages of a locale, if none given, return all the
* languages.
*
* @param string|null $locale
*
* @return array
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:297
⧉public setLocale($locale): bool Set the current translator locale and indicate if the source locale file exists
/**
* Set the current translator locale and indicate if the source locale file exists
*
* @param string $locale locale ex. en
*
* @return bool
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:309
⧉public __debugInfo(): array Show locale on var_dump().
/**
* Show locale on var_dump().
*
* @return array
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:373
/**
* @return void
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:86
⧉public addLoader(string $format, Symfony\Component\Translation\Loader\LoaderInterface $loader): void Adds a Loader.
/**
* Adds a Loader.
*
* @param string $format The name of the loader (@see addResource())
*
* @return void
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:98
/**
* Adds a Resource.
*
* @param string $format The name of the loader (@see addLoader())
* @param mixed $resource The resource name
*
* @return void
*
* @throws InvalidArgumentException If the locale contains invalid characters
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:113
⧉public getLocale(): string
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:138
⧉public setFallbackLocales(array $locales): void Sets the fallback locales.
/**
* Sets the fallback locales.
*
* @param string[] $locales
*
* @return void
*
* @throws InvalidArgumentException If a locale contains invalid characters
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:152
⧉public getFallbackLocales(): array Gets the fallback locales.
/**
* Gets the fallback locales.
*
* @internal
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:169
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:216
⧉protected loadMessagesFromFile($locale): bool Init messages language from matching file in Lang directory.
/**
* Init messages language from matching file in Lang directory.
*
* @param string $locale
*
* @return bool
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:252
⧉protected getLoaders(): array Gets the loaders.
/**
* Gets the loaders.
*
* @return LoaderInterface[]
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:231
⧉protected loadCatalogue(string $locale): void
/**
* @return void
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:239
/**
* @return array
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:390
⧉protected assertValidLocale(string $locale): void Asserts that the locale is valid, throws an Exception if not.
/**
* Asserts that the locale is valid, throws an Exception if not.
*
* @return void
*
* @throws InvalidArgumentException If the locale contains invalid characters
*/
Inherited from Symfony\Component\Translation\Translator
Defined in .../symfony/translation/Translator.php:438
⇄⧉public static get($locale = null): static Return a singleton instance of Translator.
\Carbon\AbstractTranslator::get($locale = null)
/**
* Return a singleton instance of Translator.
*
* @param string|null $locale optional initial locale ("en" - english by default)
*
* @return static
*/
Inherited from Carbon\AbstractTranslator
Defined in .../nesbot/carbon/src/Carbon/AbstractTranslator.php:69
{"description":"Ustaz Habib Abdul Hakim jadi korban penganiayaan saat mediasi warga di Bekasi, kasus kini diproses Polsek Tarumajaya","images":[],"keywords":["Ustaz Habib Abdul Hakim dianiaya di Bekasi","Mediasi warga berujung penganiayaan di Perumahan Harapan Mulya","Ketua RT dan RW aniaya warga di Tarumajaya","Laporan penganiayaan di Polsek Tarumajaya nomor STPL No. 52\/V\/2025\/Sek.Tj","Sanksi hukum penganiayaan berdasarkan Pasal 351 KUHP"],"sources":[]}
{"description":"Wakil Presiden Gibran Rakabuming Raka mengumumkan rencana integrasi mata pelajaran AI ke kurikulum pendidikan dasar dan menengah.","images":[],"keywords":["Integrasi Artificial Intelligence dalam kurikulum sekolah Indonesia","Kebijakan pemerintah tentang pembelajaran AI di SD, SMP, SMA\/SMK","Peran Gibran Rakabuming Raka dalam pengembangan pendidikan teknologi","Persiapan generasi muda Indonesia menghadapi era digital dengan AI","Dampak penerapan AI dalam kurikulum pendidikan Indonesia"],"sources":[]}
{"description":"Letjen TNI Kunto Arief Wibowo - putra Wakil Presiden ke-6 RI Try Sutrisno- batal dimutasi menjadi Staf Khusus Kepala Staf TNI AD (KSAD).","images":[],"keywords":["Batalnya mutasi Letjen Kunto Arief Wibowo","Alasan pembatalan mutasi perwira tinggi TNI","Surat Keputusan Panglima TNI Nomor Kep\/554.a\/IV\/2025","Hubungan mutasi TNI dengan Wakil Presiden ke-6","Kebijakan mutasi dan rotasi di lingkungan TNI AD"],"sources":[]}
{"description":"Gubernur Jawa Barat, Dedi Mulyadi berencana membuat program keluarga berencana (KB) sebagai syarat penerima bantuan sosial dari pemerintah.","images":[],"keywords":["Vasektomi sebagai syarat penerima bansos","Hukum vasektomi menurut MUI","Fatwa MUI tentang vasektomi","Program KB pria di Jawa Barat","Dampak vasektomi bagi penerima bantuan sosial"],"sources":[]}
{"description":"Yayasan Media Berkat Nusantara (MBN), yang jadi mitra resmi Program Makan Bergizi Gratis (MBG),","images":[],"keywords":["klarifikasi penggelapan dana yayasan MBN program MBG","tuduhan penggelapan dana dapur mitra MBG Kalibata","pemeriksaan Ira Mesra Destiawati kasus penggelapan dana","investigasi penggelapan dana program makan bergizi gratis Jakarta Selatan","bantahan yayasan MBN terkait tudingan penggelapan dana MBG"],"sources":[]}
{"description":"Roy Suryo dilaporkan menyebut ijazah milik Jokowi palsu","images":[],"keywords":["pemanggilan saksi kasus ijazah palsu Jokowi","proses hukum laporan ijazah palsu Jokowi","pernyataan Roy Suryo soal ijazah Jokowi","bukti ijazah asli Jokowi","digital forensik ijazah Jokowi"],"sources":[]}
Pertemuan Prabowo Subianto dengan Pangeran Muhammad Bin Salman terkait biaya haji
⇄sources => array (0)
json_decode($value[1]['attr'], true)['sources']
{"description":"Ia mengatakan jika bisa biaya haji Indonesia lebih murah dari Malaysia.","images":[],"keywords":["Menurunkan biaya haji Indonesia lebih murah dari Malaysia","Upaya pemerintah menurunkan biaya haji 2025","Permintaan Prabowo Subianto penurunan biaya haji","Jumlah jemaah haji Indonesia terbesar di dunia","Pertemuan Prabowo Subianto dengan Pangeran Muhammad Bin Salman terkait biaya haji"],"sources":[]}
{"description":"Presiden Prabowo bersama sejumlah pejabat dan perwakilan dari Arab Saudi meneken tombol sirine","images":[],"keywords":["Peresmian terminal khusus haji dan umrah di Bandara Soekarno Hatta","Fasilitas Makkah Route di Terminal 2F Bandara Soetta","Presiden Prabowo resmikan terminal haji umrah Bandara Soekarno Hatta","Keuntungan Makkah Route untuk jamaah haji Indonesia","Proses imigrasi Arab Saudi di Terminal Haji Umrah Soekarno Hatta"],"sources":[]}
{"description":"Undangan itu disampaikan langsung oleh Presiden Prabowo saat keduanya berbincang-bincang melalui sambungan telepon","images":[],"keywords":["kunjungan Anwar Ibrahim ke Jakarta","kerjasama Indonesia Malaysia","hubungan bilateral Indonesia Malaysia","persiapan KTT ASEAN 2025 Kuala Lumpur","pembahasan tarif impor resiprokal AS di ASEAN"],"sources":[]}
{"description":"basisnya adalah data tunggal sosial ekonomi nasional, setelah itu dicek ke lapangan ramai-ramai, tidak sendiri.","images":[],"keywords":["pencegahan KKN penerimaan siswa Sekolah Rakyat","peran masyarakat dalam pengawasan Sekolah Rakyat","kriteria penerimaan siswa miskin ekstrem Sekolah Rakyat","sosialisasi Sekolah Rakyat di Temanggung","data tunggal sosial ekonomi penerimaan Sekolah Rakyat"],"sources":[]}
{"description":"Hal ini ia sampaikan dalam pidato peringatan Hari Pendidikan Nasional 2025 di SDN Cimahpar 5, Bogor, Kamis (2\/5).","images":[],"keywords":["dampak program makan bergizi gratis terhadap ekonomi","program makan bergizi gratis untuk meningkatkan kualitas pendidikan","pidato Prabowo Subianto tentang program MBG","strategi peningkatan ekonomi melalui program makan bergizi gratis","sasaran penerima manfaat program makan bergizi gratis 2025"],"sources":[]}
Menteri Kependudukan dan Pembangunan Keluarga/Badan Kependudukan dan Keluarga Berencana Nasional (BKKBN) Wihaji meninjau Sentra Pelayanan Program Gizi (SPPG).
⇄images => array (0)
json_decode($value[0]['attr'], true)['images']
⇄⧉keywords => array (5)
json_decode($value[0]['attr'], true)['keywords']
⇄0 => string (46) "Program makanan bergizi gratis untuk ibu hamil"
{"description":"Menteri Kependudukan dan Pembangunan Keluarga\/Badan Kependudukan dan Keluarga Berencana Nasional (BKKBN) Wihaji meninjau Sentra Pelayanan Program Gizi (SPPG).","images":[],"keywords":["Program makanan bergizi gratis untuk ibu hamil","Penanganan stunting di Kabupaten Tangerang","Pelayanan KB serentak di Indonesia","Peran BKKBN dalam menekan angka stunting","Manfaat makanan bergizi bagi ibu menyusui dan balita"],"sources":[]}
⇄⧉desc => string (158) "Menteri Kependudukan dan Pembangunan Keluarga/Badan Kependudukan dan Keluarg...
$value[0]['desc']
Menteri Kependudukan dan Pembangunan Keluarga/Badan Kependudukan dan Keluarga Berencana Nasional (BKKBN) Wihaji meninjau Sentra Pelayanan Program Gizi (SPPG).
⇄port => string (8) "https://"
$value[0]['port']
⇄site => string (9) "fin.co.id"
$value[0]['site']
⇄⧉1 => array (14)
$value[1]
⇄title => string (78) "Tarik Paksa Sepeda Motor, Tiga Orang Matel Ditangkap Ditreskrimum Polda Banten"
{"description":"Tim Subdit III Jatanras Ditreskrimum Polda Banten menangkap tiga tersangka kasus perampasan kendaraan bermotor yang mengaku sebagai debt collector. ","images":[],"keywords":["penangkapan debt collector di Banten","modus operandi debt collector palsu","laporan polisi pencurian sepeda motor oleh debt collector","pasal KUHP tentang pemerasan debt collector","tindakan hukum terhadap debt collector yang melakukan kekerasan"],"sources":[]}
Dafiq Firdaus mulai menjalani laga debut profesionalnya di skuad utama Persita Tangerang. Penampilan perdananya terlihat saat Persita menjamu PSBS Biak
⇄images => array (0)
json_decode($value[2]['attr'], true)['images']
⇄⧉keywords => array (5)
json_decode($value[2]['attr'], true)['keywords']
⇄0 => string (40) "Debut Dafiq Firdaus di Persita Tangerang"
{"description":"Dafiq Firdaus mulai menjalani laga debut profesionalnya di skuad utama Persita Tangerang. Penampilan perdananya terlihat saat Persita menjamu PSBS Biak ","images":[],"keywords":["Debut Dafiq Firdaus di Persita Tangerang","Dafiq Firdaus pemain muda Persita Tangerang","Laga debut Dafiq Firdaus BRI Liga 1","Profil Dafiq Firdaus pemain Persita U-20","Persita Tangerang vs PSBS Biak BRI Liga 1"],"sources":[]}
⇄⧉desc => string (152) "Dafiq Firdaus mulai menjalani laga debut profesionalnya di skuad utama Persi...
$value[2]['desc']
Dafiq Firdaus mulai menjalani laga debut profesionalnya di skuad utama Persita Tangerang. Penampilan perdananya terlihat saat Persita menjamu PSBS Biak
⇄port => string (8) "https://"
$value[2]['port']
⇄site => string (9) "fin.co.id"
$value[2]['site']
⇄⧉3 => array (14)
$value[3]
⇄title => string (65) "Pelatih Persita: Kami Akan Maksimalkan Tiga Pertandingan Tersisa!"
{"description":"Persita Tangerang sepertinya tak punya target kemenangan selain hanya lolos dari zona degradasi di Liga 1 Indonesia musim 2024\/2025.","images":[],"keywords":["Persita Tangerang target lolos degradasi Liga 1 2024\/2025","Prediksi pertandingan Persita Tangerang vs Dewa United","Pelatih Persita Tangerang Fabio Lefundes komentari kekalahan","Analisis performa Persita Tangerang musim 2024\/2025","Persita Tangerang peluang lolos degradasi Liga 1 sisa tiga laga"],"sources":[]}
{"description":"(PAFI) Ilath, Kabupaten Buru, Maluku, menekankan pentingnya peran apoteker dalam memahami dan menyampaikan informasi imunoterapi.","images":[],"keywords":["Peran apoteker dalam pengobatan penyakit autoimun","Imunoterapi untuk penyakit autoimun di Indonesia","Edukasi imunoterapi untuk pasien penyakit autoimun","Pengelolaan penyakit autoimun jangka panjang","Peran PAFI dalam meningkatkan kesadaran penyakit autoimun"],"sources":[]}
⇄⧉desc => string (129) "(PAFI) Ilath, Kabupaten Buru, Maluku, menekankan pentingnya peran apoteker d...
$value[4]['desc']
(PAFI) Ilath, Kabupaten Buru, Maluku, menekankan pentingnya peran apoteker dalam memahami dan menyampaikan informasi imunoterapi.
⇄port => string (8) "https://"
$value[4]['port']
⇄site => string (9) "fin.co.id"
$value[4]['site']
site
⧉⌕$value array (9)
⇄name => string (9) "fin.co.id"
$value['name']
⇄title => string (75) "Kontak Langsung - FIN.CO.ID - Berani dan Beda, Baca Berita Terbaru Hari Ini"
$value['title']
⇄desc => string (15) "Kontak Langsung"
$value['desc']
⇄⧉keyword => string (299) "Berita Terkini, Berita Hari Ini, Berita Harian, Berita Terbaru, Berita, Beri...
$value['keyword']
Berita Terkini, Berita Hari Ini, Berita Harian, Berita Terbaru, Berita, Berita Terpercaya, Berita indonesia, Berita Terpopuler, Berita, Info Jawa Barat, Info Bandung, Info Terkini, Info Hari Ini, Info Harian, Info Terbaru, Info Akurat, Info Terpercaya, Info indonesia, Info Terpopuler, Info Nasional
Menurut ahli, cacar monyet paling mudah ditularkan lewat kontak kulit ke kulit. Dan bahwa penyebarannya bukan semata-mata disebabkan oleh hubungan intim semata
["Apakah Cacar Monyet Mematikan","Apa Ciri Orang Kena Cacar Monyet","Ada Efek Samping Cacar Monyet","Bagaimana Cara Mencegah Cacar Monyet","Tips Agar Terhindar Dari Cacar Monyet"]
⇄sources => string (2) "[]"
json_decode($value[0]['attr'], true)['sources']
{"description":"Menurut ahli, cacar monyet paling mudah ditularkan lewat kontak kulit ke kulit. Dan bahwa penyebarannya bukan semata-mata disebabkan oleh hubungan intim semata","images":[],"keywords":"[\"Apakah Cacar Monyet Mematikan\",\"Apa Ciri Orang Kena Cacar Monyet\",\"Ada Efek Samping Cacar Monyet\",\"Bagaimana Cara Mencegah Cacar Monyet\",\"Tips Agar Terhindar Dari Cacar Monyet\"]","sources":"[]"}
⇄⧉desc => string (159) "Menurut ahli, cacar monyet paling mudah ditularkan lewat kontak kulit ke kul...
$value[0]['desc']
Menurut ahli, cacar monyet paling mudah ditularkan lewat kontak kulit ke kulit. Dan bahwa penyebarannya bukan semata-mata disebabkan oleh hubungan intim semata
⧉public __construct() Will attempt to get environment variables with names that match the propertie...
/**
* Will attempt to get environment variables with names
* that match the properties of the child class.
*
* The "shortPrefix" is the lowercase-only config class name.
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:103
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:178
⧉protected registerProperties(): void Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @return void
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:226
⧉public static __set_state(array $array)
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:61
/**
* Constructor.
*
* @param string|null $uri The URI to parse.
*
* @throws HTTPException
*
* @TODO null for param $uri should be removed.
* See https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface
*/
Defined in .../HTTP/URI.php:256
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public setURI(?string $uri = null): URI Sets and overwrites any current URI information.
/**
* Sets and overwrites any current URI information.
*
* @return URI
*
* @throws HTTPException
*
* @deprecated 4.4.0 This method will be private.
*/
Defined in .../HTTP/URI.php:302
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*
* Warning: For backwards-compatability this method
* assumes URIs with the same host as baseURL should
* be relative to the project's configuration.
* This aspect of __toString() is deprecated and should be avoided.
*/
Defined in .../HTTP/URI.php:628
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setPath(string $path): $this Sets the path portion of the URI.
/**
* Sets the path portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPath($port)`.
*/
Defined in .../HTTP/URI.php:816
⧉public setBaseURL(string $baseURL): void Sets the current baseURL.
/**
* Sets the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:834
⧉public getBaseURL(): string Returns the current baseURL.
/**
* Returns the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:846
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/URI.php:862
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected applyParts(array $parts): void Saves our parts from a parse_url call.
/**
* Saves our parts from a parse_url call.
*
* @return void
*/
Defined in .../HTTP/URI.php:1036
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
⧉private changeSchemeAndPath(string $scheme, string $path): array Change the path (and scheme) assuming URIs with the same host as baseURL shou...
/**
* Change the path (and scheme) assuming URIs with the same host as baseURL
* should be relative to the project's configuration.
*
* @deprecated This method will be deleted.
*/
Defined in .../HTTP/URI.php:651
⇄⧉public static createURIString(?string $scheme = null, ?string $authority = null, ?string $path = null, ?string $query = null, ?string $fragment = null): string Builds a representation of the string from the component parts.
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
/**
* @param string $relativePath URI path relative to baseURL. May include
* queries or fragments.
* @param string|null $host Optional current hostname.
* @param string|null $scheme Optional scheme. 'http' or 'https'.
* @phpstan-param 'http'|'https'|null $scheme
*/
Defined in .../HTTP/SiteURI.php:94
⧉public setBaseURL(string $baseURL): void
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:226
⧉public setURI(?string $uri = null)
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:234
⧉public getBaseURL(): string Returns the baseURL.
/**
* Returns the baseURL.
*
* @interal
*/
Defined in .../HTTP/SiteURI.php:244
⧉public getRoutePath(): string Returns the URI path relative to baseURL.
/**
* Returns the URI path relative to baseURL.
*
* @return string The Route path.
*/
Defined in .../HTTP/SiteURI.php:254
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*/
Defined in .../HTTP/SiteURI.php:262
⧉public setPath(string $path): $this Sets the route path (and segments).
/**
* Sets the route path (and segments).
*
* @return $this
*/
Defined in .../HTTP/SiteURI.php:278
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/SiteURI.php:318
/**
* For base_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
*/
Defined in .../HTTP/SiteURI.php:379
/**
* For site_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
* @param App|null $config Alternate configuration to use.
*/
Defined in .../HTTP/SiteURI.php:419
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected applyParts(array $parts): void Saves our parts from a parse_url() call.
/**
* Saves our parts from a parse_url() call.
*/
Defined in .../HTTP/SiteURI.php:335
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
/**
* Constructor.
*
* @param string|null $uri The URI to parse.
*
* @throws HTTPException
*
* @TODO null for param $uri should be removed.
* See https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface
*/
Defined in .../HTTP/URI.php:256
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public setURI(?string $uri = null): URI Sets and overwrites any current URI information.
/**
* Sets and overwrites any current URI information.
*
* @return URI
*
* @throws HTTPException
*
* @deprecated 4.4.0 This method will be private.
*/
Defined in .../HTTP/URI.php:302
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*
* Warning: For backwards-compatability this method
* assumes URIs with the same host as baseURL should
* be relative to the project's configuration.
* This aspect of __toString() is deprecated and should be avoided.
*/
Defined in .../HTTP/URI.php:628
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setPath(string $path): $this Sets the path portion of the URI.
/**
* Sets the path portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPath($port)`.
*/
Defined in .../HTTP/URI.php:816
⧉public setBaseURL(string $baseURL): void Sets the current baseURL.
/**
* Sets the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:834
⧉public getBaseURL(): string Returns the current baseURL.
/**
* Returns the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:846
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/URI.php:862
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected applyParts(array $parts): void Saves our parts from a parse_url call.
/**
* Saves our parts from a parse_url call.
*
* @return void
*/
Defined in .../HTTP/URI.php:1036
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
⧉private changeSchemeAndPath(string $scheme, string $path): array Change the path (and scheme) assuming URIs with the same host as baseURL shou...
/**
* Change the path (and scheme) assuming URIs with the same host as baseURL
* should be relative to the project's configuration.
*
* @deprecated This method will be deleted.
*/
Defined in .../HTTP/URI.php:651
⇄⧉public static createURIString(?string $scheme = null, ?string $authority = null, ?string $path = null, ?string $query = null, ?string $fragment = null): string Builds a representation of the string from the component parts.
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
/**
* @param string $relativePath URI path relative to baseURL. May include
* queries or fragments.
* @param string|null $host Optional current hostname.
* @param string|null $scheme Optional scheme. 'http' or 'https'.
* @phpstan-param 'http'|'https'|null $scheme
*/
Defined in .../HTTP/SiteURI.php:94
⧉public setBaseURL(string $baseURL): void
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:226
⧉public setURI(?string $uri = null)
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:234
⧉public getBaseURL(): string Returns the baseURL.
/**
* Returns the baseURL.
*
* @interal
*/
Defined in .../HTTP/SiteURI.php:244
⧉public getRoutePath(): string Returns the URI path relative to baseURL.
/**
* Returns the URI path relative to baseURL.
*
* @return string The Route path.
*/
Defined in .../HTTP/SiteURI.php:254
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*/
Defined in .../HTTP/SiteURI.php:262
⧉public setPath(string $path): $this Sets the route path (and segments).
/**
* Sets the route path (and segments).
*
* @return $this
*/
Defined in .../HTTP/SiteURI.php:278
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/SiteURI.php:318
/**
* For base_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
*/
Defined in .../HTTP/SiteURI.php:379
/**
* For site_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
* @param App|null $config Alternate configuration to use.
*/
Defined in .../HTTP/SiteURI.php:419
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected applyParts(array $parts): void Saves our parts from a parse_url() call.
/**
* Saves our parts from a parse_url() call.
*/
Defined in .../HTTP/SiteURI.php:335
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
⧉public __construct() Merge the built-in and developer-configured filters and plugins, with prefere...
/**
* Merge the built-in and developer-configured filters and plugins,
* with preference to the developer ones.
*/
Inherited from CodeIgniter\Config\View
Defined in .../Config/View.php:129
/**
* Retrieve an environment-specific configuration setting
*
* @return string|null
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:178
⧉protected registerProperties(): void Provides external libraries a simple way to register one or more options into...
/**
* Provides external libraries a simple way to register one or more
* options into a config file.
*
* @return void
*
* @throws ReflectionException
*/
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:226
⧉public static __set_state(array $array)
Inherited from CodeIgniter\Config\BaseConfig
Defined in .../Config/BaseConfig.php:61
/**
* Constructor.
*
* @param string|null $uri The URI to parse.
*
* @throws HTTPException
*
* @TODO null for param $uri should be removed.
* See https://www.php-fig.org/psr/psr-17/#26-urifactoryinterface
*/
Defined in .../HTTP/URI.php:256
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public setURI(?string $uri = null): URI Sets and overwrites any current URI information.
/**
* Sets and overwrites any current URI information.
*
* @return URI
*
* @throws HTTPException
*
* @deprecated 4.4.0 This method will be private.
*/
Defined in .../HTTP/URI.php:302
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*
* Warning: For backwards-compatability this method
* assumes URIs with the same host as baseURL should
* be relative to the project's configuration.
* This aspect of __toString() is deprecated and should be avoided.
*/
Defined in .../HTTP/URI.php:628
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setPath(string $path): $this Sets the path portion of the URI.
/**
* Sets the path portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPath($port)`.
*/
Defined in .../HTTP/URI.php:816
⧉public setBaseURL(string $baseURL): void Sets the current baseURL.
/**
* Sets the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:834
⧉public getBaseURL(): string Returns the current baseURL.
/**
* Returns the current baseURL.
*
* @interal
*
* @deprecated Use SiteURI instead.
*/
Defined in .../HTTP/URI.php:846
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/URI.php:862
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected applyParts(array $parts): void Saves our parts from a parse_url call.
/**
* Saves our parts from a parse_url call.
*
* @return void
*/
Defined in .../HTTP/URI.php:1036
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
⧉private changeSchemeAndPath(string $scheme, string $path): array Change the path (and scheme) assuming URIs with the same host as baseURL shou...
/**
* Change the path (and scheme) assuming URIs with the same host as baseURL
* should be relative to the project's configuration.
*
* @deprecated This method will be deleted.
*/
Defined in .../HTTP/URI.php:651
⇄⧉public static createURIString(?string $scheme = null, ?string $authority = null, ?string $path = null, ?string $query = null, ?string $fragment = null): string Builds a representation of the string from the component parts.
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
/**
* @param string $relativePath URI path relative to baseURL. May include
* queries or fragments.
* @param string|null $host Optional current hostname.
* @param string|null $scheme Optional scheme. 'http' or 'https'.
* @phpstan-param 'http'|'https'|null $scheme
*/
Defined in .../HTTP/SiteURI.php:94
⧉public setBaseURL(string $baseURL): void
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:226
⧉public setURI(?string $uri = null)
/**
* @deprecated
*/
Defined in .../HTTP/SiteURI.php:234
⧉public getBaseURL(): string Returns the baseURL.
/**
* Returns the baseURL.
*
* @interal
*/
Defined in .../HTTP/SiteURI.php:244
⧉public getRoutePath(): string Returns the URI path relative to baseURL.
/**
* Returns the URI path relative to baseURL.
*
* @return string The Route path.
*/
Defined in .../HTTP/SiteURI.php:254
⧉public __toString(): string Formats the URI as a string.
/**
* Formats the URI as a string.
*/
Defined in .../HTTP/SiteURI.php:262
⧉public setPath(string $path): $this Sets the route path (and segments).
/**
* Sets the route path (and segments).
*
* @return $this
*/
Defined in .../HTTP/SiteURI.php:278
⧉public refreshPath(): $this Sets the path portion of the URI based on segments.
/**
* Sets the path portion of the URI based on segments.
*
* @return $this
*
* @deprecated This method will be private.
*/
Defined in .../HTTP/SiteURI.php:318
/**
* For base_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
*/
Defined in .../HTTP/SiteURI.php:379
/**
* For site_url() helper.
*
* @param array|string $relativePath URI string or array of URI segments.
* @param string|null $scheme URI scheme. E.g., http, ftp. If empty
* string '' is set, a protocol-relative
* link is returned.
* @param App|null $config Alternate configuration to use.
*/
Defined in .../HTTP/SiteURI.php:419
⧉public setSilent(bool $silent = true): URI If $silent == true, then will not throw exceptions and will attempt to contin...
/**
* If $silent == true, then will not throw exceptions and will
* attempt to continue gracefully.
*
* @deprecated 4.4.0 Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:271
⧉public useRawQueryString(bool $raw = true): URI If $raw == true, then will use parseStr() method instead of native parse_str(...
/**
* If $raw == true, then will use parseStr() method
* instead of native parse_str() function.
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:286
⧉public getScheme(): string Retrieve the scheme component of the URI.
/**
* Retrieve the scheme component of the URI.
*
* If no scheme is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.1.
*
* The trailing ":" character is not part of the scheme and MUST NOT be
* added.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.1
*
* @return string The URI scheme.
*/
Defined in .../HTTP/URI.php:336
⧉public getAuthority(bool $ignorePort = false): string Retrieve the authority component of the URI.
/**
* Retrieve the authority component of the URI.
*
* If no authority information is present, this method MUST return an empty
* string.
*
* The authority syntax of the URI is:
*
* <pre>
* [user-info@]host[:port]
* </pre>
*
* If the port component is not set or is the standard port for the current
* scheme, it SHOULD NOT be included.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.2
*
* @return string The URI authority, in "[user-info@]host[:port]" format.
*/
Defined in .../HTTP/URI.php:360
⧉public getUserInfo(): string|null The URI user information, in "username[:password]" format. Retrieve the user information component of the URI.
/**
* Retrieve the user information component of the URI.
*
* If no user information is present, this method MUST return an empty
* string.
*
* If a user is present in the URI, this will return that value;
* additionally, if the password is also present, it will be appended to the
* user value, with a colon (":") separating the values.
*
* NOTE that be default, the password, if available, will NOT be shown
* as a security measure as discussed in RFC 3986, Section 7.5. If you know
* the password is not a security issue, you can force it to be shown
* with $this->showPassword();
*
* The trailing "@" character is not part of the user information and MUST
* NOT be added.
*
* @return string|null The URI user information, in "username[:password]" format.
*/
Defined in .../HTTP/URI.php:403
⧉public showPassword(bool $val = true): URI Temporarily sets the URI to show a password in userInfo. Will reset itself af...
/**
* Temporarily sets the URI to show a password in userInfo. Will
* reset itself after the first call to authority().
*
* Note: Method not in PSR-7
*
* @return URI
*/
Defined in .../HTTP/URI.php:422
⧉public getHost(): string Retrieve the host component of the URI.
/**
* Retrieve the host component of the URI.
*
* If no host is present, this method MUST return an empty string.
*
* The value returned MUST be normalized to lowercase, per RFC 3986
* Section 3.2.2.
*
* @see http://tools.ietf.org/html/rfc3986#section-3.2.2
*
* @return string The URI host.
*/
Defined in .../HTTP/URI.php:441
⧉public getPort(): int|null The URI port. Retrieve the port component of the URI.
/**
* Retrieve the port component of the URI.
*
* If a port is present, and it is non-standard for the current scheme,
* this method MUST return it as an integer. If the port is the standard port
* used with the current scheme, this method SHOULD return null.
*
* If no port is present, and no scheme is present, this method MUST return
* a null value.
*
* If no port is present, but a scheme is present, this method MAY return
* the standard port for that scheme, but SHOULD return null.
*
* @return int|null The URI port.
*/
Defined in .../HTTP/URI.php:461
⧉public getPath(): string Retrieve the path component of the URI.
/**
* Retrieve the path component of the URI.
*
* The path can either be empty or absolute (starting with a slash) or
* rootless (not starting with a slash). Implementations MUST support all
* three syntaxes.
*
* Normally, the empty path "" and absolute path "/" are considered equal as
* defined in RFC 7230 Section 2.7.3. But this method MUST NOT automatically
* do this normalization because in contexts with a trimmed base path, e.g.
* the front controller, this difference becomes significant. It's the task
* of the user to handle both "" and "/".
*
* The value returned MUST be percent-encoded, but MUST NOT double-encode
* any characters. To determine what characters to encode, please refer to
* RFC 3986, Sections 2 and 3.3.
*
* As an example, if the value should include a slash ("/") not intended as
* delimiter between path segments, that value MUST be passed in encoded
* form (e.g., "%2F") to the instance.
*
* @see https://tools.ietf.org/html/rfc3986#section-2
* @see https://tools.ietf.org/html/rfc3986#section-3.3
*
* @return string The URI path.
*/
Defined in .../HTTP/URI.php:492
⧉public getQuery(array $options = array()): string Retrieve the query string
/**
* Retrieve the query string
*/
Defined in .../HTTP/URI.php:500
⧉public getFragment(): string Retrieve a URI fragment
/**
* Retrieve a URI fragment
*/
Defined in .../HTTP/URI.php:534
⧉public getSegments(): array Returns the segments of the path as an array.
/**
* Returns the segments of the path as an array.
*/
Defined in .../HTTP/URI.php:542
⧉public getSegment(int $number, string $default = ''): string Returns the value of a specific segment of the URI path. Allows to get only e...
/**
* Returns the value of a specific segment of the URI path.
* Allows to get only existing segments or the next one.
*
* @param int $number Segment number starting at 1
* @param string $default Default value
*
* @return string The value of the segment. If you specify the last +1
* segment, the $default value. If you specify the last +2
* or more throws HTTPException.
*/
Defined in .../HTTP/URI.php:558
⧉public setSegment(int $number, $value): $this Set the value of a specific segment of the URI path. Allows to set only exist...
/**
* Set the value of a specific segment of the URI path.
* Allows to set only existing segments or add new one.
*
* Note: Method not in PSR-7
*
* @param int $number Segment number starting at 1
* @param int|string $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:586
⧉public getTotalSegments(): int Returns the total number of segments.
/**
* Returns the total number of segments.
*
* Note: Method not in PSR-7
*/
Defined in .../HTTP/URI.php:615
⧉public setAuthority(string $str): $this Parses the given string and saves the appropriate authority pieces.
/**
* Parses the given string and saves the appropriate authority pieces.
*
* Note: Method not in PSR-7
*
* @return $this
*/
Defined in .../HTTP/URI.php:685
⧉public setScheme(string $str): $this Sets the scheme for this URI.
/**
* Sets the scheme for this URI.
*
* Because of the large number of valid schemes we cannot limit this
* to only http or https.
*
* @see https://www.iana.org/assignments/uri-schemes/uri-schemes.xhtml
*
* @return $this
*
* @deprecated 4.4.0 Use `withScheme()` instead.
*/
Defined in .../HTTP/URI.php:715
⧉public withScheme(string $scheme): static A new instance with the specified scheme. Return an instance with the specified scheme.
/**
* Return an instance with the specified scheme.
*
* This method MUST retain the state of the current instance, and return
* an instance that contains the specified scheme.
*
* Implementations MUST support the schemes "http" and "https" case
* insensitively, and MAY accommodate other schemes if required.
*
* An empty scheme is equivalent to removing the scheme.
*
* @param string $scheme The scheme to use with the new instance.
*
* @return static A new instance with the specified scheme.
*
* @throws InvalidArgumentException for invalid or unsupported schemes.
*/
Defined in .../HTTP/URI.php:740
⧉public setUserInfo(string $user, string $pass): $this Sets the userInfo/Authority portion of the URI.
/**
* Sets the userInfo/Authority portion of the URI.
*
* @param string $user The user's username
* @param string $pass The user's password
*
* @return $this
*
* @TODO PSR-7: Should be `withUserInfo($user, $password = null)`.
*/
Defined in .../HTTP/URI.php:761
⧉public setHost(string $str): $this Sets the host name to use.
/**
* Sets the host name to use.
*
* @return $this
*
* @TODO PSR-7: Should be `withHost($host)`.
*/
Defined in .../HTTP/URI.php:776
⧉public setPort(?int $port = null): $this Sets the port portion of the URI.
/**
* Sets the port portion of the URI.
*
* @return $this
*
* @TODO PSR-7: Should be `withPort($port)`.
*/
Defined in .../HTTP/URI.php:790
⧉public setQuery(string $query): $this Sets the query portion of the URI, while attempting to clean the various part...
/**
* Sets the query portion of the URI, while attempting
* to clean the various parts of the query keys and values.
*
* @return $this
*
* @TODO PSR-7: Should be `withQuery($query)`.
*/
Defined in .../HTTP/URI.php:881
⧉public setQueryArray(array $query): URI A convenience method to pass an array of items in as the Query portion of the...
/**
* A convenience method to pass an array of items in as the Query
* portion of the URI.
*
* @return URI
*
* @TODO: PSR-7: Should be `withQueryParams(array $query)`
*/
Defined in .../HTTP/URI.php:913
⧉public addQuery(string $key, $value = null): $this Adds a single new element to the query vars.
/**
* Adds a single new element to the query vars.
*
* Note: Method not in PSR-7
*
* @param int|string|null $value
*
* @return $this
*/
Defined in .../HTTP/URI.php:929
⧉public stripQuery($params): $this Removes one or more query vars from the URI.
/**
* Removes one or more query vars from the URI.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:945
⧉public keepQuery($params): $this Filters the query variables so that only the keys passed in are kept. The res...
/**
* Filters the query variables so that only the keys passed in
* are kept. The rest are removed from the object.
*
* Note: Method not in PSR-7
*
* @param string ...$params
*
* @return $this
*/
Defined in .../HTTP/URI.php:964
⧉public setFragment(string $string): $this Sets the fragment portion of the URI.
/**
* Sets the fragment portion of the URI.
*
* @see https://tools.ietf.org/html/rfc3986#section-3.5
*
* @return $this
*
* @TODO PSR-7: Should be `withFragment($fragment)`.
*/
Defined in .../HTTP/URI.php:990
⧉public resolveRelativeURI(string $uri): URI Combines one URI string with this one based on the rules set out in RFC 3986 ...
/**
* Combines one URI string with this one based on the rules set out in
* RFC 3986 Section 2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2
*
* @return URI
*/
Defined in .../HTTP/URI.php:1087
⧉protected applyParts(array $parts): void Saves our parts from a parse_url() call.
/**
* Saves our parts from a parse_url() call.
*/
Defined in .../HTTP/SiteURI.php:335
⧉protected filterPath(?string $path = null): string Encodes any dangerous characters, and removes dot segments. While dot segment...
/**
* Encodes any dangerous characters, and removes dot segments.
* While dot segments have valid uses according to the spec,
* this URI class does not allow them.
*/
Defined in .../HTTP/URI.php:1002
⧉protected mergePaths(self $base, self $reference): string Given 2 paths, will merge them according to rules set out in RFC 2986, Sectio...
/**
* Given 2 paths, will merge them according to rules set out in RFC 2986,
* Section 5.2
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.3
*/
Defined in .../HTTP/URI.php:1143
⧉protected parseStr(string $query): array This is equivalent to the native PHP parse_str() function. This version allow...
/**
* This is equivalent to the native PHP parse_str() function.
* This version allows the dot to be used as a key of the query string.
*/
Defined in .../HTTP/URI.php:1165
/**
* Builds a representation of the string from the component parts.
*
* @param string|null $scheme URI scheme. E.g., http, ftp
*
* @return string URI string with only passed parts. Maybe incomplete as a URI.
*/
Defined in .../HTTP/URI.php:161
⇄⧉public static removeDotSegments(string $path): string Used when resolving and merging paths to correctly interpret and remove singl...
/**
* Used when resolving and merging paths to correctly interpret and
* remove single and double dot segments from the path per
* RFC 3986 Section 5.2.4
*
* @see http://tools.ietf.org/html/rfc3986#section-5.2.4
*
* @internal
*/
Defined in .../HTTP/URI.php:203
/**
* Constructor.
*/
Defined in .../Pager/PagerRenderer.php:88
⧉public setSurroundCount(?int $count = null): PagerRenderer Sets the total number of links that should appear on either side of the curre...
/**
* Sets the total number of links that should appear on either
* side of the current page. Adjusts the first and last counts
* to reflect it.
*
* @return PagerRenderer
*/
Defined in .../Pager/PagerRenderer.php:110
⧉public hasPrevious(): bool Checks to see if there is a "previous" page before our "first" page.
/**
* Checks to see if there is a "previous" page before our "first" page.
*/
Defined in .../Pager/PagerRenderer.php:120
⧉public getPrevious(): string|null Returns a URL to the "previous" page. The previous page is NOT the page befor...
/**
* Returns a URL to the "previous" page. The previous page is NOT the
* page before the current page, but is the page just before the
* "first" page.
*
* @return string|null
*/
Defined in .../Pager/PagerRenderer.php:132
⧉public hasNext(): bool Checks to see if there is a "next" page after our "last" page.
/**
* Checks to see if there is a "next" page after our "last" page.
*/
Defined in .../Pager/PagerRenderer.php:158
⧉public getNext(): string|null Returns a URL to the "next" page. The next page is NOT, the page after the cu...
/**
* Returns a URL to the "next" page. The next page is NOT, the
* page after the current page, but is the page that follows the
* "last" page.
*
* @return string|null
*/
Defined in .../Pager/PagerRenderer.php:170
⧉public getFirst(): string Returns the URI of the first page.
/**
* Returns the URI of the first page.
*/
Defined in .../Pager/PagerRenderer.php:196
⧉public getLast(): string Returns the URI of the last page.
/**
* Returns the URI of the last page.
*/
Defined in .../Pager/PagerRenderer.php:218
⧉public getCurrent(): string Returns the URI of the current page.
/**
* Returns the URI of the current page.
*/
Defined in .../Pager/PagerRenderer.php:240
⧉public links(): array Returns an array of links that should be displayed. Each link is represented ...
/**
* Returns an array of links that should be displayed. Each link
* is represented by another array containing of the URI the link
* should go to, the title (number) of the link, and a boolean
* value representing whether this link is active or not.
*
* @return list<array{uri:string, title:int, active:bool}>
*/
Defined in .../Pager/PagerRenderer.php:267
⧉public hasPreviousPage(): bool Checks to see if there is a "previous" page before our "first" page.
/**
* Checks to see if there is a "previous" page before our "first" page.
*/
Defined in .../Pager/PagerRenderer.php:313
⧉public getPreviousPage(): string|null Returns a URL to the "previous" page.
/**
* Returns a URL to the "previous" page.
*
* You MUST call hasPreviousPage() first, or this value may be invalid.
*
* @return string|null
*/
Defined in .../Pager/PagerRenderer.php:325
⧉public hasNextPage(): bool Checks to see if there is a "next" page after our "last" page.
/**
* Checks to see if there is a "next" page after our "last" page.
*/
Defined in .../Pager/PagerRenderer.php:351
⧉public getNextPage(): string|null Returns a URL to the "next" page.
/**
* Returns a URL to the "next" page.
*
* You MUST call hasNextPage() first, or this value may be invalid.
*
* @return string|null
*/
Defined in .../Pager/PagerRenderer.php:363
⧉public getFirstPageNumber(): int Returns the page number of the first page in the set of links to be displayed.
/**
* Returns the page number of the first page in the set of links to be displayed.
*/
Defined in .../Pager/PagerRenderer.php:389
⧉public getCurrentPageNumber(): int Returns the page number of the current page.
/**
* Returns the page number of the current page.
*/
Defined in .../Pager/PagerRenderer.php:397
⧉public getLastPageNumber(): int Returns the page number of the last page in the set of links to be displayed.
/**
* Returns the page number of the last page in the set of links to be displayed.
*/
Defined in .../Pager/PagerRenderer.php:405
⧉public getPageCount(): int Returns total number of pages.
/**
* Returns total number of pages.
*/
Defined in .../Pager/PagerRenderer.php:413
⧉public getPreviousPageNumber(): ?int Returns the previous page number.
/**
* Returns the previous page number.
*/
Defined in .../Pager/PagerRenderer.php:421
⧉public getNextPageNumber(): ?int Returns the next page number.
/**
* Returns the next page number.
*/
Defined in .../Pager/PagerRenderer.php:429
⧉protected updatePages(?int $count = null): void Updates the first and last pages based on $surroundCount, which is the number...
/**
* Updates the first and last pages based on $surroundCount,
* which is the number of links surrounding the active page
* to show.
*
* @param int|null $count The new "surroundCount"
*
* @return void
*/
Defined in .../Pager/PagerRenderer.php:300
⧉public initialize(Config\Autoload $config, Config\Modules $modules): $this Reads in the configuration array (described above) and stores the valid parts...
/**
* Reads in the configuration array (described above) and stores
* the valid parts that we'll need.
*
* @return $this
*/
Defined in .../Autoloader/Autoloader.php:103
⧉public register(): void Register the loader with the SPL autoloader stack.
/**
* Register the loader with the SPL autoloader stack.
*
* @return void
*/
Defined in .../Autoloader/Autoloader.php:163
⧉public unregister(): void Unregister autoloader.
/**
* Unregister autoloader.
*
* This method is for testing.
*/
Defined in .../Autoloader/Autoloader.php:182
⧉public addNamespace($namespace, ?string $path = null): $this Registers namespaces with the autoloader.
/**
* Registers namespaces with the autoloader.
*
* @param array<string, list<string>|string>|string $namespace
*
* @return $this
*/
Defined in .../Autoloader/Autoloader.php:195
⧉public getNamespace(?string $prefix = null): array<string, list<string>>|list<string> Get namespaces with prefixes as keys and paths as values.
/**
* Get namespaces with prefixes as keys and paths as values.
*
* If a prefix param is set, returns only paths to the given prefix.
*
* @return array<string, list<string>>|list<string>
* @phpstan-return ($prefix is null ? array<string, list<string>> : list<string>)
*/
Defined in .../Autoloader/Autoloader.php:226
⧉public removeNamespace(string $namespace): $this Removes a single namespace from the psr4 settings.
/**
* Removes a single namespace from the psr4 settings.
*
* @return $this
*/
Defined in .../Autoloader/Autoloader.php:240
⧉public loadClassmap(string $class): void Load a class using available class mapping.
/**
* Load a class using available class mapping.
*
* @internal For `spl_autoload_register` use.
*/
Defined in .../Autoloader/Autoloader.php:254
⧉public loadClass(string $class): void Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @internal For `spl_autoload_register` use.
*
* @param string $class The fully qualified class name.
*/
Defined in .../Autoloader/Autoloader.php:270
/**
* Check file path.
*
* Checks special characters that are illegal in filenames on certain
* operating systems and special characters requiring special escaping
* to manipulate at the command line. Replaces spaces and consecutive
* dashes with a single dash. Trim period, dash and underscore from beginning
* and end of filename.
*
* @return string The sanitized filename
*
* @deprecated No longer used. See https://github.com/codeigniter4/CodeIgniter4/issues/7055
*/
Defined in .../Autoloader/Autoloader.php:338
⧉public loadHelpers(): void Loads helpers
/**
* Loads helpers
*/
Defined in .../Autoloader/Autoloader.php:485
/**
* Initializes Kint
*/
Defined in .../Autoloader/Autoloader.php:493
⧉protected loadInNamespace(string $class): false|string The mapped file name on success, or boolean false on fail Loads the class file for a given class name.
/**
* Loads the class file for a given class name.
*
* @param string $class The fully-qualified class name
*
* @return false|string The mapped file name on success, or boolean false on fail
*/
Defined in .../Autoloader/Autoloader.php:282
⧉protected includeFile(string $file): false|string The filename on success, false if the file is not loaded A central way to include a file. Split out primarily for testing purposes.
/**
* A central way to include a file. Split out primarily for testing purposes.
*
* @return false|string The filename on success, false if the file is not loaded
*/
Defined in .../Autoloader/Autoloader.php:314
⧉protected discoverComposerNamespaces(): void Locates autoload information from Composer, if available.
/**
* Locates autoload information from Composer, if available.
*
* @deprecated No longer used.
*
* @return void
*/
Defined in .../Autoloader/Autoloader.php:451
⧉public locateFile(string $file, ?string $folder = null, string $ext = 'php'): false|string The path to the file, or false if not found. Attempts to locate a file by examining the name for a namespace and looking t...
/**
* Attempts to locate a file by examining the name for a namespace
* and looking through the PSR-4 namespaced files that we know about.
*
* @param string $file The relative file path or namespaced file to
* locate. If not namespaced, search in the app
* folder.
* @param non-empty-string|null $folder The folder within the namespace that we should
* look for the file. If $file does not contain
* this value, it will be appended to the namespace
* folder.
* @param string $ext The file extension the file should have.
*
* @return false|string The path to the file, or false if not found.
*/
Defined in .../Autoloader/FileLocator.php:58
⧉public getClassname(string $file): string Examines a file and returns the fully qualified class name.
/**
* Examines a file and returns the fully qualified class name.
*/
Defined in .../Autoloader/FileLocator.php:129
⧉public search(string $path, string $ext = 'php', bool $prioritizeApp = true): array Searches through all of the defined namespaces looking for a file. Returns an...
/**
* Searches through all of the defined namespaces looking for a file.
* Returns an array of all found locations for the defined file.
*
* Example:
*
* $locator->search('Config/Routes.php');
* // Assuming PSR4 namespaces include foo and bar, might return:
* [
* 'app/Modules/foo/Config/Routes.php',
* 'app/Modules/bar/Config/Routes.php',
* ]
*
* @return list<string>
*/
Defined in .../Autoloader/FileLocator.php:188
⧉public findQualifiedNameFromPath(string $path): false|string The qualified name or false if the path is not found Find the qualified name of a file according to the namespace of the first mat...
/**
* Find the qualified name of a file according to
* the namespace of the first matched namespace path.
*
* @return false|string The qualified name or false if the path is not found
*/
Defined in .../Autoloader/FileLocator.php:273
⧉public listFiles(string $path): array Scans the defined namespaces, returning a list of all files that are containe...
/**
* Scans the defined namespaces, returning a list of all files
* that are contained within the subpath specified by $path.
*
* @return list<string> List of file paths
*/
Defined in .../Autoloader/FileLocator.php:324
⧉public listNamespaceFiles(string $prefix, string $path): array Scans the provided namespace, returning a list of all files that are containe...
/**
* Scans the provided namespace, returning a list of all files
* that are contained within the sub path specified by $path.
*
* @return list<string> List of file paths
*/
Defined in .../Autoloader/FileLocator.php:357
⧉protected ensureExt(string $path, string $ext): string Ensures a extension is at the end of a filename
/**
* Ensures a extension is at the end of a filename
*/
Defined in .../Autoloader/FileLocator.php:221
⧉protected getNamespaces(): array<int, array<string, string>> Return the namespace mappings we know about.
/**
* Return the namespace mappings we know about.
*
* @return array<int, array<string, string>>
*/
Defined in .../Autoloader/FileLocator.php:239
⧉protected legacyLocate(string $file, ?string $folder = null): false|string The path to the file, or false if not found. Checks the app folder to see if the file can be found. Only for use with file...
/**
* Checks the app folder to see if the file can be found.
* Only for use with filenames that DO NOT include namespacing.
*
* @param non-empty-string|null $folder
*
* @return false|string The path to the file, or false if not found.
*/
Defined in .../Autoloader/FileLocator.php:393
/**
* Constructor
*/
Defined in .../Log/Handlers/FileHandler.php:50
⧉public handle($level, $message): bool Handles logging the message. If the handler returns false, then execution of ...
/**
* Handles logging the message.
* If the handler returns false, then execution of handlers
* will stop. Any handlers that have not run, yet, will not
* be run.
*
* @param string $level
* @param string $message
*
* @throws Exception
*/
Defined in .../Log/Handlers/FileHandler.php:73
⧉public canHandle(string $level): bool Checks whether the Handler will handle logging items of this log Level.
/**
* Checks whether the Handler will handle logging items of this
* log Level.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in .../Log/Handlers/BaseHandler.php:47
⧉public setDateFormat(string $format): CodeIgniter\Log\Handlers\HandlerInterface Stores the date format to use while logging messages.
/**
* Stores the date format to use while logging messages.
*/
Inherited from CodeIgniter\Log\Handlers\BaseHandler
Defined in .../Log/Handlers/BaseHandler.php:55
/**
* Constructor.
*
* @param \Config\Logger $config
*
* @throws RuntimeException
*/
Defined in .../Log/Logger.php:124
⧉public emergency(Stringable|string $message, array $context = array()): void System is unusable.
/**
* System is unusable.
*
* @param string $message
*/
Defined in .../Log/Logger.php:162
⧉public alert(Stringable|string $message, array $context = array()): void Action must be taken immediately.
/**
* Action must be taken immediately.
*
* Example: Entire website down, database unavailable, etc. This should
* trigger the SMS alerts and wake you up.
*
* @param string $message
*/
Defined in .../Log/Logger.php:175
⧉public error(Stringable|string $message, array $context = array()): void Runtime errors that do not require immediate action but should typically be l...
/**
* Runtime errors that do not require immediate action but should typically
* be logged and monitored.
*
* @param string $message
*/
Defined in .../Log/Logger.php:198
⧉public warning(Stringable|string $message, array $context = array()): void Exceptional occurrences that are not errors.
/**
* Exceptional occurrences that are not errors.
*
* Example: Use of deprecated APIs, poor use of an API, undesirable things
* that are not necessarily wrong.
*
* @param string $message
*/
Defined in .../Log/Logger.php:211
⧉public notice(Stringable|string $message, array $context = array()): void Normal but significant events.
/**
* Normal but significant events.
*
* @param string $message
*/
Defined in .../Log/Logger.php:221
/**
* Detailed debug information.
*
* @param string $message
*/
Defined in .../Log/Logger.php:243
⧉public log($level, Stringable|string $message, array $context = array()): void Logs with an arbitrary level.
/**
* Logs with an arbitrary level.
*
* @param string $level
* @param string $message
*/
Defined in .../Log/Logger.php:254
⧉public determineFile(): array Determines the file and line that the logging call was made from by analyzing...
/**
* Determines the file and line that the logging call
* was made from by analyzing the backtrace.
* Find the earliest stack frame that is part of our logging system.
*/
Defined in .../Log/Logger.php:374
⧉protected interpolate($message, array $context = array()): string Replaces any placeholders in the message with variables from the context, as ...
/**
* Replaces any placeholders in the message with variables
* from the context, as well as a few special items like:
*
* {session_vars}
* {post_vars}
* {get_vars}
* {env}
* {env:foo}
* {file}
* {line}
*
* @param string $message
*
* @return string
*/
Defined in .../Log/Logger.php:318
⧉protected cleanFileNames(string $file): string Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH with t...
/**
* Cleans the paths of filenames by replacing APPPATH, SYSTEMPATH, FCPATH
* with the actual var. i.e.
*
* /var/www/site/app/Controllers/Home.php
* becomes:
* APPPATH/Controllers/Home.php
*
* @deprecated Use dedicated `clean_path()` function.
*/
Defined in .../Log/Logger.php:424
⧉public render(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a file name and any data that has already been set.
/**
* Builds the output based upon a file name and any
* data that has already been set.
*
* Valid $options:
* - cache Number of seconds to cache for
* - cache_name Name to use for cache
*
* @param string $view File name of the view source
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in .../View/View.php:176
⧉public renderString(string $view, ?array $options = null, ?bool $saveData = null): string Builds the output based upon a string and any data that has already been set....
/**
* Builds the output based upon a string and any
* data that has already been set.
* Cache does not apply, because there is no "key".
*
* @param string $view The view contents
* @param array|null $options Reserved for 3rd-party uses since
* it might be needed to pass additional info
* to other template engines.
* @param bool|null $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying,
* if null, uses the config setting.
*/
Defined in .../View/View.php:317
⧉public excerpt(string $string, int $length = 20): string Extract first bit of a long string and add ellipsis
/**
* Extract first bit of a long string and add ellipsis
*/
Defined in .../View/View.php:340
⧉public setData(array $data = array(), ?string $context = null): CodeIgniter\View\RendererInterface Sets several pieces of view data at once.
/**
* Sets several pieces of view data at once.
*
* @param non-empty-string|null $context The context to escape it for.
* If 'raw', no escaping will happen.
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in .../View/View.php:352
⧉public setVar(string $name, $value = null, ?string $context = null): CodeIgniter\View\RendererInterface Sets a single piece of view data.
/**
* Sets a single piece of view data.
*
* @param mixed $value
* @param non-empty-string|null $context The context to escape it for.
* If 'raw', no escaping will happen.
* @phpstan-param null|'html'|'js'|'css'|'url'|'attr'|'raw' $context
*/
Defined in .../View/View.php:372
⧉public resetData(): CodeIgniter\View\RendererInterface Removes all of the view data from the system.
/**
* Removes all of the view data from the system.
*/
Defined in .../View/View.php:387
⧉public getData(): array Returns the current data that will be displayed in the view.
/**
* Returns the current data that will be displayed in the view.
*/
Defined in .../View/View.php:397
⧉public extend(string $layout): void Specifies that the current view should extend an existing layout.
/**
* Specifies that the current view should extend an existing layout.
*
* @return void
*/
Defined in .../View/View.php:407
⧉public section(string $name): void Starts holds content for a section within the layout.
/**
* Starts holds content for a section within the layout.
*
* @param string $name Section name
*
* @return void
*/
Defined in .../View/View.php:419
⧉public endSection(): void Captures the last section
/**
* Captures the last section
*
* @return void
*
* @throws RuntimeException
*/
Defined in .../View/View.php:435
/**
* Renders a section's contents.
*
* @param bool $saveData If true, saves data for subsequent calls,
* if false, cleans the data after displaying.
*
* @return void
*/
Defined in .../View/View.php:461
⧉public include(string $view, ?array $options = null, $saveData = true): string Used within layout views to include additional views.
/**
* Used within layout views to include additional views.
*
* @param bool $saveData
*/
Defined in .../View/View.php:482
⧉public getPerformanceData(): array Returns the performance data that might have been collected during the execut...
/**
* Returns the performance data that might have been collected
* during the execution. Used primarily in the Debug Toolbar.
*/
Defined in .../View/View.php:491
⧉protected decorateOutput(string $html): string Runs the generated output through any declared view decorators.
/**
* Runs the generated output through any declared
* view decorators.
*/
Defined in .../View/ViewDecoratorTrait.php:25
⧉protected logPerformance(float $start, float $end, string $view): void Logs performance data for rendering a view.
/**
* Logs performance data for rendering a view.
*
* @return void
*/
Defined in .../View/View.php:501
/**
* Creates simple Next/Previous links, instead of full pagination.
*/
Defined in .../Pager/Pager.php:93
⇄⧉public makeLinks(int $page, ?int $perPage, int $total, string $template = 'default_full', int $segment0, ?string $group = 'default'): string Allows for a simple, manual, form of pagination where all of the data is prov...
$value->makeLinks(int $page, ?int $perPage, int $total, string $template = 'default_full', int $segment0, ?string $group = 'default')
/**
* Allows for a simple, manual, form of pagination where all of the data
* is provided by the user. The URL is the current URI.
*
* @param string $template The output template alias to render.
* @param int $segment (whether page number is provided by URI segment)
* @param string|null $group optional group (i.e. if we'd like to define custom path)
*/
Defined in .../Pager/Pager.php:108
⇄⧉public store(string $group, int $page, ?int $perPage, int $total, int $segment0): $this Stores a set of pagination data for later display. Most commonly used by the ...
$value->store(string $group, int $page, ?int $perPage, int $total, int $segment0)
/**
* Stores a set of pagination data for later display. Most commonly used
* by the model to automate the process.
*
* @return $this
*/
Defined in .../Pager/Pager.php:139
⇄⧉public setSegment(int $number, string $group = 'default'): $this Sets segment for a group.
/**
* Sets the path that an aliased group of links will use.
*
* @return $this
*/
Defined in .../Pager/Pager.php:183
⇄⧉public getTotal(string $group = 'default'): int Returns the total number of items in data store.
$value->getTotal(string $group = 'default')
/**
* Returns the total number of items in data store.
*/
Defined in .../Pager/Pager.php:195
⇄⧉public getPageCount(string $group = 'default'): int Returns the total number of pages.
$value->getPageCount(string $group = 'default')
/**
* Returns the total number of pages.
*/
Defined in .../Pager/Pager.php:205
⇄⧉public getCurrentPage(string $group = 'default'): int Returns the number of the current page of results.
$value->getCurrentPage(string $group = 'default')
/**
* Returns the number of the current page of results.
*/
Defined in .../Pager/Pager.php:215
⇄⧉public hasMore(string $group = 'default'): bool Tells whether this group of results has any more pages of results.
$value->hasMore(string $group = 'default')
/**
* Tells whether this group of results has any more pages of results.
*/
Defined in .../Pager/Pager.php:225
⇄⧉public getLastPage(string $group = 'default'): int|null Returns the last page, if we have a total that we can calculate with.
$value->getLastPage(string $group = 'default')
/**
* Returns the last page, if we have a total that we can calculate with.
*
* @return int|null
*/
Defined in .../Pager/Pager.php:237
⇄⧉public getFirstPage(string $group = 'default'): int Determines the first page # that should be shown.
$value->getFirstPage(string $group = 'default')
/**
* Determines the first page # that should be shown.
*/
Defined in .../Pager/Pager.php:251
⇄⧉public getPageURI(?int $page = null, string $group = 'default', bool $returnObject = false): string|URI Returns the URI for a specific page for the specified group.
/**
* Returns the full URI to the next page of results, or null.
*
* @return string|null
*/
Defined in .../Pager/Pager.php:307
⇄⧉public getPreviousPageURI(string $group = 'default', bool $returnObject = false): string|null Returns the full URL to the previous page of results, or null.
/**
* Returns the full URL to the previous page of results, or null.
*
* @return string|null
*/
Defined in .../Pager/Pager.php:331
⇄⧉public getPerPage(string $group = 'default'): int Returns the number of results per page that should be shown.
$value->getPerPage(string $group = 'default')
/**
* Returns the number of results per page that should be shown.
*/
Defined in .../Pager/Pager.php:353
⇄⧉public getDetails(string $group = 'default'): array Returns an array with details about the results, including total, per_page, c...
$value->getDetails(string $group = 'default')
/**
* Returns an array with details about the results, including
* total, per_page, current_page, last_page, next_url, prev_url, from, to.
* Does not include the actual data. This data is suitable for adding
* a 'data' object to with the result set and converting to JSON.
*/
Defined in .../Pager/Pager.php:366
⇄⧉public only(array $queries): self Sets only allowed queries on pagination links.
$value->only(array $queries)
/**
* Sets only allowed queries on pagination links.
*/
Defined in .../Pager/Pager.php:384
⧉protected displayLinks(string $group, string $template): string Does the actual work of displaying the view file. Used internally by links(),...
/**
* Does the actual work of displaying the view file. Used internally
* by links(), simpleLinks(), and makeLinks().
*/
Defined in .../Pager/Pager.php:121
⧉protected ensureGroup(string $group, ?int $perPage = null): void Ensures that an array exists for the group specified.
/**
* Ensures that an array exists for the group specified.
*
* @return void
*/
Defined in .../Pager/Pager.php:396
⧉protected calculateCurrentPage(string $group): void Calculating the current page
/**
* Calculating the current page
*
* @return void
*/
Defined in .../Pager/Pager.php:424
