{"id":25803061,"url":"https://github.com/haodt/rylai","last_synced_at":"2025-10-07T19:59:02.141Z","repository":{"id":62514520,"uuid":"77062907","full_name":"haodt/rylai","owner":"haodt","description":"PHP's document support library. Provide an application to build a complete and full featured document generator app","archived":false,"fork":false,"pushed_at":"2017-05-06T22:49:21.000Z","size":1568,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-06-03T09:23:40.395Z","etag":null,"topics":["analyzer","api","generator","php-document","web"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haodt.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-21T15:23:11.000Z","updated_at":"2019-01-01T17:28:01.000Z","dependencies_parsed_at":"2022-11-02T10:30:53.646Z","dependency_job_id":null,"html_url":"https://github.com/haodt/rylai","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/haodt/rylai","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haodt%2Frylai","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haodt%2Frylai/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haodt%2Frylai/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haodt%2Frylai/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haodt","download_url":"https://codeload.github.com/haodt/rylai/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haodt%2Frylai/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":278838468,"owners_count":26054721,"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","status":"online","status_checked_at":"2025-10-07T02:00:06.786Z","response_time":59,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["analyzer","api","generator","php-document","web"],"created_at":"2025-02-27T17:44:10.810Z","updated_at":"2025-10-07T19:59:02.114Z","avatar_url":"https://github.com/haodt.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# RYLAI\nPHP's document support library. Provide an application to build a complete and full featured document generator app. \n### Installation\n```bash\ncomposer require haodt/rylai\n```\n### Usage\n- Take a look at `rylai.php`, that script is used to build this library document\n- Clone the script to your project, change paths to suit your need. Each path represent a repository.\n- Path's key should be your root namespace defined in composer.json . Take a look at this library's composer.json file for detail\n```\nrequire_once __DIR__ . \"/vendor/autoload.php\";\n\nuse Rylai\\Analyzers\\Docblock;\nuse Rylai\\Runner\\AbstractRunner;\nuse Rylai\\Stores\\Local;\n\nclass Runner extends AbstractRunner\n{\n    public function getPaths()\n    {\n        return [\n            \"Rylai\" =\u003e __DIR__ . \"/src/\",\n        ];\n    }\n\n    public function getAnalyzers()\n    {\n        return [\n            new Docblock,\n        ];\n    }\n\n    public function getStores()\n    {\n        return [\n            new Local([\n                \"views\" =\u003e __DIR__ . \"/views\",\n                \"store\" =\u003e __DIR__ . \"/docs\",\n            ]),\n        ];\n    }\n}\n\n$runner = new Runner();\n$runner-\u003erun();\n```\n### How it works?\n- Analyzer will read file and provide back a report for that file\n- Store will collect reports then save it to backend (html,nosql,sql ... )\n### Notes\n- In order to parse your files, rylai must be able to load all files and execute it. This will result in extension class might have some issues\n- This library is tested under psr 4 standard files and folders, if you use other coding standards, please write more tests for it.\n- There are issues with resolving Types alias like Rylai\\Fixtures\\Items\\Courier for Courier inside tags so you have to compare it with namespaces aliases\n- Constants wont be able to have docblock so far\n- Local store will use key - value paths as in key is your root namespace, in this project case you can see composer.json load Rylai\\\\ point to src folder\n### Todo\n- Elasticstore will be implemeted in near future\n- Replace `?` mark as value of properties because there is some issues around private properties that blocking parser to read the value\n- Add few more analyzers\n\n### Development\n- Run tests\n```bash\nphp vendor/phpunit/phpunit/phpunit\n```\n- Pull requests are welcome :)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaodt%2Frylai","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaodt%2Frylai","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaodt%2Frylai/lists"}