]> git.mxchange.org Git - friendica.git/commitdiff
Apply suggestions from code review
authorPhilipp <admin+Github@philipp.info>
Tue, 17 Jan 2023 18:12:33 +0000 (19:12 +0100)
committerGitHub <noreply@github.com>
Tue, 17 Jan 2023 18:12:33 +0000 (19:12 +0100)
Co-authored-by: Hypolite Petovan <hypolite@mrpetovan.com>
src/Core/Hooks/Capabilities/ICanManageInstances.php
src/Core/Hooks/Model/InstanceManager.php

index 08802a08e61cd9112a19705df6751319dceaa0cf..d6a7f244c76d74e5ad76b8af4fe3fdcda14336cb 100644 (file)
@@ -35,8 +35,8 @@ interface ICanManageInstances
         * @see https://refactoring.guru/design-patterns/strategy
         *
         * @param string $interface The interface, which the given class implements
-        * @param string $name      The name of the given class, which will be used for factories, dependency injections etc.
-        * @param string $class     The class of the given class
+        * @param string $name      An arbitrary identifier for the given class, which will be used for factories, dependency injections etc.
+        * @param string $class     The fully-qualified given class name
         * @param ?array  $arguments Additional arguments, which can be passed to the constructor
         *
         * @return $this This interface for chain-calls
@@ -51,8 +51,8 @@ interface ICanManageInstances
         *
         * @note Decorator attach new behaviors to classes without changing them or without letting them know about it.
         *
-        * @param string $class          The class or interface, which gets decorated by a class
-        * @param string $decoratorClass The class, which mimics the given class or interface and adds new functionality
+        * @param string $class          The fully-qualified class or interface name, which gets decorated by a class
+        * @param string $decoratorClass The fully-qualified name of the class which mimics the given class or interface and adds new functionality
         * @param array  $arguments      Additional arguments, which can be passed to the constructor of "decoratorClass"
         *
         * @return $this This interface for chain-calls
@@ -69,7 +69,7 @@ interface ICanManageInstances
         * In case, there are registered decorators for this class as well, all decorators of the list will be wrapped
         * around the instance before returning it
         *
-        * @param string $class     A given class or interface, which will get returned
+        * @param string $class     The fully-qualified name of the given class or interface which will get returned
         * @param string $name      The name of the concrete class, wich
         * @param array  $arguments Additional arguments, which can be passed to the constructor of "$class" at runtime
         *
index 7a3697062d6276c19d500dbf3cc595600ccb10b7..7bfcfa420da0744493dd94095d295fdd5c6c6c91 100644 (file)
@@ -67,7 +67,7 @@ class InstanceManager implements ICanManageInstances
        public function registerDecorator(string $class, string $decoratorClass, array $arguments = []): ICanManageInstances
        {
                if (!is_a($decoratorClass, $class, true)) {
-                       throw new HookRegisterArgumentException(sprintf('%s is not a valid subsituation for the given class or interface %s', $decoratorClass, $class));
+                       throw new HookRegisterArgumentException(sprintf('%s is not a valid substitution for the given class or interface %s', $decoratorClass, $class));
                }
 
                $this->decorator[$class][] = [