Abstract Class yii\codeception\BasePage
| Inheritance | yii\codeception\BasePage » yii\base\Component » yii\base\BaseObject |
|---|---|
| Implements | yii\base\Configurable |
| Available since version | 2.0 |
| Source Code | https://github.com/yiisoft/yii2-codeception/blob/master/BasePage.php |
BasePage is the base class for page classes that represent Web pages to be tested.
Public Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $behaviors | yii\base\Behavior[] | List of behaviors attached to this component. This property is read-only. | yii\base\Component |
| $route | string|array | The route (controller ID and action ID, e.g. site/about) to this page. |
yii\codeception\BasePage |
| $url | string | The URL to this page | yii\codeception\BasePage |
Protected Properties
| Property | Type | Description | Defined By |
|---|---|---|---|
| $actor | \Codeception\Actor | The testing guy object | yii\codeception\BasePage |
Public Methods
| Method | Description | Defined By |
|---|---|---|
| __call() | Calls the named method which is not a class method. | yii\base\Component |
| __clone() | This method is called after the object is created by cloning an existing one. | yii\base\Component |
| __construct() | Constructor. | yii\codeception\BasePage |
| __get() | Returns the value of a component property. | yii\base\Component |
| __isset() | Checks if a property is set, i.e. defined and not null. | yii\base\Component |
| __set() | Sets the value of a component property. | yii\base\Component |
| __unset() | Sets a component property to be null. | yii\base\Component |
| attachBehavior() | Attaches a behavior to this component. | yii\base\Component |
| attachBehaviors() | Attaches a list of behaviors to the component. | yii\base\Component |
| behaviors() | Returns a list of behaviors that this component should behave as. | yii\base\Component |
| canGetProperty() | Returns a value indicating whether a property can be read. | yii\base\Component |
| canSetProperty() | Returns a value indicating whether a property can be set. | yii\base\Component |
| className() | Returns the fully qualified name of this class. | yii\base\BaseObject |
| detachBehavior() | Detaches a behavior from the component. | yii\base\Component |
| detachBehaviors() | Detaches all behaviors from the component. | yii\base\Component |
| ensureBehaviors() | Makes sure that the behaviors declared in behaviors() are attached to this component. | yii\base\Component |
| getBehavior() | Returns the named behavior object. | yii\base\Component |
| getBehaviors() | Returns all behaviors attached to this component. | yii\base\Component |
| getUrl() | Returns the URL to this page. | yii\codeception\BasePage |
| hasEventHandlers() | Returns a value indicating whether there is any handler attached to the named event. | yii\base\Component |
| hasMethod() | Returns a value indicating whether a method is defined. | yii\base\Component |
| hasProperty() | Returns a value indicating whether a property is defined for this component. | yii\base\Component |
| init() | Initializes the object. | yii\base\BaseObject |
| off() | Detaches an existing event handler from this component. | yii\base\Component |
| on() | Attaches an event handler to an event. | yii\base\Component |
| openBy() | Creates a page instance and sets the test guy to use $url. | yii\codeception\BasePage |
| trigger() | Triggers an event. | yii\base\Component |
Property Details
The testing guy object
The route (controller ID and action ID, e.g. site/about) to this page.
Use array to represent a route with GET parameters. The first element of the array represents
the route and the rest of the name-value pairs are treated as GET parameters, e.g. array('site/page', 'name' => 'about').
The URL to this page
Method Details
Constructor.
| public void __construct ( $I ) | ||
| $I | \Codeception\Actor | The testing guy object |
Returns the URL to this page.
The URL will be returned by calling the URL manager of the application with $route and the provided parameters.
| public string getUrl ( $params = [] ) | ||
| $params | array | The GET parameters for creating the URL |
| return | string | The URL to this page |
|---|---|---|
| throws | yii\base\InvalidConfigException | if $route is not set or invalid |
Creates a page instance and sets the test guy to use $url.
| public static static openBy ( $I, $params = [] ) | ||
| $I | \Codeception\Actor | The test guy instance |
| $params | array | The GET parameters to be used to generate $url |
| return | static | The page instance |
|---|---|---|