MDL-81233 core: Include phpstorm meta info

This allows IDEs such as phpstorm, and vscode, to determine class
information for classes returned from the DI Container.

.gitignore

@@ -26,6 +26,7 @@
 /.patches/
 /.idea/
 .phpstorm.*
+!.phpstorm.meta.php
 /nbproject/
 CVS
 .DS_Store

.phpstorm.meta.php

@@ -0,0 +1,40 @@
+<?php
+// This file is part of Moodle - http://moodle.org/
+//
+// Moodle is free software: you can redistribute it and/or modify
+// it under the terms of the GNU General Public License as published by
+// the Free Software Foundation, either version 3 of the License, or
+// (at your option) any later version.
+//
+// Moodle is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+// GNU General Public License for more details.
+//
+// You should have received a copy of the GNU General Public License
+// along with Moodle.  If not, see <http://www.gnu.org/licenses/>.
+
+/**
+ * Helper file for PhpStorm, and other IDEs, to provide better code completion.
+ *
+ * @package   core
+ * @copyright 2024 Andrew Lyons <[email protected]>
+ * @license   http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
+ */
+
+namespace PHPSTORM_META;
+
+// Assume that anything returned by \core\di::get('...') is an instance of the first argument.
+override(\core\di::get(0), map([
+    '' => '@',
+]));
+
+// Assume that anything returned by \Psr\Container\ContainerInterface::get('...') is an instance of the first argument.
+override(\Psr\Container\ContainerInterface::get(0), map([
+    '' => '@',
+]));
+
+// Assume that anything returned by \DI\Container::get('...') is an instance of the first argument.
+override(\DI\Container::get(0), map([
+    '' => '@',
+]));