Merge pull request #499 from francislavoie/patch-2

Fix docblocks in App
This commit is contained in:
rennokki 2020-09-04 16:54:29 +03:00 committed by GitHub
commit 06c898a005
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 13 additions and 13 deletions

View File

@ -6,7 +6,7 @@ use BeyondCode\LaravelWebSockets\Exceptions\InvalidApp;
class App class App
{ {
/** @var int */ /** @var string|int */
public $id; public $id;
/** @var string */ /** @var string */
@ -39,7 +39,7 @@ class App
/** /**
* Find the app by id. * Find the app by id.
* *
* @param mixed $appId * @param string|int $appId
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public static function findById($appId) public static function findById($appId)
@ -50,7 +50,7 @@ class App
/** /**
* Find the app by app key. * Find the app by app key.
* *
* @param mixed $appId * @param string $appKey
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public static function findByKey($appKey): ?self public static function findByKey($appKey): ?self
@ -61,7 +61,7 @@ class App
/** /**
* Find the app by app secret. * Find the app by app secret.
* *
* @param mixed $appId * @param string $appSecret
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public static function findBySecret($appSecret): ?self public static function findBySecret($appSecret): ?self
@ -72,9 +72,9 @@ class App
/** /**
* Initialize the Web Socket app instance. * Initialize the Web Socket app instance.
* *
* @param mixed $appId * @param string|int $appId
* @param mixed $key * @param string $key
* @param mixed $secret * @param string $secret
* @return void * @return void
* @throws \BeyondCode\LaravelWebSockets\Exceptions\InvalidApp * @throws \BeyondCode\LaravelWebSockets\Exceptions\InvalidApp
*/ */

View File

@ -14,7 +14,7 @@ interface AppManager
/** /**
* Get app by id. * Get app by id.
* *
* @param mixed $appId * @param string|int $appId
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findById($appId): ?App; public function findById($appId): ?App;
@ -22,7 +22,7 @@ interface AppManager
/** /**
* Get app by app key. * Get app by app key.
* *
* @param mixed $appKey * @param string $appKey
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findByKey($appKey): ?App; public function findByKey($appKey): ?App;
@ -30,7 +30,7 @@ interface AppManager
/** /**
* Get app by secret. * Get app by secret.
* *
* @param mixed $appSecret * @param string $appSecret
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findBySecret($appSecret): ?App; public function findBySecret($appSecret): ?App;

View File

@ -38,7 +38,7 @@ class ConfigAppManager implements AppManager
/** /**
* Get app by id. * Get app by id.
* *
* @param mixed $appId * @param string|int $appId
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findById($appId): ?App public function findById($appId): ?App
@ -53,7 +53,7 @@ class ConfigAppManager implements AppManager
/** /**
* Get app by app key. * Get app by app key.
* *
* @param mixed $appKey * @param string $appKey
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findByKey($appKey): ?App public function findByKey($appKey): ?App
@ -68,7 +68,7 @@ class ConfigAppManager implements AppManager
/** /**
* Get app by secret. * Get app by secret.
* *
* @param mixed $appSecret * @param string $appSecret
* @return \BeyondCode\LaravelWebSockets\Apps\App|null * @return \BeyondCode\LaravelWebSockets\Apps\App|null
*/ */
public function findBySecret($appSecret): ?App public function findBySecret($appSecret): ?App