Merge pull request #22 from DaveLiddament/feature/override

ADD Override attribute

Author: DaveLiddament

README.md

@@ -17,6 +17,7 @@ The intention, at least initially, is that these extra language features are enf
 - [Friend](#friend)
 - [NamespaceVisibility](#namespaceVisibility)
 - [InjectableVersion](#injectableVersion)
+- [Override](#override)
 - [Sealed](#sealed)
 - [TestTag](#testtag)
 
@@ -30,6 +31,7 @@ The intention, at least initially, is that these extra language features are enf
   - [Friend](#friend)
   - [NamespaceVisibility](#namespaceVisibility)
   - [InjectableVersion](#injectableVersion)
+  - [Override](#override)
   - [Sealed](#sealed)
   - [TestTag](#testtag)
   - Deprecated
@@ -369,8 +371,16 @@ class MyService
 
 ```
 
+## Override
 
+The `#[Override]` attribute is used to denote that a method is overriding a method in a parent class. This is the functionality is similar to the `@override` annotation in Java.
 
+This is temporary until PHP 8.3 is released. See the [RFC](https://wiki.php.net/rfc/marking_overriden_methods) that will be implemented in PHP 8.3.
+
+NOTE: 
+
+- If you are using PHP 8.3 then use the real `#[Override]` attribute.
+- This implementation doesn't consider traits. 
 
 ## Sealed
 

examples/override/overrideOnClass.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OverrideOnClass {
+
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    abstract class BaseClass {
+
+        abstract public function method1(): void;
+
+        public function method2(): void {}
+
+        public function anotherMethod(): void {}
+
+    }
+
+
+    class Class1 extends BaseClass {
+
+        #[Override] public function method1(): void
+        {
+        }
+
+        #[Override] public function method2(): void
+        {
+        }
+
+        #[Override] public function method4(): void // ERROR
+        {
+        }
+    }
+
+
+    new class extends BaseClass {
+        #[Override] public function method1(): void
+        {
+        }
+
+        #[Override] public function method2(): void
+        {
+        }
+
+        #[Override] public function method3(): void // ERROR
+        {
+        }
+    };
+
+}

examples/override/overrideOnInterface.php

@@ -0,0 +1,51 @@
+<?php
+
+declare(strict_types=1);
+
+namespace OverrideOnInterface {
+
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    abstract class AnInterface {
+
+        abstract public function method1(): void;
+
+        public function method2(): void {}
+
+        public function anotherMethod(): void {}
+
+    }
+
+
+    class Class1 extends AnInterface {
+
+        #[Override] public function method1(): void
+        {
+        }
+
+        #[Override] public function method2(): void
+        {
+        }
+
+        #[Override] public function method4(): void // ERROR method4
+        {
+        }
+    }
+
+
+    new class extends AnInterface {
+        #[Override] public function method1(): void
+        {
+        }
+
+        #[Override] public function method2(): void
+        {
+        }
+
+        #[Override] public function method3(): void // ERROR method3
+        {
+        }
+    };
+
+}

examples/override/overrideRfcExamples.php

@@ -0,0 +1,116 @@
+<?php
+
+declare(strict_types=1);
+
+namespace overrideRfcExample1 {
+
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    class P {
+        protected function p(): void {}
+    }
+
+    class C extends P {
+        #[Override]
+        public function p(): void {}
+    }
+}
+
+namespace overrideRfcExample2 {
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    class Foo implements \IteratorAggregate
+    {
+        #[Override]
+        public function getIterator(): \Traversable
+        {
+            yield from [];
+        }
+    }
+}
+
+
+namespace overrideRfcExample5 {
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    interface I {
+        public function i();
+    }
+
+    interface II extends I {
+        #[Override]
+        public function i();
+    }
+
+    class P {
+        public function p1() {}
+        public function p2() {}
+        public function p3() {}
+        public function p4() {}
+    }
+
+    class PP extends P {
+        #[Override]
+        public function p1() {}
+        public function p2() {}
+        #[Override]
+        public function p3() {}
+    }
+
+    class C extends PP implements I {
+        #[Override]
+        public function i() {}
+        #[Override]
+        public function p1() {}
+        #[Override]
+        public function p2() {}
+        public function p3() {}
+        #[Override]
+        public function p4() {}
+        public function c() {}
+    }
+}
+
+namespace overrideRfcExample6 {
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    class C
+    {
+        #[Override] public function c(): void {} // ERROR c
+    }
+}
+
+namespace overrideRfcExample7 {
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    interface I {
+        public function i(): void;
+    }
+
+    class P {
+        #[Override] public function i(): void {} // ERROR i
+    }
+
+    class C extends P implements I {}
+}
+
+
+
+namespace overrideRfcExample9 {
+
+    use DaveLiddament\PhpLanguageExtensions\Override;
+
+    class P {
+        private function p(): void {}
+    }
+
+    class C extends P {
+        #[Override] public function p(): void {} // ERROR p
+    }
+}
+

src/Override.php

@@ -0,0 +1,16 @@
+<?php
+
+declare(strict_types=1);
+
+namespace DaveLiddament\PhpLanguageExtensions;
+
+/**
+ * Add to a method to indicate it is overriding a method in a parent class/interface.
+ */
+#[\Attribute(\Attribute::TARGET_METHOD)]
+final class Override
+{
+    public function __construct()
+    {
+    }
+}