{"id":15729138,"url":"https://github.com/voku/php-doc-fixer","last_synced_at":"2025-03-13T03:30:48.925Z","repository":{"id":44805031,"uuid":"313145278","full_name":"voku/php-doc-fixer","owner":"voku","description":"This is an experiment! Let's check / fix the PHP documentation automatically.","archived":false,"fork":false,"pushed_at":"2023-12-15T11:50:46.000Z","size":279,"stargazers_count":4,"open_issues_count":3,"forks_count":2,"subscribers_count":3,"default_branch":"main","last_synced_at":"2024-10-29T22:47:03.403Z","etag":null,"topics":["hacktoberfest","php","php-docs"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/voku.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":".github/CONTRIBUTING.md","funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null},"funding":{"github":["voku"],"patreon":"voku","custom":"https://www.paypal.me/moelleken"}},"created_at":"2020-11-15T23:37:59.000Z","updated_at":"2021-10-04T21:17:07.000Z","dependencies_parsed_at":"2023-12-17T09:43:42.006Z","dependency_job_id":null,"html_url":"https://github.com/voku/php-doc-fixer","commit_stats":{"total_commits":21,"total_committers":4,"mean_commits":5.25,"dds":"0.47619047619047616","last_synced_commit":"d01fd21c3e93906fe25c010b43adf01e3925362e"},"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fphp-doc-fixer","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fphp-doc-fixer/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fphp-doc-fixer/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/voku%2Fphp-doc-fixer/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/voku","download_url":"https://codeload.github.com/voku/php-doc-fixer/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":243335125,"owners_count":20274896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["hacktoberfest","php","php-docs"],"created_at":"2024-10-03T23:20:25.181Z","updated_at":"2025-03-13T03:30:48.618Z","avatar_url":"https://github.com/voku.png","language":"PHP","funding_links":["https://github.com/sponsors/voku","https://patreon.com/voku","https://www.paypal.me/moelleken"],"categories":[],"sub_categories":[],"readme":"\n# ***PHP-Documentation-Check***\n\nThis is a experiment! Lets check and fix the php documentation automatically.\n\n### install\n```bash\ngit clone https://github.com/php/doc-en.git // optional: only if you want to check it\ngit clone https://github.com/php/php-src.git // optional: by default we use the PhpStorm Stubs from vendor directory but you can also use different stubs\ngit clone https://github.com/jetbrains/phpstorm-stubs.git // optional: by default we use the PhpStorm Stubs from vendor directory but you can also use external stubs\ngit clone https://github.com/vimeo/psalm.git // optional: only if you want to check it\ngit clone https://github.com/phpstan/phpstan-src.git // optional: only if you want to check it\ngit clone https://github.com/voku/php-doc-fixer.git\ncd php-doc-fixer/\ncomposer update --prefer-dist\n```\n\n### command for analysing static code analysis stubs (PHPStan, Psalm, ...)\n```\nphp bin/phpdocfixer static_analysis [--remove-array-value-info=\"true\"] [--stubs-path=\"vendor/jetbrains/phpstorm-stubs/\"] [--stubs-file-extension=\".php\"] ../phpstan-src/resources/functionMap.php\n```\n\n#### example: check types from php-src against static code analysis stubs from PHPStan\n```\nphp bin/phpdocfixer static_analysis --remove-array-value-info=\"true\" --stubs-path=\"../php-src/\" --stubs-file-extension=\".stub.php\" ../phpstan-src/resources/functionMap.php\n```\n\n#### example: check types from phpstorm-stubs (mysqli) against static code analysis stubs from PHPStan\n```\nphp bin/phpdocfixer static_analysis --stubs-path=\"../phpstorm-stubs/mysqli/\" ../phpstan-src/resources/functionMap.php\n```\n\n#### example: check types from PhpStorm stubs against static code analysis stubs from Psalm\n```\nphp bin/phpdocfixer static_analysis ../psalm/src/Psalm/Internal/CallMap.php\n```\n\n\n### command for analysing and fixing the php documentation\n```\nphp bin/phpdocfixer run [--auto-fix=\"true\"] [--remove-array-value-info=\"true\"] [--stubs-path=\"../php-src/\"] [--stubs-file-extension=\".stub.php\"] ../doc-en/reference/\n```\n\n#### example: sync types from PhpStorm Stubs into the php-documentation\n```\nphp bin/phpdocfixer run --auto-fix=\"true\" --remove-array-value-info=\"true\" ../doc-en/reference/\n```\n\n#### example: sync types from php-src into the php-documentation, but only for BCMath (bc)\n```\nphp bin/phpdocfixer run --auto-fix=\"true\" --stubs-path=\"../php-src/\" --stubs-file-extension=\".stub.php\" ../doc-en/reference/bc/\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoku%2Fphp-doc-fixer","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvoku%2Fphp-doc-fixer","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvoku%2Fphp-doc-fixer/lists"}