Merge pull request #502 from Ocramius/feature/immutability-psalm-anno…

…tations

Documented basic immutable/mutation-free interfaces and services in the package

src/ProxyManager/Exception/DisabledMethodException.php

@@ -9,6 +9,8 @@
 
 /**
  * Exception for forcefully disabled methods
+ *
+ * @psalm-immutable
  */
 class DisabledMethodException extends BadMethodCallException implements ExceptionInterface
 {

src/ProxyManager/Exception/ExceptionInterface.php

@@ -8,6 +8,8 @@
 
 /**
  * Base exception class for the proxy manager
+ *
+ * @psalm-immutable
  */
 interface ExceptionInterface extends Throwable
 {

src/ProxyManager/Exception/FileNotWritableException.php

@@ -10,6 +10,8 @@
 
 /**
  * Exception for non writable files
+ *
+ * @psalm-immutable
  */
 class FileNotWritableException extends UnexpectedValueException implements ExceptionInterface
 {

src/ProxyManager/Exception/InvalidProxiedClassException.php

@@ -14,6 +14,8 @@
 
 /**
  * Exception for invalid proxied classes
+ *
+ * @psalm-immutable
  */
 class InvalidProxiedClassException extends InvalidArgumentException implements ExceptionInterface
 {

src/ProxyManager/Exception/InvalidProxyDirectoryException.php

@@ -9,6 +9,8 @@
 
 /**
  * Exception for invalid directories
+ *
+ * @psalm-immutable
  */
 class InvalidProxyDirectoryException extends InvalidArgumentException implements ExceptionInterface
 {

src/ProxyManager/Exception/UnsupportedProxiedClassException.php

@@ -14,6 +14,8 @@
 
 /**
  * Exception for invalid proxied classes
+ *
+ * @psalm-immutable
  */
 class UnsupportedProxiedClassException extends LogicException implements ExceptionInterface
 {

src/ProxyManager/FileLocator/FileLocator.php

@@ -11,6 +11,8 @@
 
 /**
  * {@inheritDoc}
+ *
+ * @psalm-immutable
  */
 class FileLocator implements FileLocatorInterface
 {

src/ProxyManager/Generator/ClassGenerator.php

@@ -10,6 +10,8 @@
 
 /**
  * Class generator that ensures that interfaces/classes that are implemented/extended are FQCNs
+ *
+ * @psalm-external-mutation-free
  */
 class ClassGenerator extends ZendClassGenerator
 {

src/ProxyManager/Generator/MagicMethodGenerator.php

@@ -9,6 +9,8 @@
 
 /**
  * Method generator for magic methods
+ *
+ * @psalm-external-mutation-free
  */
 class MagicMethodGenerator extends MethodGenerator
 {

src/ProxyManager/Generator/MethodGenerator.php

@@ -10,6 +10,8 @@
 
 /**
  * Method generator that fixes minor quirks in ZF2's method generator
+ *
+ * @psalm-external-mutation-free
  */
 class MethodGenerator extends ZendMethodGenerator
 {

src/ProxyManager/Generator/Util/IdentifierSuffixer.php

@@ -16,6 +16,8 @@
  * with a deterministic attached suffix,
  * in order to prevent property name collisions
  * and tampering from userland
+ *
+ * @psalm-immutable
  */
 abstract class IdentifierSuffixer
 {

src/ProxyManager/Generator/Util/ProxiedMethodReturnExpression.php

@@ -10,6 +10,8 @@
  * Utility class to generate return expressions in method, given a method signature.
  *
  * This is required since return expressions may be forbidden by the method signature (void).
+ *
+ * @psalm-immutable
  */
 final class ProxiedMethodReturnExpression
 {

src/ProxyManager/Generator/Util/UniqueIdentifierGenerator.php

@@ -11,6 +11,8 @@
 /**
  * Utility class capable of generating unique
  * valid class/property/method identifiers
+ *
+ * @psalm-immutable
  */
 abstract class UniqueIdentifierGenerator
 {

src/ProxyManager/Inflector/ClassNameInflector.php

@@ -13,6 +13,8 @@
 
 /**
  * {@inheritDoc}
+ *
+ * @psalm-immutable
  */
 final class ClassNameInflector implements ClassNameInflectorInterface
 {

src/ProxyManager/Inflector/ClassNameInflectorInterface.php

@@ -8,6 +8,8 @@
 
 /**
  * Interface for a proxy- to user-class and user- to proxy-class name inflector
+ *
+ * @psalm-immutable
  */
 interface ClassNameInflectorInterface
 {

src/ProxyManager/Inflector/Util/ParameterEncoder.php

@@ -9,6 +9,8 @@
 
 /**
  * Encodes parameters into a class-name safe string
+ *
+ * @psalm-immutable
  */
 class ParameterEncoder
 {

src/ProxyManager/Inflector/Util/ParameterHasher.php

@@ -9,6 +9,8 @@
 
 /**
  * Converts given parameters into a likely unique hash
+ *
+ * @psalm-immutable
  */
 class ParameterHasher
 {

src/ProxyManager/Proxy/Exception/RemoteObjectException.php

@@ -10,6 +10,8 @@
  * Remote object exception
  *
  * @deprecated this exception is not in use anymore, and should not be relied upon
+ *
+ * @psalm-immutable
  */
 class RemoteObjectException extends RuntimeException
 {

src/ProxyManager/ProxyGenerator/Assertion/CanProxyAssertion.php

@@ -12,6 +12,8 @@
 
 /**
  * Assertion that verifies that a class can be proxied
+ *
+ * @psalm-immutable
  */
 final class CanProxyAssertion
 {

src/ProxyManager/ProxyGenerator/Util/GetMethodIfExists.php

@@ -9,6 +9,8 @@
 
 /**
  * Internal utility class - allows fetching a method from a given class, if it exists
+ *
+ * @psalm-immutable
  */
 final class GetMethodIfExists
 {

src/ProxyManager/ProxyGenerator/Util/Properties.php

@@ -18,6 +18,8 @@
 /**
  * DTO containing the list of all non-static proxy properties and utility methods to access them
  * in various formats/collections
+ *
+ * @psalm-immutable
  */
 final class Properties
 {

src/ProxyManager/ProxyGenerator/Util/ProxiedMethodsFilter.php

@@ -15,6 +15,8 @@
 
 /**
  * Utility class used to filter methods that can be proxied
+ *
+ * @psalm-immutable
  */
 final class ProxiedMethodsFilter
 {

src/ProxyManager/ProxyGenerator/Util/PublicScopeSimulator.php

@@ -12,6 +12,8 @@
  * Generates code necessary to simulate a fatal error in case of unauthorized
  * access to class members in magic methods even when in child classes and dealing
  * with protected members.
+ *
+ * @psalm-immutable
  */
 class PublicScopeSimulator
 {

src/ProxyManager/ProxyGenerator/Util/UnsetPropertiesGenerator.php

@@ -14,6 +14,8 @@
 
 /**
  * Generates code necessary to unset all the given properties from a particular given instance string name
+ *
+ * @psalm-immutable
  */
 final class UnsetPropertiesGenerator
 {

src/ProxyManager/Signature/Exception/ExceptionInterface.php

@@ -6,6 +6,8 @@
 
 /**
  * Exception marker for exceptions from the signature sub-component
+ *
+ * @psalm-immutable
  */
 interface ExceptionInterface
 {

src/ProxyManager/Signature/Exception/InvalidSignatureException.php

@@ -11,6 +11,8 @@
 
 /**
  * Exception for invalid provided signatures
+ *
+ * @psalm-immutable
  */
 class InvalidSignatureException extends UnexpectedValueException implements ExceptionInterface
 {

src/ProxyManager/Signature/Exception/MissingSignatureException.php

@@ -11,6 +11,8 @@
 
 /**
  * Exception for no found signatures
+ *
+ * @psalm-immutable
  */
 class MissingSignatureException extends UnexpectedValueException implements ExceptionInterface
 {

src/ProxyManager/Signature/SignatureChecker.php

@@ -12,6 +12,8 @@
 
 /**
  * Generator for signatures to be used to check the validity of generated code
+ *
+ * @psalm-external-mutation-free
  */
 final class SignatureChecker implements SignatureCheckerInterface
 {

src/ProxyManager/Signature/SignatureCheckerInterface.php

@@ -10,6 +10,8 @@
 
 /**
  * Generator for signatures to be used to check the validity of generated code
+ *
+ * @psalm-immutable
  */
 interface SignatureCheckerInterface
 {

src/ProxyManager/Signature/SignatureGenerator.php

@@ -9,6 +9,8 @@
 
 /**
  * {@inheritDoc}
+ *
+ * @psalm-immutable
  */
 final class SignatureGenerator implements SignatureGeneratorInterface
 {

src/ProxyManager/Signature/SignatureGeneratorInterface.php

@@ -6,6 +6,8 @@
 
 /**
  * Generator for signatures to be used to check the validity of generated code
+ *
+ * @psalm-immutable
  */
 interface SignatureGeneratorInterface
 {

src/ProxyManager/Stub/EmptyClassStub.php

@@ -6,6 +6,8 @@
 
 /**
  * Just an empty instantiable class
+ *
+ * @psalm-immutable
  */
 final class EmptyClassStub
 {

src/ProxyManager/Version.php

@@ -11,6 +11,8 @@
  * Version class
  *
  * Note that we cannot check the version at runtime via `git` because that would cause a lot of I/O operations.
+ *
+ * @psalm-immutable
  */
 final class Version
 {