diff options
| author | Daniel Weipert <code@drogueronin.de> | 2023-02-04 11:05:51 +0100 |
|---|---|---|
| committer | Daniel Weipert <code@drogueronin.de> | 2023-02-04 11:59:02 +0100 |
| commit | 1de5d9b89667fc299703ca49f695a1600c5a1fa6 (patch) | |
| tree | adbf3a813b74945060ed53201dfc785ab52cedf6 | |
| parent | 592d88077deae5f74fce452e0e256b430349a92b (diff) | |
Add phpdoc
| -rw-r--r-- | .gitignore | 2 | ||||
| -rw-r--r-- | phpdoc.xml | 16 | ||||
| -rw-r--r-- | src/Controllers/EntriesController.php | 7 |
3 files changed, 24 insertions, 1 deletions
@@ -1,5 +1,5 @@ +/.phpdoc/ /vendor/ /content/ /plugins/ /config.yaml - diff --git a/phpdoc.xml b/phpdoc.xml new file mode 100644 index 0000000..41b3baa --- /dev/null +++ b/phpdoc.xml @@ -0,0 +1,16 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<phpdocumentor + configVersion="3" + xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" + xmlns="https://www.phpdoc.org" + xsi:noNamespaceSchemaLocation="https://raw.githubusercontent.com/phpDocumentor/phpDocumentor/master/data/xsd/phpdoc.xsd" +> + <version number="latest"> + <api> + <source dsn="."> + <path>src</path> + </source> + <include-source>true</include-source> + </api> + </version> +</phpdocumentor> diff --git a/src/Controllers/EntriesController.php b/src/Controllers/EntriesController.php index f45866a..d9fdf1d 100644 --- a/src/Controllers/EntriesController.php +++ b/src/Controllers/EntriesController.php @@ -6,6 +6,13 @@ use Symfony\Component\Yaml\Yaml; class EntriesController { + /** + * Get the form's entries sorted by date + * + * @param string $formPath The path to the form + * + * @return array<string, array<string, array<string, array<int, Entry[]>>>> The entries sorted by date array<$year, array<$month, array<$day, $entry[]>>> + */ public function getEntries(string $formPath): array { /**@var Utilities $utilities*/ |