| @@ -2,12 +2,9 @@ | ||
| 2 | 2 | |
| 3 | 3 | namespace FluentSupport\App\Modules; |
| 4 | 4 | |
| 5 | 5 | /** |
| 6 | - * IntegrationSettingsModule class is responsible for getting/setting Settings related to integration | |
| 7 | - * @package FluentSupport\App\Modules | |
| 8 | - * | |
| 9 | - * @version 1.0.0 | |
| 6 | + * Registry of notification integrations and their settings. | |
| 10 | 7 | */ |
| 11 | 8 | class IntegrationSettingsModule |
| 12 | 9 | { |
| 13 | 10 | private static $integrations = []; |
| @@ -12,12 +9,11 @@ | ||
| 12 | 9 | { |
| 13 | 10 | private static $integrations = []; |
| 14 | 11 | |
| 15 | 12 | /** |
| 16 | - * getSettings will return settings for a specific integration key | |
| 17 | - * @param $integrationKey | |
| 18 | - * @param false $withFields | |
| 19 | - * @return false | |
| 13 | + * @param string $integrationKey | |
| 14 | + * @param bool $withFields | |
| 15 | + * @return mixed|false False when the integration isn't registered. | |
| 20 | 16 | */ |
| 21 | 17 | public static function getSettings($integrationKey, $withFields = false) |
| 22 | 18 | { |
| 23 | 19 | $integrationClasses = self::$integrations; |
| @@ -31,12 +27,11 @@ | ||
| 31 | 27 | return $class->getSettings($withFields); |
| 32 | 28 | } |
| 33 | 29 | |
| 34 | 30 | /** |
| 35 | - * saveSettings save integration settings by integration_key | |
| 36 | - * @param $integrationKey | |
| 37 | - * @param $settings | |
| 38 | - * @return false || object | |
| 31 | + * @param string $integrationKey | |
| 32 | + * @param array $settings | |
| 33 | + * @return mixed|false False when the integration isn't registered. | |
| 39 | 34 | */ |
| 40 | 35 | public static function saveSettings($integrationKey, $settings) |
| 41 | 36 | { |
| 42 | 37 | $integrationClasses = self::$integrations; |
| @@ -50,10 +45,9 @@ | ||
| 50 | 45 | return $class->saveSettings($settings); |
| 51 | 46 | } |
| 52 | 47 | |
| 53 | 48 | /** |
| 54 | - * addIntegration add integration classes into the self property list | |
| 55 | - * @param $class | |
| 49 | + * @param \FluentSupport\App\Services\Integrations\NotificationIntegrationBase $class | |
| 56 | 50 | */ |
| 57 | 51 | public static function addIntegration($class) |
| 58 | 52 | { |
| 59 | 53 | self::$integrations[$class->getKey()] = $class; |