Php class to parse robots.txt rules according to Google & Yandex specifications. Please keep in mind that this is an alpha-version project, as you might see from the coverage report :) But I am about to change that.
The library is available for install via Composer package. To install via Composer, please add the requerement to your composer.json file, like this:
{
"require": {
"t1gor/robots-txt-parser": "dev-master"
}
}and then use composer to load the lib:
<?php
require 'vendor/autoload.php';
$parser = new RobotsTxtParser(file_get_contents('http://example.com/robots.txt'));
...You can find out more about Composer here: https://getcomposer.org/
<?php
require_once('robotstxtparser.php');
$parser = new RobotsTxtParser(file_get_contents('http://example.com/robots.txt'));
var_dump($parser->isDisallowed('/someurl'));
var_dump($parser->isAllowed('/someotherurl.html'));
print_r($parser->rules);
?>More code samples could be found in the tests folder.
Conditions:
- (0) ZERO_POINT
- (1) READ_DIRECTIVE
- (2) SKIP_SPACE
- (3) READ_VALUE
- (4) SKIP_LINE
Some useful links and materials:
- Google: Robots.txt Specifications
- Yandex: Using robots.txt
- Some inspirational code, and some more
- Google Webmaster tools Robots.txt testing tool
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 simplier, or at least seems to :)
- Following the coding standard would also be much appreciated (4 tabs as an ident, camelCase, etc.)
I would really appreciate if you could share the link to your project that is utilizing the lib.
- Fix open issues
- Raise coverage. The goal is to reach at least 50% and release v1.0
- Add a method for validation
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.