Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@u01jmg3
u01jmg3 committed Oct 10, 2023
1 parent 916ffaf commit eeb51c4
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 5 deletions.
5 changes: 2 additions & 3 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -164,8 +164,8 @@ need to be evaluated before non-fitting events can be dropped.
| `calendarDescription` | - | `public` | Returns the calendar description |
| `calendarName` | - | `public` | Returns the calendar name |
| `calendarTimeZone` | `$ignoreUtc` | `public` | Returns the calendar time zone |
| `cleanData` | `$data` | `protected` | Replaces curly quotes and other special characters with their standard equivalents |
| `eventsFromInterval` | `$interval` | `public` | Returns a sorted array of events following a given string, or `false` if no events exist in the range |
| `cleanCharacters` | `$data` | `protected` | Replaces curly quotes and other special characters with their standard equivalents |
| `eventsFromInterval` | `$interval` | `public` | Returns a sorted array of events following a given string |
| `eventsFromRange` | `$rangeStart = false`, `$rangeEnd = false` | `public` | Returns a sorted array of events in a given range, or an empty array if no events exist in the range |
| `events` | - | `public` | Returns an array of Events |
| `fileOrUrl` | `$filename` | `protected` | Reads an entire file or URL into an array |
Expand All @@ -192,7 +192,6 @@ need to be evaluated before non-fitting events can be dropped.
| `keyValueFromString` | `$text` | `public` | Gets the key value pair from an iCal string |
| `parseLine` | `$line` | `protected` | Parses a line from an iCal file into an array of tokens |
| `mb_chr` | `$code` | `protected` | Provides a polyfill for PHP 7.2's `mb_chr()`, which is a multibyte safe version of `chr()` |
| `mb_str_replace` | `$search`, `$replace`, `$subject`, `$count = 0` | `protected` | Replaces all occurrences of a search string with a given replacement string |
| `escapeParamText` | `$candidateText` | `protected` | Places double-quotes around texts that have characters not permitted in parameter-texts, but are permitted in quoted-texts. |
| `parseDuration` | `$date`, `$duration`, `$format = 'U'` | `protected` | Parses a duration and applies it to a date |
| `parseExdates` | `$event` | `public` | Parses a list of excluded dates to be applied to an Event |
Expand Down
3 changes: 1 addition & 2 deletions src/ICal/ICal.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -2272,8 +2272,7 @@ public function eventsFromRange($rangeStart = null, $rangeEnd = null)
}

/**
* Returns a sorted array of the events following a given string,
* or `false` if no events exist in the range.
* Returns a sorted array of the events following a given string
*
* @param string $interval
* @return array
Expand Down

1 comment on commit eeb51c4

@u01jmg3
Copy link
Owner Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Relates to 9df6990

Please sign in to comment.