[5.x] Fix facade PhpDocs for better understanding by Laravel Idea (#11798)

adelf · web-flow · commit 116f21406a71 · 2025-05-20T13:51:20.000-04:00
diff --git a/src/Facades/Blink.php b/src/Facades/Blink.php
@@ -24,7 +24,7 @@
  * @method static mixed once($key, callable $callable)
  * @method static mixed|\Spatie\Blink\Blink store($name = 'default')
  *
- * @see Statamic\Support\Blink
+ * @see \Statamic\Support\Blink
  */
 class Blink extends Facade
 {
diff --git a/src/Facades/Blueprint.php b/src/Facades/Blueprint.php
@@ -25,7 +25,7 @@
  * @method static \Illuminate\Support\Collection getAdditionalNamespaces()
  *
  * @see \Statamic\Fields\BlueprintRepository
- * @see \Statamic\Fields\Blueprint
+ * @link \Statamic\Fields\Blueprint
  */
 class Blueprint extends Facade
 {
diff --git a/src/Facades/Collection.php b/src/Facades/Collection.php
@@ -22,7 +22,7 @@
  * @method static \Illuminate\Support\Collection getComputedCallbacks($collection)
  *
  * @see CollectionRepository
- * @see \Statamic\Entries\Collection
+ * @link \Statamic\Entries\Collection
  */
 class Collection extends Facade
 {
diff --git a/src/Facades/Entry.php b/src/Facades/Entry.php
@@ -26,9 +26,9 @@
  * @method static void updateParents(\Statamic\Entries\Collection $collection, $ids = null)
  *
  * @see \Statamic\Stache\Repositories\EntryRepository
- * @see \Statamic\Stache\Query\EntryQueryBuilder
- * @see \Statamic\Entries\EntryCollection
- * @see \Statamic\Entries\Entry
+ * @link \Statamic\Stache\Query\EntryQueryBuilder
+ * @link \Statamic\Entries\EntryCollection
+ * @link \Statamic\Entries\Entry
  */
 class Entry extends Facade
 {
diff --git a/src/Facades/Fieldset.php b/src/Facades/Fieldset.php
@@ -19,7 +19,7 @@
  * @method static void addNamespace(string $namespace, string $directory)
  *
  * @see \Statamic\Fields\FieldsetRepository
- * @see \Statamic\Fields\Fieldset
+ * @link \Statamic\Fields\Fieldset
  */
 class Fieldset extends Facade
 {
diff --git a/src/Facades/Form.php b/src/Facades/Form.php
@@ -20,7 +20,7 @@
  * @method static ExporterRepository exporters()
  *
  * @see \Statamic\Contracts\Forms\FormRepository
- * @see \Statamic\Forms\Form
+ * @link \Statamic\Forms\Form
  */
 class Form extends Facade
 {
diff --git a/src/Facades/FormSubmission.php b/src/Facades/FormSubmission.php
@@ -19,7 +19,7 @@
  * @method static SubmissionContract make()
  *
  * @see \Statamic\Contracts\Forms\SubmissionRepository
- * @see \Statamic\Forms\Submission
+ * @link \Statamic\Forms\Submission
  */
 class FormSubmission extends Facade
 {
diff --git a/src/Facades/GlobalSet.php b/src/Facades/GlobalSet.php
@@ -14,7 +14,7 @@
  * @method static void delete(\Statamic\Contracts\Globals\GlobalSet $global)
  *
  * @see \Statamic\Stache\Repositories\GlobalRepository
- * @see \Statamic\Globals\GlobalSet
+ * @link \Statamic\Globals\GlobalSet
  */
 class GlobalSet extends Facade
 {
diff --git a/src/Facades/GlobalVariables.php b/src/Facades/GlobalVariables.php
@@ -14,7 +14,7 @@
  * @method static void delete(\Statamic\Globals\Variables $variable)
  *
  * @see \Statamic\Stache\Repositories\GlobalVariablesRepository
- * @see \Statamic\Globals\Variables
+ * @link \Statamic\Globals\Variables
  */
 class GlobalVariables extends Facade
 {
diff --git a/src/Facades/Revision.php b/src/Facades/Revision.php
@@ -14,7 +14,7 @@
  * @method static void delete(\Statamic\Contracts\Revisions\Revision $revision)
  *
  * @see \Statamic\Revisions\RevisionRepository
- * @see \Statamic\Revisions\Revision
+ * @link \Statamic\Revisions\Revision
  */
 class Revision extends Facade
 {
diff --git a/src/Facades/Role.php b/src/Facades/Role.php
@@ -15,7 +15,7 @@
  * @method static void delete(\Statamic\Contracts\Auth\Role $role)
  *
  * @see \Statamic\Contracts\Auth\RoleRepository
- * @see \Statamic\Auth\Role
+ * @link \Statamic\Auth\Role
  */
 class Role extends Facade
 {
diff --git a/src/Facades/Search.php b/src/Facades/Search.php
@@ -15,7 +15,7 @@
  * @method static void deleteFromIndexes(Searchable $searchable)
  *
  * @see \Statamic\Search\Search
- * @see \Statamic\Search\Index
+ * @link \Statamic\Search\Index
  */
 class Search extends Facade
 {
diff --git a/src/Facades/StaticCache.php b/src/Facades/StaticCache.php
@@ -21,7 +21,7 @@
  * @method static void includeJs()
  *
  * @see StaticCacheManager
- * @see Cacher
+ * @link Cacher
  */
 class StaticCache extends Facade
 {
diff --git a/src/Facades/Structure.php b/src/Facades/Structure.php
@@ -13,7 +13,7 @@
  * @method static void delete(Structure $structure)
  *
  * @see \Statamic\Contracts\Structures\StructureRepository
- * @see \Statamic\Structures\Structure
+ * @link \Statamic\Structures\Structure
  */
 class Structure extends Facade
 {
diff --git a/src/Facades/Taxonomy.php b/src/Facades/Taxonomy.php
@@ -20,7 +20,7 @@
  * @method static additionalPreviewTargets(string $handle)
  *
  * @see \Statamic\Stache\Repositories\TaxonomyRepository
- * @see \Statamic\Taxonomies\Taxonomy
+ * @link \Statamic\Taxonomies\Taxonomy
  */
 class Taxonomy extends Facade
 {
diff --git a/src/Facades/Term.php b/src/Facades/Term.php
@@ -24,7 +24,7 @@
  * @method static \Illuminate\Support\Collection applySubstitutions($items)
  *
  * @see \Statamic\Contracts\Taxonomies\TermRepository
- * @see \Statamic\Taxonomies\Term
+ * @link \Statamic\Taxonomies\Term
  */
 class Term extends Facade
 {
diff --git a/src/Facades/User.php b/src/Facades/User.php
@@ -24,7 +24,7 @@
  * @method static void computed(string|array $field, ?\Closure $callback = null)
  *
  * @see \Statamic\Contracts\Auth\UserRepository
- * @see \Statamic\Auth\User
+ * @link \Statamic\Auth\User
  */
 class User extends Facade
 {
diff --git a/src/Facades/UserGroup.php b/src/Facades/UserGroup.php
@@ -14,7 +14,7 @@
  * @method static \Statamic\Fields\Blueprint blueprint()
  *
  * @see \Statamic\Contracts\Auth\UserGroupRepository
- * @see \Statamic\Auth\UserGroup
+ * @link \Statamic\Auth\UserGroup
  */
 class UserGroup extends Facade
 {

Original file line number	Diff line number	Diff line change
`@@ -24,7 +24,7 @@`
`24`	`24`	`* @method static mixed once($key, callable $callable)`
`25`	`25`	`* @method static mixed\|\Spatie\Blink\Blink store($name = 'default')`
`26`	`26`	`*`
`27`		`- * @see Statamic\Support\Blink`
	`27`	`+ * @see \Statamic\Support\Blink`
`28`	`28`	`*/`
`29`	`29`	`class Blink extends Facade`
`30`	`30`	`{`
Original file line number	Diff line number	Diff line change
`@@ -25,7 +25,7 @@`
`25`	`25`	`* @method static \Illuminate\Support\Collection getAdditionalNamespaces()`
`26`	`26`	`*`
`27`	`27`	`* @see \Statamic\Fields\BlueprintRepository`
`28`		`- * @see \Statamic\Fields\Blueprint`
	`28`	`+ * @link \Statamic\Fields\Blueprint`
`29`	`29`	`*/`
`30`	`30`	`class Blueprint extends Facade`
`31`	`31`	`{`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@`
`22`	`22`	`* @method static \Illuminate\Support\Collection getComputedCallbacks($collection)`
`23`	`23`	`*`
`24`	`24`	`* @see CollectionRepository`
`25`		`- * @see \Statamic\Entries\Collection`
	`25`	`+ * @link \Statamic\Entries\Collection`
`26`	`26`	`*/`
`27`	`27`	`class Collection extends Facade`
`28`	`28`	`{`
Original file line number	Diff line number	Diff line change
`@@ -26,9 +26,9 @@`
`26`	`26`	`* @method static void updateParents(\Statamic\Entries\Collection $collection, $ids = null)`
`27`	`27`	`*`
`28`	`28`	`* @see \Statamic\Stache\Repositories\EntryRepository`
`29`		`- * @see \Statamic\Stache\Query\EntryQueryBuilder`
`30`		`- * @see \Statamic\Entries\EntryCollection`
`31`		`- * @see \Statamic\Entries\Entry`
	`29`	`+ * @link \Statamic\Stache\Query\EntryQueryBuilder`
	`30`	`+ * @link \Statamic\Entries\EntryCollection`
	`31`	`+ * @link \Statamic\Entries\Entry`
`32`	`32`	`*/`
`33`	`33`	`class Entry extends Facade`
`34`	`34`	`{`
Original file line number	Diff line number	Diff line change
`@@ -19,7 +19,7 @@`
`19`	`19`	`* @method static void addNamespace(string $namespace, string $directory)`
`20`	`20`	`*`
`21`	`21`	`* @see \Statamic\Fields\FieldsetRepository`
`22`		`- * @see \Statamic\Fields\Fieldset`
	`22`	`+ * @link \Statamic\Fields\Fieldset`
`23`	`23`	`*/`
`24`	`24`	`class Fieldset extends Facade`
`25`	`25`	`{`
Original file line number	Diff line number	Diff line change
`@@ -20,7 +20,7 @@`
`20`	`20`	`* @method static ExporterRepository exporters()`
`21`	`21`	`*`
`22`	`22`	`* @see \Statamic\Contracts\Forms\FormRepository`
`23`		`- * @see \Statamic\Forms\Form`
	`23`	`+ * @link \Statamic\Forms\Form`
`24`	`24`	`*/`
`25`	`25`	`class Form extends Facade`
`26`	`26`	`{`
Original file line number	Diff line number	Diff line change
`@@ -14,7 +14,7 @@`
`14`	`14`	`* @method static void delete(\Statamic\Contracts\Globals\GlobalSet $global)`
`15`	`15`	`*`
`16`	`16`	`* @see \Statamic\Stache\Repositories\GlobalRepository`
`17`		`- * @see \Statamic\Globals\GlobalSet`
	`17`	`+ * @link \Statamic\Globals\GlobalSet`
`18`	`18`	`*/`
`19`	`19`	`class GlobalSet extends Facade`
`20`	`20`	`{`
Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`* @method static void delete(\Statamic\Contracts\Auth\Role $role)`
`16`	`16`	`*`
`17`	`17`	`* @see \Statamic\Contracts\Auth\RoleRepository`
`18`		`- * @see \Statamic\Auth\Role`
	`18`	`+ * @link \Statamic\Auth\Role`
`19`	`19`	`*/`
`20`	`20`	`class Role extends Facade`
`21`	`21`	`{`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@`
`21`	`21`	`* @method static void includeJs()`
`22`	`22`	`*`
`23`	`23`	`* @see StaticCacheManager`
`24`		`- * @see Cacher`
	`24`	`+ * @link Cacher`
`25`	`25`	`*/`
`26`	`26`	`class StaticCache extends Facade`
`27`	`27`	`{`
Original file line number	Diff line number	Diff line change
`@@ -13,7 +13,7 @@`
`13`	`13`	`* @method static void delete(Structure $structure)`
`14`	`14`	`*`
`15`	`15`	`* @see \Statamic\Contracts\Structures\StructureRepository`
`16`		`- * @see \Statamic\Structures\Structure`
	`16`	`+ * @link \Statamic\Structures\Structure`
`17`	`17`	`*/`
`18`	`18`	`class Structure extends Facade`
`19`	`19`	`{`