@@ -29,52 +29,52 @@ |
||
| 29 | 29 | * @since 13.0.0 |
| 30 | 30 | */ |
| 31 | 31 | abstract class SimpleMigrationStep implements IMigrationStep { |
| 32 | - /** |
|
| 33 | - * Human readable name of the migration step |
|
| 34 | - * |
|
| 35 | - * @return string |
|
| 36 | - * @since 14.0.0 |
|
| 37 | - */ |
|
| 38 | - public function name(): string { |
|
| 39 | - return ''; |
|
| 40 | - } |
|
| 32 | + /** |
|
| 33 | + * Human readable name of the migration step |
|
| 34 | + * |
|
| 35 | + * @return string |
|
| 36 | + * @since 14.0.0 |
|
| 37 | + */ |
|
| 38 | + public function name(): string { |
|
| 39 | + return ''; |
|
| 40 | + } |
|
| 41 | 41 | |
| 42 | - /** |
|
| 43 | - * Human readable description of the migration step |
|
| 44 | - * |
|
| 45 | - * @return string |
|
| 46 | - * @since 14.0.0 |
|
| 47 | - */ |
|
| 48 | - public function description(): string { |
|
| 49 | - return ''; |
|
| 50 | - } |
|
| 42 | + /** |
|
| 43 | + * Human readable description of the migration step |
|
| 44 | + * |
|
| 45 | + * @return string |
|
| 46 | + * @since 14.0.0 |
|
| 47 | + */ |
|
| 48 | + public function description(): string { |
|
| 49 | + return ''; |
|
| 50 | + } |
|
| 51 | 51 | |
| 52 | - /** |
|
| 53 | - * @param IOutput $output |
|
| 54 | - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 55 | - * @param array $options |
|
| 56 | - * @since 13.0.0 |
|
| 57 | - */ |
|
| 58 | - public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 59 | - } |
|
| 52 | + /** |
|
| 53 | + * @param IOutput $output |
|
| 54 | + * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 55 | + * @param array $options |
|
| 56 | + * @since 13.0.0 |
|
| 57 | + */ |
|
| 58 | + public function preSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 59 | + } |
|
| 60 | 60 | |
| 61 | - /** |
|
| 62 | - * @param IOutput $output |
|
| 63 | - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 64 | - * @param array $options |
|
| 65 | - * @return null|ISchemaWrapper |
|
| 66 | - * @since 13.0.0 |
|
| 67 | - */ |
|
| 68 | - public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 69 | - return null; |
|
| 70 | - } |
|
| 61 | + /** |
|
| 62 | + * @param IOutput $output |
|
| 63 | + * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 64 | + * @param array $options |
|
| 65 | + * @return null|ISchemaWrapper |
|
| 66 | + * @since 13.0.0 |
|
| 67 | + */ |
|
| 68 | + public function changeSchema(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 69 | + return null; |
|
| 70 | + } |
|
| 71 | 71 | |
| 72 | - /** |
|
| 73 | - * @param IOutput $output |
|
| 74 | - * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 75 | - * @param array $options |
|
| 76 | - * @since 13.0.0 |
|
| 77 | - */ |
|
| 78 | - public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 79 | - } |
|
| 72 | + /** |
|
| 73 | + * @param IOutput $output |
|
| 74 | + * @param \Closure $schemaClosure The `\Closure` returns a `ISchemaWrapper` |
|
| 75 | + * @param array $options |
|
| 76 | + * @since 13.0.0 |
|
| 77 | + */ |
|
| 78 | + public function postSchemaChange(IOutput $output, \Closure $schemaClosure, array $options) { |
|
| 79 | + } |
|
| 80 | 80 | } |
@@ -38,75 +38,75 @@ |
||
| 38 | 38 | use OCP\Settings\ISettings; |
| 39 | 39 | |
| 40 | 40 | class Admin implements ISettings { |
| 41 | - /** @var IConfig */ |
|
| 42 | - private $config; |
|
| 43 | - /** @var IL10N */ |
|
| 44 | - private $l; |
|
| 45 | - /** @var ThemingDefaults */ |
|
| 46 | - private $themingDefaults; |
|
| 47 | - /** @var IURLGenerator */ |
|
| 48 | - private $urlGenerator; |
|
| 49 | - /** @var ImageManager */ |
|
| 50 | - private $imageManager; |
|
| 41 | + /** @var IConfig */ |
|
| 42 | + private $config; |
|
| 43 | + /** @var IL10N */ |
|
| 44 | + private $l; |
|
| 45 | + /** @var ThemingDefaults */ |
|
| 46 | + private $themingDefaults; |
|
| 47 | + /** @var IURLGenerator */ |
|
| 48 | + private $urlGenerator; |
|
| 49 | + /** @var ImageManager */ |
|
| 50 | + private $imageManager; |
|
| 51 | 51 | |
| 52 | - public function __construct(IConfig $config, |
|
| 53 | - IL10N $l, |
|
| 54 | - ThemingDefaults $themingDefaults, |
|
| 55 | - IURLGenerator $urlGenerator, |
|
| 56 | - ImageManager $imageManager) { |
|
| 57 | - $this->config = $config; |
|
| 58 | - $this->l = $l; |
|
| 59 | - $this->themingDefaults = $themingDefaults; |
|
| 60 | - $this->urlGenerator = $urlGenerator; |
|
| 61 | - $this->imageManager = $imageManager; |
|
| 62 | - } |
|
| 52 | + public function __construct(IConfig $config, |
|
| 53 | + IL10N $l, |
|
| 54 | + ThemingDefaults $themingDefaults, |
|
| 55 | + IURLGenerator $urlGenerator, |
|
| 56 | + ImageManager $imageManager) { |
|
| 57 | + $this->config = $config; |
|
| 58 | + $this->l = $l; |
|
| 59 | + $this->themingDefaults = $themingDefaults; |
|
| 60 | + $this->urlGenerator = $urlGenerator; |
|
| 61 | + $this->imageManager = $imageManager; |
|
| 62 | + } |
|
| 63 | 63 | |
| 64 | - /** |
|
| 65 | - * @return TemplateResponse |
|
| 66 | - */ |
|
| 67 | - public function getForm(): TemplateResponse { |
|
| 68 | - $themable = true; |
|
| 69 | - $errorMessage = ''; |
|
| 70 | - $theme = $this->config->getSystemValue('theme', ''); |
|
| 71 | - if ($theme !== '') { |
|
| 72 | - $themable = false; |
|
| 73 | - $errorMessage = $this->l->t('You are already using a custom theme. Theming app settings might be overwritten by that.'); |
|
| 74 | - } |
|
| 64 | + /** |
|
| 65 | + * @return TemplateResponse |
|
| 66 | + */ |
|
| 67 | + public function getForm(): TemplateResponse { |
|
| 68 | + $themable = true; |
|
| 69 | + $errorMessage = ''; |
|
| 70 | + $theme = $this->config->getSystemValue('theme', ''); |
|
| 71 | + if ($theme !== '') { |
|
| 72 | + $themable = false; |
|
| 73 | + $errorMessage = $this->l->t('You are already using a custom theme. Theming app settings might be overwritten by that.'); |
|
| 74 | + } |
|
| 75 | 75 | |
| 76 | - $parameters = [ |
|
| 77 | - 'themable' => $themable, |
|
| 78 | - 'errorMessage' => $errorMessage, |
|
| 79 | - 'name' => $this->themingDefaults->getEntity(), |
|
| 80 | - 'url' => $this->themingDefaults->getBaseUrl(), |
|
| 81 | - 'slogan' => $this->themingDefaults->getSlogan(), |
|
| 82 | - 'color' => $this->themingDefaults->getColorPrimary(), |
|
| 83 | - 'uploadLogoRoute' => $this->urlGenerator->linkToRoute('theming.Theming.uploadImage'), |
|
| 84 | - 'canThemeIcons' => $this->imageManager->shouldReplaceIcons(), |
|
| 85 | - 'iconDocs' => $this->urlGenerator->linkToDocs('admin-theming-icons'), |
|
| 86 | - 'images' => $this->imageManager->getCustomImages(), |
|
| 87 | - 'imprintUrl' => $this->themingDefaults->getImprintUrl(), |
|
| 88 | - 'privacyUrl' => $this->themingDefaults->getPrivacyUrl(), |
|
| 89 | - ]; |
|
| 76 | + $parameters = [ |
|
| 77 | + 'themable' => $themable, |
|
| 78 | + 'errorMessage' => $errorMessage, |
|
| 79 | + 'name' => $this->themingDefaults->getEntity(), |
|
| 80 | + 'url' => $this->themingDefaults->getBaseUrl(), |
|
| 81 | + 'slogan' => $this->themingDefaults->getSlogan(), |
|
| 82 | + 'color' => $this->themingDefaults->getColorPrimary(), |
|
| 83 | + 'uploadLogoRoute' => $this->urlGenerator->linkToRoute('theming.Theming.uploadImage'), |
|
| 84 | + 'canThemeIcons' => $this->imageManager->shouldReplaceIcons(), |
|
| 85 | + 'iconDocs' => $this->urlGenerator->linkToDocs('admin-theming-icons'), |
|
| 86 | + 'images' => $this->imageManager->getCustomImages(), |
|
| 87 | + 'imprintUrl' => $this->themingDefaults->getImprintUrl(), |
|
| 88 | + 'privacyUrl' => $this->themingDefaults->getPrivacyUrl(), |
|
| 89 | + ]; |
|
| 90 | 90 | |
| 91 | - return new TemplateResponse('theming', 'settings-admin', $parameters, ''); |
|
| 92 | - } |
|
| 91 | + return new TemplateResponse('theming', 'settings-admin', $parameters, ''); |
|
| 92 | + } |
|
| 93 | 93 | |
| 94 | - /** |
|
| 95 | - * @return string the section ID, e.g. 'sharing' |
|
| 96 | - */ |
|
| 97 | - public function getSection(): string { |
|
| 98 | - return 'theming'; |
|
| 99 | - } |
|
| 94 | + /** |
|
| 95 | + * @return string the section ID, e.g. 'sharing' |
|
| 96 | + */ |
|
| 97 | + public function getSection(): string { |
|
| 98 | + return 'theming'; |
|
| 99 | + } |
|
| 100 | 100 | |
| 101 | - /** |
|
| 102 | - * @return int whether the form should be rather on the top or bottom of |
|
| 103 | - * the admin section. The forms are arranged in ascending order of the |
|
| 104 | - * priority values. It is required to return a value between 0 and 100. |
|
| 105 | - * |
|
| 106 | - * E.g.: 70 |
|
| 107 | - */ |
|
| 108 | - public function getPriority(): int { |
|
| 109 | - return 5; |
|
| 110 | - } |
|
| 101 | + /** |
|
| 102 | + * @return int whether the form should be rather on the top or bottom of |
|
| 103 | + * the admin section. The forms are arranged in ascending order of the |
|
| 104 | + * priority values. It is required to return a value between 0 and 100. |
|
| 105 | + * |
|
| 106 | + * E.g.: 70 |
|
| 107 | + */ |
|
| 108 | + public function getPriority(): int { |
|
| 109 | + return 5; |
|
| 110 | + } |
|
| 111 | 111 | |
| 112 | 112 | } |
@@ -33,17 +33,17 @@ |
||
| 33 | 33 | * @since 14.0.0 |
| 34 | 34 | */ |
| 35 | 35 | interface ILogFactory { |
| 36 | - /** |
|
| 37 | - * @param string $type - one of: file, errorlog, syslog, systemd |
|
| 38 | - * @return IWriter |
|
| 39 | - * @since 14.0.0 |
|
| 40 | - */ |
|
| 41 | - public function get(string $type): IWriter; |
|
| 36 | + /** |
|
| 37 | + * @param string $type - one of: file, errorlog, syslog, systemd |
|
| 38 | + * @return IWriter |
|
| 39 | + * @since 14.0.0 |
|
| 40 | + */ |
|
| 41 | + public function get(string $type): IWriter; |
|
| 42 | 42 | |
| 43 | - /** |
|
| 44 | - * @param string $path |
|
| 45 | - * @return ILogger |
|
| 46 | - * @since 14.0.0 |
|
| 47 | - */ |
|
| 48 | - public function getCustomLogger(string $path): ILogger; |
|
| 43 | + /** |
|
| 44 | + * @param string $path |
|
| 45 | + * @return ILogger |
|
| 46 | + * @since 14.0.0 |
|
| 47 | + */ |
|
| 48 | + public function getCustomLogger(string $path): ILogger; |
|
| 49 | 49 | } |
@@ -35,31 +35,31 @@ |
||
| 35 | 35 | */ |
| 36 | 36 | class RSAPrivateKey extends AuthMechanism { |
| 37 | 37 | |
| 38 | - /** @var IConfig */ |
|
| 39 | - private $config; |
|
| 38 | + /** @var IConfig */ |
|
| 39 | + private $config; |
|
| 40 | 40 | |
| 41 | - public function __construct(IL10N $l, IConfig $config) { |
|
| 42 | - $this->config = $config; |
|
| 41 | + public function __construct(IL10N $l, IConfig $config) { |
|
| 42 | + $this->config = $config; |
|
| 43 | 43 | |
| 44 | - $this |
|
| 45 | - ->setIdentifier('publickey::rsa_private') |
|
| 46 | - ->setScheme(self::SCHEME_PUBLICKEY) |
|
| 47 | - ->setText($l->t('RSA private key')) |
|
| 48 | - ->addParameters([ |
|
| 49 | - new DefinitionParameter('user', $l->t('Username')), |
|
| 50 | - (new DefinitionParameter('password', $l->t('Password'))) |
|
| 51 | - ->setFlag(DefinitionParameter::FLAG_OPTIONAL) |
|
| 52 | - ->setType(DefinitionParameter::VALUE_PASSWORD), |
|
| 53 | - new DefinitionParameter('private_key', $l->t('Private key')), |
|
| 54 | - ]); |
|
| 55 | - } |
|
| 44 | + $this |
|
| 45 | + ->setIdentifier('publickey::rsa_private') |
|
| 46 | + ->setScheme(self::SCHEME_PUBLICKEY) |
|
| 47 | + ->setText($l->t('RSA private key')) |
|
| 48 | + ->addParameters([ |
|
| 49 | + new DefinitionParameter('user', $l->t('Username')), |
|
| 50 | + (new DefinitionParameter('password', $l->t('Password'))) |
|
| 51 | + ->setFlag(DefinitionParameter::FLAG_OPTIONAL) |
|
| 52 | + ->setType(DefinitionParameter::VALUE_PASSWORD), |
|
| 53 | + new DefinitionParameter('private_key', $l->t('Private key')), |
|
| 54 | + ]); |
|
| 55 | + } |
|
| 56 | 56 | |
| 57 | - public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
| 58 | - $auth = new RSACrypt(); |
|
| 59 | - $auth->setPassword($this->config->getSystemValue('secret', '')); |
|
| 60 | - if (!$auth->loadKey($storage->getBackendOption('private_key'))) { |
|
| 61 | - throw new \RuntimeException('unable to load private key'); |
|
| 62 | - } |
|
| 63 | - $storage->setBackendOption('public_key_auth', $auth); |
|
| 64 | - } |
|
| 57 | + public function manipulateStorageConfig(StorageConfig &$storage, IUser $user = null) { |
|
| 58 | + $auth = new RSACrypt(); |
|
| 59 | + $auth->setPassword($this->config->getSystemValue('secret', '')); |
|
| 60 | + if (!$auth->loadKey($storage->getBackendOption('private_key'))) { |
|
| 61 | + throw new \RuntimeException('unable to load private key'); |
|
| 62 | + } |
|
| 63 | + $storage->setBackendOption('public_key_auth', $auth); |
|
| 64 | + } |
|
| 65 | 65 | } |
@@ -30,24 +30,24 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICloudFederationNotification { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * add a message to the notification |
|
| 35 | - * |
|
| 36 | - * @param string $notificationType (e.g. SHARE_ACCEPTED) |
|
| 37 | - * @param string $resourceType (e.g. file, calendar, contact,...) |
|
| 38 | - * @param $providerId id of the share |
|
| 39 | - * @param array $notification , payload of the notification |
|
| 40 | - * |
|
| 41 | - * @since 14.0.0 |
|
| 42 | - */ |
|
| 43 | - public function setMessage($notificationType, $resourceType, $providerId, array $notification); |
|
| 33 | + /** |
|
| 34 | + * add a message to the notification |
|
| 35 | + * |
|
| 36 | + * @param string $notificationType (e.g. SHARE_ACCEPTED) |
|
| 37 | + * @param string $resourceType (e.g. file, calendar, contact,...) |
|
| 38 | + * @param $providerId id of the share |
|
| 39 | + * @param array $notification , payload of the notification |
|
| 40 | + * |
|
| 41 | + * @since 14.0.0 |
|
| 42 | + */ |
|
| 43 | + public function setMessage($notificationType, $resourceType, $providerId, array $notification); |
|
| 44 | 44 | |
| 45 | - /** |
|
| 46 | - * get message, ready to send out |
|
| 47 | - * |
|
| 48 | - * @return array |
|
| 49 | - * |
|
| 50 | - * @since 14.0.0 |
|
| 51 | - */ |
|
| 52 | - public function getMessage(); |
|
| 45 | + /** |
|
| 46 | + * get message, ready to send out |
|
| 47 | + * |
|
| 48 | + * @return array |
|
| 49 | + * |
|
| 50 | + * @since 14.0.0 |
|
| 51 | + */ |
|
| 52 | + public function getMessage(); |
|
| 53 | 53 | } |
@@ -30,221 +30,221 @@ |
||
| 30 | 30 | */ |
| 31 | 31 | interface ICloudFederationShare { |
| 32 | 32 | |
| 33 | - /** |
|
| 34 | - * set uid of the recipient |
|
| 35 | - * |
|
| 36 | - * @param string $user |
|
| 37 | - * |
|
| 38 | - * @since 14.0.0 |
|
| 39 | - */ |
|
| 40 | - public function setShareWith($user); |
|
| 41 | - |
|
| 42 | - /** |
|
| 43 | - * set resource name (e.g. file, calendar, contact,...) |
|
| 44 | - * |
|
| 45 | - * @param string $name |
|
| 46 | - * |
|
| 47 | - * @since 14.0.0 |
|
| 48 | - */ |
|
| 49 | - public function setResourceName($name); |
|
| 50 | - |
|
| 51 | - /** |
|
| 52 | - * set resource type (e.g. file, calendar, contact,...) |
|
| 53 | - * |
|
| 54 | - * @param string $resourceType |
|
| 55 | - * |
|
| 56 | - * @since 14.0.0 |
|
| 57 | - */ |
|
| 58 | - public function setResourceType($resourceType); |
|
| 59 | - |
|
| 60 | - /** |
|
| 61 | - * set resource description (optional) |
|
| 62 | - * |
|
| 63 | - * @param string $description |
|
| 64 | - * |
|
| 65 | - * @since 14.0.0 |
|
| 66 | - */ |
|
| 67 | - public function setDescription($description); |
|
| 68 | - |
|
| 69 | - /** |
|
| 70 | - * set provider ID (e.g. file ID) |
|
| 71 | - * |
|
| 72 | - * @param string $providerId |
|
| 73 | - * |
|
| 74 | - * @since 14.0.0 |
|
| 75 | - */ |
|
| 76 | - public function setProviderId($providerId); |
|
| 77 | - |
|
| 78 | - /** |
|
| 79 | - * set owner UID |
|
| 80 | - * |
|
| 81 | - * @param string $owner |
|
| 82 | - * |
|
| 83 | - * @since 14.0.0 |
|
| 84 | - */ |
|
| 85 | - public function setOwner($owner); |
|
| 86 | - |
|
| 87 | - /** |
|
| 88 | - * set owner display name |
|
| 89 | - * |
|
| 90 | - * @param string $ownerDisplayName |
|
| 91 | - * |
|
| 92 | - * @since 14.0.0 |
|
| 93 | - */ |
|
| 94 | - public function setOwnerDisplayName($ownerDisplayName); |
|
| 95 | - |
|
| 96 | - /** |
|
| 97 | - * set UID of the user who sends the share |
|
| 98 | - * |
|
| 99 | - * @param string $sharedBy |
|
| 100 | - * |
|
| 101 | - * @since 14.0.0 |
|
| 102 | - */ |
|
| 103 | - public function setSharedBy($sharedBy); |
|
| 104 | - |
|
| 105 | - /** |
|
| 106 | - * set display name of the user who sends the share |
|
| 107 | - * |
|
| 108 | - * @param $sharedByDisplayName |
|
| 109 | - * |
|
| 110 | - * @since 14.0.0 |
|
| 111 | - */ |
|
| 112 | - public function setSharedByDisplayName($sharedByDisplayName); |
|
| 113 | - |
|
| 114 | - /** |
|
| 115 | - * set protocol specification |
|
| 116 | - * |
|
| 117 | - * @param array $protocol |
|
| 118 | - * |
|
| 119 | - * @since 14.0.0 |
|
| 120 | - */ |
|
| 121 | - public function setProtocol(array $protocol); |
|
| 122 | - |
|
| 123 | - /** |
|
| 124 | - * share type (group or user) |
|
| 125 | - * |
|
| 126 | - * @param string $shareType |
|
| 127 | - * |
|
| 128 | - * @since 14.0.0 |
|
| 129 | - */ |
|
| 130 | - public function setShareType($shareType); |
|
| 131 | - |
|
| 132 | - /** |
|
| 133 | - * get the whole share, ready to send out |
|
| 134 | - * |
|
| 135 | - * @return array |
|
| 136 | - * |
|
| 137 | - * @since 14.0.0 |
|
| 138 | - */ |
|
| 139 | - public function getShare(); |
|
| 140 | - |
|
| 141 | - /** |
|
| 142 | - * get uid of the recipient |
|
| 143 | - * |
|
| 144 | - * @return string |
|
| 145 | - * |
|
| 146 | - * @since 14.0.0 |
|
| 147 | - */ |
|
| 148 | - public function getShareWith(); |
|
| 149 | - |
|
| 150 | - /** |
|
| 151 | - * get resource name (e.g. file, calendar, contact,...) |
|
| 152 | - * |
|
| 153 | - * @return string |
|
| 154 | - * |
|
| 155 | - * @since 14.0.0 |
|
| 156 | - */ |
|
| 157 | - public function getResourceName(); |
|
| 158 | - |
|
| 159 | - /** |
|
| 160 | - * get resource type (e.g. file, calendar, contact,...) |
|
| 161 | - * |
|
| 162 | - * @return string |
|
| 163 | - * |
|
| 164 | - * @since 14.0.0 |
|
| 165 | - */ |
|
| 166 | - public function getResourceType(); |
|
| 167 | - |
|
| 168 | - /** |
|
| 169 | - * get resource description (optional) |
|
| 170 | - * |
|
| 171 | - * @return string |
|
| 172 | - * |
|
| 173 | - * @since 14.0.0 |
|
| 174 | - */ |
|
| 175 | - public function getDescription(); |
|
| 176 | - |
|
| 177 | - /** |
|
| 178 | - * get provider ID (e.g. file ID) |
|
| 179 | - * |
|
| 180 | - * @return string |
|
| 181 | - * |
|
| 182 | - * @since 14.0.0 |
|
| 183 | - */ |
|
| 184 | - public function getProviderId(); |
|
| 185 | - |
|
| 186 | - /** |
|
| 187 | - * get owner UID |
|
| 188 | - * |
|
| 189 | - * @return string |
|
| 190 | - * |
|
| 191 | - * @since 14.0.0 |
|
| 192 | - */ |
|
| 193 | - public function getOwner(); |
|
| 194 | - |
|
| 195 | - /** |
|
| 196 | - * get owner display name |
|
| 197 | - * |
|
| 198 | - * @return string |
|
| 199 | - * |
|
| 200 | - * @since 14.0.0 |
|
| 201 | - */ |
|
| 202 | - public function getOwnerDisplayName(); |
|
| 203 | - |
|
| 204 | - /** |
|
| 205 | - * get UID of the user who sends the share |
|
| 206 | - * |
|
| 207 | - * @return string |
|
| 208 | - * |
|
| 209 | - * @since 14.0.0 |
|
| 210 | - */ |
|
| 211 | - public function getSharedBy(); |
|
| 212 | - |
|
| 213 | - /** |
|
| 214 | - * get display name of the user who sends the share |
|
| 215 | - * |
|
| 216 | - * @return string |
|
| 217 | - * |
|
| 218 | - * @since 14.0.0 |
|
| 219 | - */ |
|
| 220 | - public function getSharedByDisplayName(); |
|
| 221 | - |
|
| 222 | - /** |
|
| 223 | - * get share type (group or user) |
|
| 224 | - * |
|
| 225 | - * @return string |
|
| 226 | - * |
|
| 227 | - * @since 14.0.0 |
|
| 228 | - */ |
|
| 229 | - public function getShareType(); |
|
| 230 | - |
|
| 231 | - /** |
|
| 232 | - * get share Secret |
|
| 233 | - * |
|
| 234 | - * @return string |
|
| 235 | - * |
|
| 236 | - * @since 14.0.0 |
|
| 237 | - */ |
|
| 238 | - public function getShareSecret(); |
|
| 239 | - |
|
| 240 | - |
|
| 241 | - /** |
|
| 242 | - * get protocol specification |
|
| 243 | - * |
|
| 244 | - * @return array |
|
| 245 | - * |
|
| 246 | - * @since 14.0.0 |
|
| 247 | - */ |
|
| 248 | - public function getProtocol(); |
|
| 33 | + /** |
|
| 34 | + * set uid of the recipient |
|
| 35 | + * |
|
| 36 | + * @param string $user |
|
| 37 | + * |
|
| 38 | + * @since 14.0.0 |
|
| 39 | + */ |
|
| 40 | + public function setShareWith($user); |
|
| 41 | + |
|
| 42 | + /** |
|
| 43 | + * set resource name (e.g. file, calendar, contact,...) |
|
| 44 | + * |
|
| 45 | + * @param string $name |
|
| 46 | + * |
|
| 47 | + * @since 14.0.0 |
|
| 48 | + */ |
|
| 49 | + public function setResourceName($name); |
|
| 50 | + |
|
| 51 | + /** |
|
| 52 | + * set resource type (e.g. file, calendar, contact,...) |
|
| 53 | + * |
|
| 54 | + * @param string $resourceType |
|
| 55 | + * |
|
| 56 | + * @since 14.0.0 |
|
| 57 | + */ |
|
| 58 | + public function setResourceType($resourceType); |
|
| 59 | + |
|
| 60 | + /** |
|
| 61 | + * set resource description (optional) |
|
| 62 | + * |
|
| 63 | + * @param string $description |
|
| 64 | + * |
|
| 65 | + * @since 14.0.0 |
|
| 66 | + */ |
|
| 67 | + public function setDescription($description); |
|
| 68 | + |
|
| 69 | + /** |
|
| 70 | + * set provider ID (e.g. file ID) |
|
| 71 | + * |
|
| 72 | + * @param string $providerId |
|
| 73 | + * |
|
| 74 | + * @since 14.0.0 |
|
| 75 | + */ |
|
| 76 | + public function setProviderId($providerId); |
|
| 77 | + |
|
| 78 | + /** |
|
| 79 | + * set owner UID |
|
| 80 | + * |
|
| 81 | + * @param string $owner |
|
| 82 | + * |
|
| 83 | + * @since 14.0.0 |
|
| 84 | + */ |
|
| 85 | + public function setOwner($owner); |
|
| 86 | + |
|
| 87 | + /** |
|
| 88 | + * set owner display name |
|
| 89 | + * |
|
| 90 | + * @param string $ownerDisplayName |
|
| 91 | + * |
|
| 92 | + * @since 14.0.0 |
|
| 93 | + */ |
|
| 94 | + public function setOwnerDisplayName($ownerDisplayName); |
|
| 95 | + |
|
| 96 | + /** |
|
| 97 | + * set UID of the user who sends the share |
|
| 98 | + * |
|
| 99 | + * @param string $sharedBy |
|
| 100 | + * |
|
| 101 | + * @since 14.0.0 |
|
| 102 | + */ |
|
| 103 | + public function setSharedBy($sharedBy); |
|
| 104 | + |
|
| 105 | + /** |
|
| 106 | + * set display name of the user who sends the share |
|
| 107 | + * |
|
| 108 | + * @param $sharedByDisplayName |
|
| 109 | + * |
|
| 110 | + * @since 14.0.0 |
|
| 111 | + */ |
|
| 112 | + public function setSharedByDisplayName($sharedByDisplayName); |
|
| 113 | + |
|
| 114 | + /** |
|
| 115 | + * set protocol specification |
|
| 116 | + * |
|
| 117 | + * @param array $protocol |
|
| 118 | + * |
|
| 119 | + * @since 14.0.0 |
|
| 120 | + */ |
|
| 121 | + public function setProtocol(array $protocol); |
|
| 122 | + |
|
| 123 | + /** |
|
| 124 | + * share type (group or user) |
|
| 125 | + * |
|
| 126 | + * @param string $shareType |
|
| 127 | + * |
|
| 128 | + * @since 14.0.0 |
|
| 129 | + */ |
|
| 130 | + public function setShareType($shareType); |
|
| 131 | + |
|
| 132 | + /** |
|
| 133 | + * get the whole share, ready to send out |
|
| 134 | + * |
|
| 135 | + * @return array |
|
| 136 | + * |
|
| 137 | + * @since 14.0.0 |
|
| 138 | + */ |
|
| 139 | + public function getShare(); |
|
| 140 | + |
|
| 141 | + /** |
|
| 142 | + * get uid of the recipient |
|
| 143 | + * |
|
| 144 | + * @return string |
|
| 145 | + * |
|
| 146 | + * @since 14.0.0 |
|
| 147 | + */ |
|
| 148 | + public function getShareWith(); |
|
| 149 | + |
|
| 150 | + /** |
|
| 151 | + * get resource name (e.g. file, calendar, contact,...) |
|
| 152 | + * |
|
| 153 | + * @return string |
|
| 154 | + * |
|
| 155 | + * @since 14.0.0 |
|
| 156 | + */ |
|
| 157 | + public function getResourceName(); |
|
| 158 | + |
|
| 159 | + /** |
|
| 160 | + * get resource type (e.g. file, calendar, contact,...) |
|
| 161 | + * |
|
| 162 | + * @return string |
|
| 163 | + * |
|
| 164 | + * @since 14.0.0 |
|
| 165 | + */ |
|
| 166 | + public function getResourceType(); |
|
| 167 | + |
|
| 168 | + /** |
|
| 169 | + * get resource description (optional) |
|
| 170 | + * |
|
| 171 | + * @return string |
|
| 172 | + * |
|
| 173 | + * @since 14.0.0 |
|
| 174 | + */ |
|
| 175 | + public function getDescription(); |
|
| 176 | + |
|
| 177 | + /** |
|
| 178 | + * get provider ID (e.g. file ID) |
|
| 179 | + * |
|
| 180 | + * @return string |
|
| 181 | + * |
|
| 182 | + * @since 14.0.0 |
|
| 183 | + */ |
|
| 184 | + public function getProviderId(); |
|
| 185 | + |
|
| 186 | + /** |
|
| 187 | + * get owner UID |
|
| 188 | + * |
|
| 189 | + * @return string |
|
| 190 | + * |
|
| 191 | + * @since 14.0.0 |
|
| 192 | + */ |
|
| 193 | + public function getOwner(); |
|
| 194 | + |
|
| 195 | + /** |
|
| 196 | + * get owner display name |
|
| 197 | + * |
|
| 198 | + * @return string |
|
| 199 | + * |
|
| 200 | + * @since 14.0.0 |
|
| 201 | + */ |
|
| 202 | + public function getOwnerDisplayName(); |
|
| 203 | + |
|
| 204 | + /** |
|
| 205 | + * get UID of the user who sends the share |
|
| 206 | + * |
|
| 207 | + * @return string |
|
| 208 | + * |
|
| 209 | + * @since 14.0.0 |
|
| 210 | + */ |
|
| 211 | + public function getSharedBy(); |
|
| 212 | + |
|
| 213 | + /** |
|
| 214 | + * get display name of the user who sends the share |
|
| 215 | + * |
|
| 216 | + * @return string |
|
| 217 | + * |
|
| 218 | + * @since 14.0.0 |
|
| 219 | + */ |
|
| 220 | + public function getSharedByDisplayName(); |
|
| 221 | + |
|
| 222 | + /** |
|
| 223 | + * get share type (group or user) |
|
| 224 | + * |
|
| 225 | + * @return string |
|
| 226 | + * |
|
| 227 | + * @since 14.0.0 |
|
| 228 | + */ |
|
| 229 | + public function getShareType(); |
|
| 230 | + |
|
| 231 | + /** |
|
| 232 | + * get share Secret |
|
| 233 | + * |
|
| 234 | + * @return string |
|
| 235 | + * |
|
| 236 | + * @since 14.0.0 |
|
| 237 | + */ |
|
| 238 | + public function getShareSecret(); |
|
| 239 | + |
|
| 240 | + |
|
| 241 | + /** |
|
| 242 | + * get protocol specification |
|
| 243 | + * |
|
| 244 | + * @return array |
|
| 245 | + * |
|
| 246 | + * @since 14.0.0 |
|
| 247 | + */ |
|
| 248 | + public function getProtocol(); |
|
| 249 | 249 | |
| 250 | 250 | } |
@@ -33,19 +33,19 @@ |
||
| 33 | 33 | */ |
| 34 | 34 | class ProviderCouldNotAddShareException extends HintException { |
| 35 | 35 | |
| 36 | - /** |
|
| 37 | - * ProviderCouldNotAddShareException constructor. |
|
| 38 | - * |
|
| 39 | - * @since 14.0.0 |
|
| 40 | - * |
|
| 41 | - * @param string $message |
|
| 42 | - * @param string $hint |
|
| 43 | - * @param int $code |
|
| 44 | - * @param \Exception|null $previous |
|
| 45 | - */ |
|
| 46 | - public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { |
|
| 47 | - parent::__construct($message, $hint, $code, $previous); |
|
| 48 | - } |
|
| 36 | + /** |
|
| 37 | + * ProviderCouldNotAddShareException constructor. |
|
| 38 | + * |
|
| 39 | + * @since 14.0.0 |
|
| 40 | + * |
|
| 41 | + * @param string $message |
|
| 42 | + * @param string $hint |
|
| 43 | + * @param int $code |
|
| 44 | + * @param \Exception|null $previous |
|
| 45 | + */ |
|
| 46 | + public function __construct($message, $hint = '', $code = Http::STATUS_BAD_REQUEST, \Exception $previous = null) { |
|
| 47 | + parent::__construct($message, $hint, $code, $previous); |
|
| 48 | + } |
|
| 49 | 49 | |
| 50 | 50 | |
| 51 | 51 | } |
@@ -32,18 +32,18 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class ProviderDoesNotExistsException extends HintException { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * ProviderDoesNotExistsException constructor. |
|
| 37 | - * |
|
| 38 | - * @since 14.0.0 |
|
| 39 | - * |
|
| 40 | - * @param string $providerId cloud federation provider ID |
|
| 41 | - */ |
|
| 42 | - public function __construct($providerId) { |
|
| 43 | - $l = \OC::$server->getL10N('federation'); |
|
| 44 | - $message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.'; |
|
| 45 | - $hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]); |
|
| 46 | - parent::__construct($message, $hint); |
|
| 47 | - } |
|
| 35 | + /** |
|
| 36 | + * ProviderDoesNotExistsException constructor. |
|
| 37 | + * |
|
| 38 | + * @since 14.0.0 |
|
| 39 | + * |
|
| 40 | + * @param string $providerId cloud federation provider ID |
|
| 41 | + */ |
|
| 42 | + public function __construct($providerId) { |
|
| 43 | + $l = \OC::$server->getL10N('federation'); |
|
| 44 | + $message = 'Cloud Federation Provider with ID: "' . $providerId . '" does not exist.'; |
|
| 45 | + $hint = $l->t('Cloud Federation Provider with ID: "%s" does not exist.', [$providerId]); |
|
| 46 | + parent::__construct($message, $hint); |
|
| 47 | + } |
|
| 48 | 48 | |
| 49 | 49 | } |
@@ -32,17 +32,17 @@ |
||
| 32 | 32 | */ |
| 33 | 33 | class ActionNotSupportedException extends HintException { |
| 34 | 34 | |
| 35 | - /** |
|
| 36 | - * ActionNotSupportedException constructor. |
|
| 37 | - * |
|
| 38 | - * @since 14.0.0 |
|
| 39 | - * |
|
| 40 | - */ |
|
| 41 | - public function __construct($action) { |
|
| 42 | - $l = \OC::$server->getL10N('federation'); |
|
| 43 | - $message = 'Action "' . $action . '" not supported or implemented.'; |
|
| 44 | - $hint = $l->t('Action "%s" not supported or implemented.', [$action]); |
|
| 45 | - parent::__construct($message, $hint); |
|
| 46 | - } |
|
| 35 | + /** |
|
| 36 | + * ActionNotSupportedException constructor. |
|
| 37 | + * |
|
| 38 | + * @since 14.0.0 |
|
| 39 | + * |
|
| 40 | + */ |
|
| 41 | + public function __construct($action) { |
|
| 42 | + $l = \OC::$server->getL10N('federation'); |
|
| 43 | + $message = 'Action "' . $action . '" not supported or implemented.'; |
|
| 44 | + $hint = $l->t('Action "%s" not supported or implemented.', [$action]); |
|
| 45 | + parent::__construct($message, $hint); |
|
| 46 | + } |
|
| 47 | 47 | |
| 48 | 48 | } |