php.net references

Author: nikophil

_build/notes.md

@@ -11,3 +11,5 @@ Notes
 
 - warning about exceptions thrown and abortOnError conf
 - add some format check on references
+- test other notation for api reference
+- conf file, at least for sf version

_build/src/HtmlKernel.php

@@ -20,6 +20,7 @@
 use SymfonyDocs\Reference\ClassReference;
 use SymfonyDocs\Reference\MethodReference;
 use SymfonyDocs\Reference\NamespaceReference;
+use SymfonyDocs\Reference\PhpClassReference;
 use SymfonyDocs\Reference\PhpFunctionReference;
 use SymfonyDocs\Reference\PhpMethodReference;
 use SymfonyDocs\Reference\RefReference;
@@ -75,13 +76,13 @@ public function getReferences(): array
     {
         return [
             new Doc(),
-//            new Doc('ref'),
             new RefReference(),
             new ClassReference(),
             new MethodReference(),
             new NamespaceReference(),
             new PhpFunctionReference(),
             new PhpMethodReference(),
+            new PhpClassReference(),
         ];
     }
 }

_build/src/Reference/PhpClassReference.php

@@ -4,19 +4,22 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class PhpClassReference extends Reference
 {
+    private const BASE__URL = 'https://secure.php.net/manual/en/class.%s.php';
+
     public function getName(): string
     {
         return 'phpclass';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        return new ResolvedReference(
+            $data,
+            sprintf(self::BASE__URL, strtolower($data))
+        );
     }
 }

_build/src/Reference/PhpFunctionReference.php

@@ -4,20 +4,22 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class PhpFunctionReference extends Reference
 {
+    private const BASE__URL = 'https://secure.php.net/manual/en/function.%s.php';
+
     public function getName(): string
     {
         return 'phpfunction';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        return new ResolvedReference(
+            $data,
+            sprintf(self::BASE__URL, str_replace('_', '-', strtolower($data)))
+        );
     }
-
 }

_build/src/Reference/PhpMethodReference.php

@@ -4,19 +4,25 @@
 
 use Doctrine\RST\Environment;
 use Doctrine\RST\Reference;
-use Doctrine\RST\References\Resolver;
 use Doctrine\RST\References\ResolvedReference;
 
 class PhpMethodReference extends Reference
 {
+    private const BASE__URL = 'https://secure.php.net/manual/en/%s.%s.php';
+
     public function getName(): string
     {
         return 'phpmethod';
     }
 
     public function resolve(Environment $environment, string $data): ResolvedReference
     {
-        $resolver = new Resolver();
-        return $resolver->resolve($environment, $data);
+        $class = explode('::', $data)[0];
+        $method = explode('::', $data)[1];
+
+        return new ResolvedReference(
+            $data.'()',
+            sprintf(self::BASE__URL, strtolower($class), strtolower($method))
+        );
     }
 }

_build/tests/IntegrationTest.php

@@ -141,6 +141,18 @@ public function parserUnitBlockProvider()
         yield 'method-reference' => [
             'documentName' => 'method-reference',
         ];
+
+        yield 'php-class-reference' => [
+            'documentName' => 'php-class-reference',
+        ];
+
+        yield 'php-function-reference' => [
+            'documentName' => 'php-function-reference',
+        ];
+
+        yield 'php-method-reference' => [
+            'documentName' => 'php-method-reference',
+        ];
     }
 
     public function testRefReferenceError()

_build/tests/fixtures/expected/blocks/php-class-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://secure.php.net/manual/en/class.arrayaccess.php" title="ArrayAccess">ArrayAccess</a></p>
+</body>
+</html>

_build/tests/fixtures/expected/blocks/php-function-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://secure.php.net/manual/en/function.trigger-error.php" title="ArrayAccess">trigger_error</a></p>
+</body>
+</html>

_build/tests/fixtures/expected/blocks/php-method-reference.html

@@ -0,0 +1,9 @@
+<!DOCTYPE html>
+<html>
+<head>
+    <meta charset="utf-8" />
+</head>
+<body>
+<p><a class="reference external" href="https://secure.php.net/manual/en/locale.getdefault.php" title="Locale">Locale::getDefault()</a></p>
+</body>
+</html>

_build/tests/fixtures/source/blocks/php-class-reference.rst

@@ -0,0 +1,2 @@
+
+:phpclass:`ArrayAccess`

_build/tests/fixtures/source/blocks/php-function-reference.rst

@@ -0,0 +1,2 @@
+
+:phpfunction:`trigger_error`

_build/tests/fixtures/source/blocks/php-method-reference.rst

@@ -0,0 +1,2 @@
+
+:phpmethod:`Locale::getDefault`