Download the PHP package t1gor/robots-txt-parser without Composer
On this page you can find all versions of the php package t1gor/robots-txt-parser. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download t1gor/robots-txt-parser
More information about t1gor/robots-txt-parser
Files in t1gor/robots-txt-parser
Package robots-txt-parser
Short Description PHP class to parse robots.txt rules according to Google, Yandex, W3C and The Web Robots Pages specifications.
License MIT
Homepage https://github.com/t1gor/Robots.txt-Parser-Class
FAQ
Example:
In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
- Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
- To use Composer is sometimes complicated. Especially for beginners.
- Composer needs much resources. Sometimes they are not available on a simple webspace.
- If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
- Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Informations about the package robots-txt-parser
Robots.txt php parser class
PHP class to parse robots.txt rules according to Google, Yandex, W3C and The Web Robots Pages specifications.
Full list of supported specifications (and what's not supported, yet) are available in our Wiki.
Supported directives:
- User-agent
- Allow
- Disallow
- Sitemap
- Host
- Cache-delay
- Clean-param
- Crawl-delay
- Request-rate (in progress)
- Visit-time (in progress)
Installation
The library is available for install via Composer package. To install via Composer, please add the requirement to your composer.json file, like this:
You can find out more about Composer here: https://getcomposer.org/
Usage example
Creating parser instance
Logging parsing process
We are implementing LoggerAwareInterface from PSR, so it should work out of the box with any logger supporting that standard. Please see below for Monolog example with Telegram bot:
Most log entries we have are of LogLevel::DEBUG, but there might also be some LogLevel::WARNINGS where it is appropriate.
Parsing non UTF-8 encoded files
Public API
| Method | Params | Returns | Description |
|---|---|---|---|
setLogger |
Psr\Log\LoggerInterface $logger |
void |
|
getLogger |
- |
Psr\Log\LoggerInterface |
|
setHttpStatusCode |
int $code |
void |
Set HTTP response code for allowance checks |
isAllowed |
string $url, ?string $userAgent |
bool |
If no $userAgent is passed, will return for * |
isDisallowed |
string $url, ?string $userAgent |
bool |
If no $userAgent is passed, will return for * |
getDelay |
string $userAgent, string $type = 'crawl-delay' |
float |
Get any of the delays, e.g. Crawl-delay, Cache-delay, etc. |
getCleanParam |
- |
[ string => string[] ] |
Where key is the path, and values are params |
getRules |
?string $userAgent |
array |
Get the rules the parser read in a tree-line structure |
getHost |
?string $userAgent |
string[] or string or null |
If no $userAgent is passed, will return all |
getSitemaps |
?string $userAgent |
string[] |
If no $userAgent is passed, will return all |
getContent |
- |
string |
The content that was parsed. |
getLog |
- |
[] |
Deprecated. Please use PSR logger as described above. |
render |
- |
string |
Deprecated. Please getContent |
Even more code samples could be found in the tests folder.
Some useful links and materials:
- Google: Robots.txt Specifications
- Yandex: Using robots.txt
- The Web Robots Pages
- W3C Recommendation
- Some inspirational code, and some more
- Google Webmaster tools Robots.txt testing tool
Contributing
First of all - thank you for your interest and a desire to help! If you found an issue and know how to fix it, please submit a pull request to the dev branch. Please do not forget the following:
- Your fixed issue should be covered with tests (we are using phpUnit)
- Please mind the code climate recommendations. It some-how helps to keep things simpler, or at least seems to :)
- Following the coding standard would also be much appreciated (4 tabs as an indent, camelCase, etc.)
I would really appreciate if you could share the link to your project that is utilizing the lib.
License
The MIT License
Copyright (c) 2013 Igor Timoshenkov
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.