bug #136 Use github.com instead of api.symfony.com (wouterj)

This PR was merged into the main branch.

Discussion
----------

Use github.com instead of api.symfony.com

ref symfony/symfony-docs#16322

Commits
-------

76fde8f Use github.com instead of api.symfony.com

Author: javiereguiluz

src/BuildConfig.php

@@ -16,7 +16,7 @@
 class BuildConfig
 {
     private const PHP_DOC_URL = 'https://secure.php.net/manual/en';
-    private const SYMFONY_API_URL = 'https://api.symfony.com/{symfonyVersion}';
+    private const GITHUB_URL = 'https://github.com/symfony/symfony/blob/{symfonyVersion}/src';
     private const SYMFONY_DOC_URL = 'https://symfony.com/doc/{symfonyVersion}';
 
     private $useBuildCache;
@@ -78,9 +78,9 @@ public function getPhpDocUrl(): string
         return self::PHP_DOC_URL;
     }
 
-    public function getSymfonyApiUrl(): string
+    public function getGithubUrl(): string
     {
-        return str_replace('{symfonyVersion}', $this->getSymfonyVersion(), self::SYMFONY_API_URL);
+        return str_replace('{symfonyVersion}', $this->getSymfonyVersion(), self::GITHUB_URL);
     }
 
     public function getSymfonyDocUrl(): string

src/KernelFactory.php

