ScopeContext.php 2.1 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879
  1. <?php
  2. declare(strict_types=1);
  3. /**
  4. * @copyright Copyright (c) 2019 Arthur Schiwon <blizzz@arthur-schiwon.de>
  5. *
  6. * @author Arthur Schiwon <blizzz@arthur-schiwon.de>
  7. * @author Christoph Wurst <christoph@winzerhof-wurst.at>
  8. *
  9. * @license GNU AGPL version 3 or any later version
  10. *
  11. * This program is free software: you can redistribute it and/or modify
  12. * it under the terms of the GNU Affero General Public License as
  13. * published by the Free Software Foundation, either version 3 of the
  14. * License, or (at your option) any later version.
  15. *
  16. * This program is distributed in the hope that it will be useful,
  17. * but WITHOUT ANY WARRANTY; without even the implied warranty of
  18. * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  19. * GNU Affero General Public License for more details.
  20. *
  21. * You should have received a copy of the GNU Affero General Public License
  22. * along with this program. If not, see <http://www.gnu.org/licenses/>.
  23. *
  24. */
  25. namespace OCA\WorkflowEngine\Helper;
  26. use OCP\WorkflowEngine\IManager;
  27. class ScopeContext {
  28. /** @var int */
  29. private $scope;
  30. /** @var string */
  31. private $scopeId;
  32. /** @var string */
  33. private $hash;
  34. public function __construct(int $scope, string $scopeId = null) {
  35. $this->scope = $this->evaluateScope($scope);
  36. $this->scopeId = $this->evaluateScopeId($scopeId);
  37. }
  38. private function evaluateScope(int $scope): int {
  39. if (in_array($scope, [IManager::SCOPE_ADMIN, IManager::SCOPE_USER], true)) {
  40. return $scope;
  41. }
  42. throw new \InvalidArgumentException('Invalid scope');
  43. }
  44. private function evaluateScopeId(string $scopeId = null): string {
  45. if ($this->scope === IManager::SCOPE_USER
  46. && trim((string)$scopeId) === '') {
  47. throw new \InvalidArgumentException('user scope requires a user id');
  48. }
  49. return trim((string)$scopeId);
  50. }
  51. /**
  52. * @return int
  53. */
  54. public function getScope(): int {
  55. return $this->scope;
  56. }
  57. /**
  58. * @return string
  59. */
  60. public function getScopeId(): string {
  61. return $this->scopeId;
  62. }
  63. public function getHash(): string {
  64. if ($this->hash === null) {
  65. $this->hash = \hash('sha256', $this->getScope() . '::' . $this->getScopeId());
  66. }
  67. return $this->hash;
  68. }
  69. }