Skip to content

Commit f1a8c99

Browse files
riasvdvriasvdv
committed
Update Facade docblocks
1 parent 4f88185 commit f1a8c99

File tree

6 files changed

+110
-16
lines changed

6 files changed

+110
-16
lines changed

‎src/Support/Facades/Entries.php‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,11 @@
77
use Illuminate\Support\Facades\Facade;
88

99
/**
10+
* @method static \CraftCms\Cms\Entry\Elements\Entry|null getEntryById(int $entryId, int|string|int[]|null $siteId = null, array $criteria = [])
11+
* @method static array getSingleEntriesByHandle(string[] $handles)
12+
* @method static void refreshSingleEntries()
13+
* @method static bool moveEntryToSection(\CraftCms\Cms\Entry\Elements\Entry $entry, \CraftCms\Cms\Section\Data\Section $section)
14+
*
1015
* @see \CraftCms\Cms\Entry\Entries
1116
*/
1217
final class Entries extends Facade

‎src/Support/Facades/SiteGroups.php‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,16 @@
77
use Illuminate\Support\Facades\Facade;
88

99
/**
10+
* @method static \Illuminate\Support\Collection getAllGroups()
11+
* @method static \CraftCms\Cms\Site\Data\SiteGroup|null getGroupById(int $groupId)
12+
* @method static \CraftCms\Cms\Site\Data\SiteGroup|null getGroupByUid(string $uid)
13+
* @method static bool saveGroup(\CraftCms\Cms\Site\Data\SiteGroup $group)
14+
* @method static void handleChangedGroup(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
15+
* @method static void handleDeletedGroup(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
16+
* @method static bool deleteGroupById(int $groupId)
17+
* @method static bool deleteGroup(\CraftCms\Cms\Site\Data\SiteGroup $group)
18+
* @method static void refreshGroups()
19+
*
1020
* @see \CraftCms\Cms\Site\SiteGroups
1121
*/
1222
final class SiteGroups extends Facade

‎src/Support/Facades/Sites.php‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,35 @@
77
use Illuminate\Support\Facades\Facade;
88

99
/**
10+
* @method static bool isMultiSite(bool $refresh = false, bool $withTrashed = false)
11+
* @method static bool isMultiSiteWithTrashed(bool $refresh = false)
12+
* @method static \Illuminate\Support\Collection getAllSiteIds(bool|null $withDisabled = null)
13+
* @method static \CraftCms\Cms\Site\Data\Site getSiteByUid(string $uid, bool|null $withDisabled = null)
14+
* @method static bool getHasCurrentSite()
15+
* @method static \CraftCms\Cms\Site\Data\Site getCurrentSite()
16+
* @method static void setCurrentSite(\CraftCms\Cms\Site\Data\Site|string|int|null $site)
17+
* @method static \CraftCms\Cms\Site\Data\Site getPrimarySite()
18+
* @method static \Illuminate\Support\Collection getEditableSiteIds()
19+
* @method static \Illuminate\Support\Collection getEditableSiteIdsForSection(\CraftCms\Cms\Section\Data\Section $section)
20+
* @method static \Illuminate\Support\Collection getAllSites(bool|null $withDisabled = null)
21+
* @method static \Illuminate\Support\Collection getEditableSites()
22+
* @method static \Illuminate\Support\Collection getSitesByGroupId(int $groupId, bool|null $withDisabled = null)
23+
* @method static \Illuminate\Support\Collection getEditableSitesByGroupId(int $groupId, bool|null $withDisabled = null)
24+
* @method static int getTotalSites()
25+
* @method static int getTotalEditableSites()
26+
* @method static \CraftCms\Cms\Site\Data\Site|null getSiteById(int $siteId, bool|null $withDisabled = null)
27+
* @method static \CraftCms\Cms\Site\Data\Site|null getSiteByHandle(string $siteHandle, bool|null $withDisabled = null)
28+
* @method static \Illuminate\Support\Collection getSitesByLanguage(string $language, bool|null $withDisabled = null)
29+
* @method static int getRemainingSites()
30+
* @method static bool saveSite(\CraftCms\Cms\Site\Data\Site $site)
31+
* @method static void handleChangedSite(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
32+
* @method static bool reorderSites(int[] $siteIds)
33+
* @method static bool deleteSiteById(int $siteId, int|null $transferContentTo = null)
34+
* @method static bool deleteSite(\CraftCms\Cms\Site\Data\Site $site, int|null $transferContentTo = null)
35+
* @method static void handleDeletedSite(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
36+
* @method static bool restoreSiteById(int $id)
37+
* @method static void refreshSites()
38+
*
1039
* @see \CraftCms\Cms\Site\Sites
1140
*/
1241
final class Sites extends Facade

