nextcloud / server

lib/public/AppFramework/Http/TemplateResponse.php

Indentation +170 added lines, -170 removed lines

@@ -24,174 +24,174 @@
  * @template-extends Response<Http::STATUS_*, array<string, mixed>>
  */
 class TemplateResponse extends Response {
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_GUEST = 'guest';
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_BLANK = '';
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_BASE = 'base';
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_USER = 'user';
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_ERROR = 'error';
-	/**
-	 * @since 20.0.0
-	 */
-	public const RENDER_AS_PUBLIC = 'public';
-
-	/**
-	 * name of the template
-	 * @var string
-	 */
-	protected $templateName;
-
-	/**
-	 * parameters
-	 * @var array
-	 */
-	protected $params;
-
-	/**
-	 * rendering type (admin, user, blank)
-	 * @var string
-	 */
-	protected $renderAs;
-
-	/**
-	 * app name
-	 * @var string
-	 */
-	protected $appName;
-
-	/**
-	 * @param string $appName the name of the app to load the template from
-	 * @param string $templateName the name of the template
-	 * @param array $params an array of parameters which should be passed to the
-	 *                      template
-	 * @param string $renderAs how the page should be rendered, defaults to user
-	 * @psalm-param TemplateResponse::RENDER_AS_* $renderAs
-	 * @param S $status
-	 * @param H $headers
-	 * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
-	 */
-	public function __construct(string $appName, string $templateName, array $params = [], string $renderAs = self::RENDER_AS_USER, int $status = Http::STATUS_OK, array $headers = []) {
-		parent::__construct($status, $headers);
-
-		$this->templateName = $templateName;
-		$this->appName = $appName;
-		$this->params = $params;
-		$this->renderAs = $renderAs;
-
-		$this->setContentSecurityPolicy(new ContentSecurityPolicy());
-		$this->setFeaturePolicy(new FeaturePolicy());
-	}
-
-
-	/**
-	 * Sets template parameters
-	 * @param array $params an array with key => value structure which sets template
-	 *                      variables
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function setParams(array $params) {
-		$this->params = $params;
-
-		return $this;
-	}
-
-
-	/**
-	 * Used for accessing the set parameters
-	 * @return array the params
-	 * @since 6.0.0
-	 */
-	public function getParams() {
-		return $this->params;
-	}
-
-
-	/**
-	 * @return string the app id of the used template
-	 * @since 25.0.0
-	 */
-	public function getApp(): string {
-		return $this->appName;
-	}
-
-
-	/**
-	 * Used for accessing the name of the set template
-	 * @return string the name of the used template
-	 * @since 6.0.0
-	 */
-	public function getTemplateName() {
-		return $this->templateName;
-	}
-
-
-	/**
-	 * Sets the template page
-	 * @param string $renderAs admin, user or blank. Admin also prints the admin
-	 *                         settings header and footer, user renders the normal
-	 *                         normal page including footer and header and blank
-	 *                         just renders the plain template
-	 * @return TemplateResponse Reference to this object
-	 * @since 6.0.0 - return value was added in 7.0.0
-	 */
-	public function renderAs($renderAs) {
-		$this->renderAs = $renderAs;
-
-		return $this;
-	}
-
-
-	/**
-	 * Returns the set renderAs
-	 * @return string the renderAs value
-	 * @since 6.0.0
-	 */
-	public function getRenderAs() {
-		return $this->renderAs;
-	}
-
-
-	/**
-	 * Returns the rendered html
-	 * @return string the rendered html
-	 * @since 6.0.0
-	 */
-	public function render() {
-		$renderAs = self::RENDER_AS_USER;
-		if ($this->renderAs === 'blank') {
-			// Legacy fallback as \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
-			$renderAs = self::RENDER_AS_BLANK;
-		} elseif (in_array($this->renderAs, [
-			self::RENDER_AS_GUEST,
-			self::RENDER_AS_BLANK,
-			self::RENDER_AS_BASE,
-			self::RENDER_AS_ERROR,
-			self::RENDER_AS_PUBLIC,
-			self::RENDER_AS_USER], true)) {
-			$renderAs = $this->renderAs;
-		}
-
-		$template = Server::get(ITemplateManager::class)->getTemplate($this->appName, $this->templateName, $renderAs);
-
-		foreach ($this->params as $key => $value) {
-			$template->assign($key, $value);
-		}
-
-		return $template->fetchPage($this->params);
-	}
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_GUEST = 'guest';
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_BLANK = '';
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_BASE = 'base';
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_USER = 'user';
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_ERROR = 'error';
+    /**
+     * @since 20.0.0
+     */
+    public const RENDER_AS_PUBLIC = 'public';
+
+    /**
+     * name of the template
+     * @var string
+     */
+    protected $templateName;
+
+    /**
+     * parameters
+     * @var array
+     */
+    protected $params;
+
+    /**
+     * rendering type (admin, user, blank)
+     * @var string
+     */
+    protected $renderAs;
+
+    /**
+     * app name
+     * @var string
+     */
+    protected $appName;
+
+    /**
+     * @param string $appName the name of the app to load the template from
+     * @param string $templateName the name of the template
+     * @param array $params an array of parameters which should be passed to the
+     *                      template
+     * @param string $renderAs how the page should be rendered, defaults to user
+     * @psalm-param TemplateResponse::RENDER_AS_* $renderAs
+     * @param S $status
+     * @param H $headers
+     * @since 6.0.0 - parameters $params and $renderAs were added in 7.0.0
+     */
+    public function __construct(string $appName, string $templateName, array $params = [], string $renderAs = self::RENDER_AS_USER, int $status = Http::STATUS_OK, array $headers = []) {
+        parent::__construct($status, $headers);
+
+        $this->templateName = $templateName;
+        $this->appName = $appName;
+        $this->params = $params;
+        $this->renderAs = $renderAs;
+
+        $this->setContentSecurityPolicy(new ContentSecurityPolicy());
+        $this->setFeaturePolicy(new FeaturePolicy());
+    }
+
+
+    /**
+     * Sets template parameters
+     * @param array $params an array with key => value structure which sets template
+     *                      variables
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function setParams(array $params) {
+        $this->params = $params;
+
+        return $this;
+    }
+
+
+    /**
+     * Used for accessing the set parameters
+     * @return array the params
+     * @since 6.0.0
+     */
+    public function getParams() {
+        return $this->params;
+    }
+
+
+    /**
+     * @return string the app id of the used template
+     * @since 25.0.0
+     */
+    public function getApp(): string {
+        return $this->appName;
+    }
+
+
+    /**
+     * Used for accessing the name of the set template
+     * @return string the name of the used template
+     * @since 6.0.0
+     */
+    public function getTemplateName() {
+        return $this->templateName;
+    }
+
+
+    /**
+     * Sets the template page
+     * @param string $renderAs admin, user or blank. Admin also prints the admin
+     *                         settings header and footer, user renders the normal
+     *                         normal page including footer and header and blank
+     *                         just renders the plain template
+     * @return TemplateResponse Reference to this object
+     * @since 6.0.0 - return value was added in 7.0.0
+     */
+    public function renderAs($renderAs) {
+        $this->renderAs = $renderAs;
+
+        return $this;
+    }
+
+
+    /**
+     * Returns the set renderAs
+     * @return string the renderAs value
+     * @since 6.0.0
+     */
+    public function getRenderAs() {
+        return $this->renderAs;
+    }
+
+
+    /**
+     * Returns the rendered html
+     * @return string the rendered html
+     * @since 6.0.0
+     */
+    public function render() {
+        $renderAs = self::RENDER_AS_USER;
+        if ($this->renderAs === 'blank') {
+            // Legacy fallback as \OCP\Template needs an empty string instead of 'blank' for an unwrapped response
+            $renderAs = self::RENDER_AS_BLANK;
+        } elseif (in_array($this->renderAs, [
+            self::RENDER_AS_GUEST,
+            self::RENDER_AS_BLANK,
+            self::RENDER_AS_BASE,
+            self::RENDER_AS_ERROR,
+            self::RENDER_AS_PUBLIC,
+            self::RENDER_AS_USER], true)) {
+            $renderAs = $this->renderAs;
+        }
+
+        $template = Server::get(ITemplateManager::class)->getTemplate($this->appName, $this->templateName, $renderAs);
+
+        foreach ($this->params as $key => $value) {
+            $template->assign($key, $value);
+        }
+
+        return $template->fetchPage($this->params);
+    }
 }

