istranger/phpunit-selenium-doc

This class provides extended documentation (phpDoc) for phpunit-selenium methods

v1.0.2 2015-06-05 20:37 UTC

Requires

• php: >=5.4.0
• phpunit/phpunit-selenium: *

MIT

• G.Azamat

• phpdoc
• phpunit
• doc
• selenium
• phpunit-selenium

README

This class provides extended documentation (phpDoc) for phpunit-selenium methods. Class can be used for easy development of tests in IDE (like phpStorm, NetBeans etc.).

SeleniumTestCaseDoc overrides documentation of PHPUnit_Extensions_SeleniumTestCase methods (according official description of selenium commands). The implementation of there overridden methods is unchanged.

Installation

Class SeleniumTestCaseDoc is trait, which can be mixed to any class (extended from PHPUnit_Extensions_SeleniumTestCase).

• Manual installation: extract files under vendor directory and add this class to your autoloader (or include manually).
• Installation via composer: add to your composer.json file ("require" section) the following line "istranger/yii-resource-smart-load": "dev-master" (see packagist page)
• Add to your web test class SeleniumTestCaseDoc as trait:

class WebTestCase extends CWebTestCase // CWebTestCase extends PHPUnit_Extensions_SeleniumTestCase
{
    use SeleniumTestCaseDoc; // use extended documentation for selenium methods
    ...

Resources

• Original phpunit class with minimal documentation: SeleniumTestCase.php
• HTML documentation(generated from this class): SeleniumTestCaseDoc.html
• Description of selenium core commands