‎src/Support/Facades/UserGroups.php‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -4,27 +4,23 @@
44

55
namespace CraftCms\Cms\Support\Facades;
66

7-
use CraftCms\Cms\ProjectConfig\Events\ConfigEvent;
8-
use CraftCms\Cms\User\Data\UserGroup;
9-
use CraftCms\Cms\User\Elements\User;
10-
use Illuminate\Support\Collection;
117
use Illuminate\Support\Facades\Facade;
128
use Override;
139

1410
/**
15-
* @method static Collection getAllGroups()
16-
* @method static Collection getAssignableGroups(User|null $user = null)
17-
* @method static UserGroup|null getGroupById(int $groupId)
18-
* @method static UserGroup|null getGroupByUid(string $uid)
19-
* @method static UserGroup|null getGroupByHandle(string $groupHandle)
20-
* @method static UserGroup getTeamGroup()
21-
* @method static Collection getGroupsByUserId(int $userId)
22-
* @method static void eagerLoadGroups(User[] $users)
23-
* @method static bool saveGroup(UserGroup $group)
24-
* @method static void handleChangedUserGroup(ConfigEvent $event)
25-
* @method static void handleDeletedUserGroup(ConfigEvent $event)
11+
* @method static \Illuminate\Support\Collection getAllGroups()
12+
* @method static \Illuminate\Support\Collection getAssignableGroups(\CraftCms\Cms\User\Elements\User|null $user = null)
13+
* @method static \CraftCms\Cms\User\Data\UserGroup|null getGroupById(int $groupId)
14+
* @method static \CraftCms\Cms\User\Data\UserGroup|null getGroupByUid(string $uid)
15+
* @method static \CraftCms\Cms\User\Data\UserGroup|null getGroupByHandle(string $groupHandle)
16+
* @method static \CraftCms\Cms\User\Data\UserGroup getTeamGroup()
17+
* @method static \Illuminate\Support\Collection getGroupsByUserId(int $userId)
18+
* @method static void eagerLoadGroups(\CraftCms\Cms\User\Elements\User[] $users)
19+
* @method static bool saveGroup(\CraftCms\Cms\User\Data\UserGroup $group)
20+
* @method static void handleChangedUserGroup(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
21+
* @method static void handleDeletedUserGroup(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
2622
* @method static bool deleteGroupById(int $groupId)
27-
* @method static bool deleteGroup(UserGroup $group)
23+
* @method static bool deleteGroup(\CraftCms\Cms\User\Data\UserGroup $group)
2824
*
2925
* @see \CraftCms\Cms\User\UserGroups
3026
*/

‎src/Support/Facades/UserPermissions.php‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,19 @@
88
use Override;
99

1010
/**
11+
* @method static \Illuminate\Support\Collection getAllPermissions()
12+
* @method static \Illuminate\Support\Collection getAssignablePermissions(\CraftCms\Cms\User\Elements\User|null $user = null)
13+
* @method static \Illuminate\Support\Collection getPermissionsByGroupId(int $groupId)
14+
* @method static \Illuminate\Support\Collection getGroupPermissionsByUserId(int $userId)
15+
* @method static bool doesGroupHavePermission(int $groupId, string $checkPermission)
16+
* @method static bool saveGroupPermissions(int $groupId, array $permissions)
17+
* @method static \Illuminate\Support\Collection getPermissionsByUserId(int $userId)
18+
* @method static bool validatePermission(string $permission)
19+
* @method static bool doesUserHavePermission(int $userId, string $checkPermission)
20+
* @method static bool saveUserPermissions(int $userId, array $permissions)
21+
* @method static void handleChangedGroupPermissions(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
22+
* @method static void reset()
23+
*
1124
* @see \CraftCms\Cms\User\UserPermissions
1225
*/
1326
final class UserPermissions extends Facade

‎src/Support/Facades/Users.php‎

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,47 @@
88
use Override;
99