apps/workflowengine/lib/Settings/ASettings.php

Indentation +121 added lines, -121 removed lines

@@ -25,125 +25,125 @@
 use OCP\WorkflowEngine\ISpecificOperation;
 
 abstract class ASettings implements ISettings {
-	public function __construct(
-		private readonly IEventDispatcher $eventDispatcher,
-		protected readonly Manager $manager,
-		private readonly IInitialState $initialStateService,
-		private readonly IConfig $config,
-		private readonly IURLGenerator $urlGenerator,
-	) {
-	}
-
-	abstract public function getScope(): int;
-
-	public function getForm(): TemplateResponse {
-		// @deprecated in 20.0.0: retire this one in favor of the typed event
-		$this->eventDispatcher->dispatch(
-			'OCP\WorkflowEngine::loadAdditionalSettingScripts',
-			new LoadSettingsScriptsEvent()
-		);
-		$this->eventDispatcher->dispatchTyped(new LoadSettingsScriptsEvent());
-
-		$entities = $this->manager->getEntitiesList();
-		$this->initialStateService->provideInitialState(
-			'entities',
-			$this->entitiesToArray($entities)
-		);
-
-		$operators = $this->manager->getOperatorList();
-		$this->initialStateService->provideInitialState(
-			'operators',
-			$this->operatorsToArray($operators)
-		);
-
-		$checks = $this->manager->getCheckList();
-		$this->initialStateService->provideInitialState(
-			'checks',
-			$this->checksToArray($checks)
-		);
-
-		$this->initialStateService->provideInitialState(
-			'scope',
-			$this->getScope()
-		);
-
-		$this->initialStateService->provideInitialState(
-			'appstoreenabled',
-			$this->config->getSystemValueBool('appstoreenabled', true)
-		);
-
-		$this->initialStateService->provideInitialState(
-			'doc-url',
-			$this->urlGenerator->linkToDocs('admin-workflowengine')
-		);
-
-		return new TemplateResponse(Application::APP_ID, 'settings', [], TemplateResponse::RENDER_AS_BLANK);
-	}
-
-	/**
-	 * @return string|null the section ID, e.g. 'sharing'
-	 */
-	public function getSection(): ?string {
-		return 'workflow';
-	}
-
-	/**
-	 * @return int whether the form should be rather on the top or bottom of
-	 *             the admin section. The forms are arranged in ascending order of the
-	 *             priority values. It is required to return a value between 0 and 100.
-	 *
-	 * E.g.: 70
-	 */
-	public function getPriority(): int {
-		return 0;
-	}
-
-	/**
-	 * @param IEntity[] $entities
-	 * @return array<array-key, array{id: class-string<IEntity>, icon: string, name: string, events: array<array-key, array{eventName: string, displayName: string}>}>
-	 */
-	private function entitiesToArray(array $entities): array {
-		return array_map(function (IEntity $entity): array {
-			$events = array_map(function (IEntityEvent $entityEvent): array {
-				return [
-					'eventName' => $entityEvent->getEventName(),
-					'displayName' => $entityEvent->getDisplayName()
-				];
-			}, $entity->getEvents());
-
-			return [
-				'id' => get_class($entity),
-				'icon' => $entity->getIcon(),
-				'name' => $entity->getName(),
-				'events' => $events,
-			];
-		}, $entities);
-	}
-
-	private function operatorsToArray(array $operators): array {
-		$operators = array_filter($operators, fn (IOperation $operator): bool => $operator->isAvailableForScope($this->getScope()));
-
-		return array_map(function (IOperation $operator) {
-			return [
-				'id' => get_class($operator),
-				'icon' => $operator->getIcon(),
-				'name' => $operator->getDisplayName(),
-				'description' => $operator->getDescription(),
-				'fixedEntity' => $operator instanceof ISpecificOperation ? $operator->getEntityId() : '',
-				'isComplex' => $operator instanceof IComplexOperation,
-				'triggerHint' => $operator instanceof IComplexOperation ? $operator->getTriggerHint() : '',
-			];
-		}, $operators);
-	}
-
-	private function checksToArray(array $checks): array {
-		$checks = array_filter($checks, fn (ICheck $check): bool => $check->isAvailableForScope($this->getScope()));
-
-		return array_map(function (ICheck $check) {
-			return [
-				'id' => get_class($check),
-				'supportedEntities' => $check->supportedEntities(),
-			];
-		}, $checks);
-	}
+    public function __construct(
+        private readonly IEventDispatcher $eventDispatcher,
+        protected readonly Manager $manager,
+        private readonly IInitialState $initialStateService,
+        private readonly IConfig $config,
+        private readonly IURLGenerator $urlGenerator,
+    ) {
+    }
+
+    abstract public function getScope(): int;
+
+    public function getForm(): TemplateResponse {
+        // @deprecated in 20.0.0: retire this one in favor of the typed event
+        $this->eventDispatcher->dispatch(
+            'OCP\WorkflowEngine::loadAdditionalSettingScripts',
+            new LoadSettingsScriptsEvent()
+        );
+        $this->eventDispatcher->dispatchTyped(new LoadSettingsScriptsEvent());
+
+        $entities = $this->manager->getEntitiesList();
+        $this->initialStateService->provideInitialState(
+            'entities',
+            $this->entitiesToArray($entities)
+        );
+
+        $operators = $this->manager->getOperatorList();
+        $this->initialStateService->provideInitialState(
+            'operators',
+            $this->operatorsToArray($operators)
+        );
+
+        $checks = $this->manager->getCheckList();
+        $this->initialStateService->provideInitialState(
+            'checks',
+            $this->checksToArray($checks)
+        );
+
+        $this->initialStateService->provideInitialState(
+            'scope',
+            $this->getScope()
+        );
+
+        $this->initialStateService->provideInitialState(
+            'appstoreenabled',
+            $this->config->getSystemValueBool('appstoreenabled', true)
+        );
+
+        $this->initialStateService->provideInitialState(
+            'doc-url',
+            $this->urlGenerator->linkToDocs('admin-workflowengine')
+        );
+
+        return new TemplateResponse(Application::APP_ID, 'settings', [], TemplateResponse::RENDER_AS_BLANK);
+    }
+
+    /**
+     * @return string|null the section ID, e.g. 'sharing'
+     */
+    public function getSection(): ?string {
+        return 'workflow';
+    }
+
+    /**
+     * @return int whether the form should be rather on the top or bottom of
+     *             the admin section. The forms are arranged in ascending order of the
+     *             priority values. It is required to return a value between 0 and 100.
+     *
+     * E.g.: 70
+     */
+    public function getPriority(): int {
+        return 0;
+    }
+
+    /**
+     * @param IEntity[] $entities
+     * @return array<array-key, array{id: class-string<IEntity>, icon: string, name: string, events: array<array-key, array{eventName: string, displayName: string}>}>
+     */
+    private function entitiesToArray(array $entities): array {
+        return array_map(function (IEntity $entity): array {
+            $events = array_map(function (IEntityEvent $entityEvent): array {
+                return [
+                    'eventName' => $entityEvent->getEventName(),
+                    'displayName' => $entityEvent->getDisplayName()
+                ];
+            }, $entity->getEvents());
+
+            return [
+                'id' => get_class($entity),
+                'icon' => $entity->getIcon(),
+                'name' => $entity->getName(),
+                'events' => $events,
+            ];
+        }, $entities);
+    }
+
+    private function operatorsToArray(array $operators): array {
+        $operators = array_filter($operators, fn (IOperation $operator): bool => $operator->isAvailableForScope($this->getScope()));
+
+        return array_map(function (IOperation $operator) {
+            return [
+                'id' => get_class($operator),
+                'icon' => $operator->getIcon(),
+                'name' => $operator->getDisplayName(),
+                'description' => $operator->getDescription(),
+                'fixedEntity' => $operator instanceof ISpecificOperation ? $operator->getEntityId() : '',
+                'isComplex' => $operator instanceof IComplexOperation,
+                'triggerHint' => $operator instanceof IComplexOperation ? $operator->getTriggerHint() : '',
+            ];
+        }, $operators);
+    }
+
+    private function checksToArray(array $checks): array {
+        $checks = array_filter($checks, fn (ICheck $check): bool => $check->isAvailableForScope($this->getScope()));
+
+        return array_map(function (ICheck $check) {
+            return [
+                'id' => get_class($check),
+                'supportedEntities' => $check->supportedEntities(),
+            ];
+        }, $checks);
+    }
 }