@@ -101,9 +101,9 @@ private static function getDirectives(): array
     private static function getReferences(BuildConfig $buildConfig): array
     {
         return [
-            new SymfonyReferences\ClassReference($buildConfig->getSymfonyApiUrl()),
-            new SymfonyReferences\MethodReference($buildConfig->getSymfonyApiUrl()),
-            new SymfonyReferences\NamespaceReference($buildConfig->getSymfonyApiUrl()),
+            new SymfonyReferences\ClassReference($buildConfig->getGithubUrl()),
+            new SymfonyReferences\MethodReference($buildConfig->getGithubUrl()),
+            new SymfonyReferences\NamespaceReference($buildConfig->getGithubUrl()),
             new SymfonyReferences\PhpFunctionReference($buildConfig->getPhpDocUrl()),
             new SymfonyReferences\PhpMethodReference($buildConfig->getPhpDocUrl()),
             new SymfonyReferences\PhpClassReference($buildConfig->getPhpDocUrl()),

src/Reference/ClassReference.php

@@ -16,11 +16,11 @@
 
 class ClassReference extends Reference
 {
-    private $symfonyApiUrl;
+    private $githubUrl;
 
-    public function __construct(string $symfonyApiUrl)
+    public function __construct(string $githubUrl)
     {
-        $this->symfonyApiUrl = $symfonyApiUrl;
+        $this->githubUrl = $githubUrl;
     }
 
     public function getName(): string
@@ -35,7 +35,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
         return new ResolvedReference(
             $environment->getCurrentFileName(),
             $className->afterLast('\\'),
-            sprintf('%s/%s.html', $this->symfonyApiUrl, $className->replace('\\', '/')),
+            sprintf('%s/%s.php', $this->githubUrl, $className->replace('\\', '/')),
             [],
             [
                 'title' => $className,

src/Reference/MethodReference.php

@@ -16,11 +16,11 @@
 
 class MethodReference extends Reference
 {
-    private $symfonyApiUrl;
+    private $githubUrl;
 
-    public function __construct(string $symfonyApiUrl)
+    public function __construct(string $githubUrl)
     {
-        $this->symfonyApiUrl = $symfonyApiUrl;
+        $this->githubUrl = $githubUrl;
     }
 
     public function getName(): string
@@ -42,7 +42,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
         return new ResolvedReference(
             $environment->getCurrentFileName(),
             $methodName.'()',
-            sprintf('%s/%s.html#method_%s', $this->symfonyApiUrl, str_replace('\\', '/', $className), $methodName),
+            sprintf('%s/%s.php#method_%s', $this->githubUrl, str_replace('\\', '/', $className), $methodName),
             [],
             [
                 'title' => sprintf('%s::%s()', $className, $methodName),

src/Reference/NamespaceReference.php

@@ -16,11 +16,11 @@
 
 class NamespaceReference extends Reference
 {
-    private $symfonyApiUrl;
+    private $githubUrl;
 
-    public function __construct(string $symfonyApiUrl)
+    public function __construct(string $githubUrl)
     {
-        $this->symfonyApiUrl = $symfonyApiUrl;
+        $this->githubUrl = $githubUrl;
     }
 
     public function getName(): string
@@ -35,7 +35,7 @@ public function resolve(Environment $environment, string $data): ResolvedReferen
         return new ResolvedReference(
             $environment->getCurrentFileName(),
             $className->afterLast('\\'),
-            sprintf('%s/%s.html', $this->symfonyApiUrl, $className->replace('\\', '/')),
+            sprintf('%s/%s', $this->githubUrl, $className->replace('\\', '/')),
             [],
             [
                 'title' => $className,

tests/fixtures/expected/blocks/references/class.html

@@ -1 +1 @@
-<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.html" class="reference external" title="Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel">ContainerAwareHttpKernel</a></p>
+<p><a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/HttpKernel/DependencyInjection/ContainerAwareHttpKernel.php" class="reference external" title="Symfony\Component\HttpKernel\DependencyInjection\ContainerAwareHttpKernel" rel="external noopener noreferrer" target="_blank">ContainerAwareHttpKernel</a></p>

tests/fixtures/expected/blocks/references/method.html

@@ -1 +1 @@
-<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpFoundation/RequestStack.html#method_getCurrentRequest" class="reference external" title="Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest()">getCurrentRequest()</a></p>
+<p><a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/HttpFoundation/RequestStack.php#method_getCurrentRequest" class="reference external" title="Symfony\Component\HttpFoundation\RequestStack::getCurrentRequest()" rel="external noopener noreferrer" target="_blank">getCurrentRequest()</a></p>

tests/fixtures/expected/blocks/references/namespace.html

@@ -1 +1 @@
-<p><a href="https://api.symfony.com/4.0/Symfony/Component/HttpFoundation.html" class="reference external" title="Symfony\Component\HttpFoundation">HttpFoundation</a></p>
+<p><a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/HttpFoundation" class="reference external" title="Symfony\Component\HttpFoundation" rel="external noopener noreferrer" target="_blank">HttpFoundation</a></p>

tests/fixtures/expected/main/datetime.html

@@ -44,7 +44,7 @@ <h1 id="datetimetype-field"><a class="headerlink" href="#datetimetype-field" tit
                             </tr>
                     <tr>
                                     <td>Class</td>
-                                    <td><a href="https://api.symfony.com/4.0/Symfony/Component/Form/Extension/Core/Type/DateTimeType.html" class="reference external" title="Symfony\Component\Form\Extension\Core\Type\DateTimeType">DateTimeType</a></td>
+                                    <td><a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/Form/Extension/Core/Type/DateTimeType.php" class="reference external" title="Symfony\Component\Form\Extension\Core\Type\DateTimeType" rel="external noopener noreferrer" target="_blank">DateTimeType</a></td>
                             </tr>
                     <tr>
                                     <td>Ref</td>
@@ -65,8 +65,8 @@ <h3 id="the-date-format-option"><a class="headerlink" href="#the-date-format-opt
                     <svg xmlns="http://www.w3.org/2000/svg" fill="none" width="24" height="24" viewBox="0 0 24 24" stroke="currentColor"><path stroke-linecap="round" stroke-linejoin="round" stroke-width="2" d="M9.663 17h4.673M12 3v1m6.364 1.636l-.707.707M21 12h-1M4 12H3m3.343-5.657l-.707-.707m2.828 9.9a5 5 0 117.072 0l-.548.547A3.374 3.374 0 0014 18.469V19a2 2 0 11-4 0v-.531c0-.895-.356-1.754-.988-2.386l-.548-.547z" /></svg>
                 <span>Tip</span>
     </p><p>This is a little tip about something! We an also talk about specific
-methods: <a href="https://api.symfony.com/4.0/Symfony/Component/BrowserKit/Client.html#method_doRequest" class="reference external" title="Symfony\Component\BrowserKit\Client::doRequest()">doRequest()</a>.
-Or a namespace: <a href="https://api.symfony.com/4.0/Symfony/Component/Validator/Constraints.html" class="reference external" title="Symfony\Component\Validator\Constraints">Constraints</a>.
+methods: <a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/BrowserKit/Client.php#method_doRequest" class="reference external" title="Symfony\Component\BrowserKit\Client::doRequest()" rel="external noopener noreferrer" target="_blank">doRequest()</a>.
+Or a namespace: <a href="https://github.com/symfony/symfony/blob/4.0/src/Symfony/Component/Validator/Constraints.php" class="reference external" title="Symfony\Component\Validator\Constraints" rel="external noopener noreferrer" target="_blank">Constraints</a>.
 Or a PHP function: <a href="https://secure.php.net/manual/en/function.parse-ini-file.php" class="reference external" title="parse_ini_file" rel="external noopener noreferrer" target="_blank">parse_ini_file</a>.
 Or a PHP method! <a href="https://secure.php.net/manual/en/locale.getdefault.php" class="reference external" title="Locale" rel="external noopener noreferrer" target="_blank">Locale::getDefault()</a>.</p>
 </div>