1010
/**
11+
* @method static \CraftCms\Cms\User\Elements\User ensureUserByEmail(string $email)
12+
* @method static \CraftCms\Cms\User\Elements\User|null getUserById(int $userId)
13+
* @method static \CraftCms\Cms\User\Elements\User|null getUserByUsernameOrEmail(string $usernameOrEmail)
14+
* @method static \CraftCms\Cms\User\Elements\User|null getUserByUid(string $uid)
15+
* @method static bool isVerificationCodeValidForUser(\CraftCms\Cms\User\Elements\User $user, string $code)
16+
* @method static array getUserPreferences(int $userId)
17+
* @method static void saveUserPreferences(\CraftCms\Cms\User\Elements\User $user, array $preferences)
18+
* @method static mixed getUserPreference(int $userId, string $key, mixed $default = null)
19+
* @method static bool sendActivationEmail(\CraftCms\Cms\User\Elements\User $user)
20+
* @method static bool sendNewEmailVerifyEmail(\CraftCms\Cms\User\Elements\User $user)
21+
* @method static bool sendPasswordResetEmail(\CraftCms\Cms\User\Elements\User $user)
22+
* @method static string getActivationUrl(\CraftCms\Cms\User\Elements\User $user)
23+
* @method static string getEmailVerifyUrl(\CraftCms\Cms\User\Elements\User $user)
24+
* @method static string getPasswordResetUrl(\CraftCms\Cms\User\Elements\User $user)
25+
* @method static void removeCredentials(\CraftCms\Cms\User\Elements\User $user)
26+
* @method static void saveUserPhoto(string $fileLocation, \CraftCms\Cms\User\Elements\User $user, string|null $filename = null, string|null $mimeType = null)
27+
* @method static void relocateUserPhoto(\CraftCms\Cms\User\Elements\User $user)
28+
* @method static bool deleteUserPhoto(\CraftCms\Cms\User\Elements\User $user)
29+
* @method static void handleValidLogin(\CraftCms\Cms\User\Elements\User $user)
30+
* @method static void handleInvalidLogin(\CraftCms\Cms\User\Elements\User $user)
31+
* @method static void activateUser(\CraftCms\Cms\User\Elements\User $user)
32+
* @method static void deactivateUser(\CraftCms\Cms\User\Elements\User $user)
33+
* @method static void verifyEmailForUser(\CraftCms\Cms\User\Elements\User $user)
34+
* @method static void unlockUser(\CraftCms\Cms\User\Elements\User $user)
35+
* @method static void suspendUser(\CraftCms\Cms\User\Elements\User $user)
36+
* @method static void unsuspendUser(\CraftCms\Cms\User\Elements\User $user)
37+
* @method static void shunMessageForUser(int $userId, string $message, \DateTime|null $expiryDate = null)
38+
* @method static void unshunMessageForUser(int $userId, string $message)
39+
* @method static bool hasUserShunnedMessage(int $userId, string $message)
40+
* @method static string setVerificationCodeOnUser(\CraftCms\Cms\User\Elements\User $user)
41+
* @method static void purgeExpiredPendingUsers()
42+
* @method static bool assignUserToGroups(int $userId, int[] $groupIds)
43+
* @method static \CraftCms\Cms\User\Data\UserGroup[] getDefaultUserGroups(\CraftCms\Cms\User\Elements\User $user)
44+
* @method static bool assignUserToDefaultGroup(\CraftCms\Cms\User\Elements\User $user)
45+
* @method static void handleChangedUserFieldLayout(\CraftCms\Cms\ProjectConfig\Events\ConfigEvent $event)
46+
* @method static bool saveLayout(\craft\models\FieldLayout $layout, bool $runValidation = true)
47+
* @method static bool canImpersonate(\CraftCms\Cms\User\Elements\User $impersonator, \CraftCms\Cms\User\Elements\User $impersonatee)
48+
* @method static bool canSuspend(\CraftCms\Cms\User\Elements\User $suspender, \CraftCms\Cms\User\Elements\User $suspendee)
49+
* @method static int|null getMaxUsers(\CraftCms\Cms\Edition $edition)
50+
* @method static bool canCreateUsers()
51+
*
1152
* @see \CraftCms\Cms\User\Users
1253
*/
1354
final class Users extends Facade

0 commit comments

Comments
 (0)