-
Notifications
You must be signed in to change notification settings - Fork 86
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Enhance PHP API Ref #2584
Merged
Merged
Enhance PHP API Ref #2584
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
https://docs.phpdoc.org/guide/references/phpdoc/tags/uses.html#uses-used-by is a tag added automatically when a @uses tag is met to create a mirror link back.
…er to each others.
7 tasks
adriendupuis
commented
Dec 20, 2024
I tested all the generated external links and found no error. <?php
$symfonyVersion = '5.4';
foreach (explode(PHP_EOL, trim(`find docs/api/php_api/php_api_reference/classes -type f`)) as $filePath) {
//echo "$filePath\n";
$grepCmd = "grep '<abbr title=\"\\\\Symfony\\\\' $filePath";
$grepLines = shell_exec($grepCmd);
if ($grepLines) {
foreach (explode(PHP_EOL, trim($grepLines)) as $grepLine) {
preg_match_all('/<abbr title="(?P<fqcn>\\\\Symfony\\\\[^"]+)"/', $grepLine, $matches);
foreach ($matches['fqcn'] as $fqcn) {
$href = 'https://github.com/symfony/symfony/blob/' . $symfonyVersion . '/src' . str_replace('\\', '/', $fqcn) . '.php';
//echo "$href\n";
$headers = @get_headers($href);
if (empty($headers)) {
sleep(2);
$headers = @get_headers($href);
}
if (empty($headers)) {
echo "$filePath 'HTTP request failed' $href\n";
} elseif ('HTTP/1.1 200 OK' !== $headers[0]) {
echo "$filePath '{$headers[0]}' $href\n";
}
}
}
}
} |
mnocon
approved these changes
Jan 2, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks!
adriendupuis
added a commit
that referenced
this pull request
Jan 6, 2025
* .phpdoc/template/components/tags.html.twig: Handle @Used-By * .phpdoc/template/components/properties.html.twig: Get duplicates closer to each others. * .phpdoc/template/class.html.twig: Deduplicates properties * .phpdoc/template: Indicate interface or abstract * .phpdoc/template/trait.html.twig: Add missing template * .phpdoc/template/: Redo external links to GitHub using JS (cherry picked from commit 53836ce)
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
depth
properties in the right ToC, those two are far from each other in the center page but have the same anchor which complicates navigation.depth
in the ToC, the two central ones are close to each other.redirectToLocation()
returned value class is also a link.@used-by
tag.TODO: Merge #2585 before merging this one.
Checklist