fix docs

Author: klimov-paul

README.md

@@ -10,8 +10,8 @@ This extension provides support for ActiveRecord custom records order setup.
 
 For license information check the [LICENSE](LICENSE.md)-file.
 
-[![Latest Stable Version](https://poser.pugx.org/yii2tech/ar-position/v/stable.png)](https://packagist.org/packages/yii2tech/ar-position)
-[![Total Downloads](https://poser.pugx.org/yii2tech/ar-position/downloads.png)](https://packagist.org/packages/yii2tech/ar-position)
+[![Latest Stable Version](https://img.shields.io/packagist/v/yii2tech/ar-position.svg)](https://packagist.org/packages/yii2tech/ar-position)
+[![Total Downloads](https://img.shields.io/packagist/dt/yii2tech/ar-position.svg)](https://packagist.org/packages/yii2tech/ar-position)
 [![Build Status](https://travis-ci.org/yii2tech/ar-position.svg?branch=master)](https://travis-ci.org/yii2tech/ar-position)
 
 
@@ -40,10 +40,15 @@ Usage
 
 This extension provides support for custom records order setup via column-based position index.
 
-This extension provides [[\yii2tech\ar\position\PositionBehavior]] ActiveRecord behavior for such solution
+This extension provides `\yii2tech\ar\position\PositionBehavior` ActiveRecord behavior for such solution
 support in Yii2. You may attach it to your model class in the following way:
 
 ```php
+<?php
+
+use yii\db\ActiveRecord;
+use yii2tech\ar\position\PositionBehavior;
+
 class Item extends ActiveRecord
 {
     public function behaviors()
@@ -59,11 +64,13 @@ class Item extends ActiveRecord
 ```
 
 Behavior uses the specific integer field of the database entity to set up position index.
-Due to this the database entity, which the model refers to, must contain field [[positionAttribute]].
+Due to this the database entity, which the model refers to, must contain field `positionAttribute`.
 
-In order to display custom list in correct order you should sort it by [[positionAttribute]] in ascending mode:
+In order to display custom list in correct order you should sort it by `positionAttribute` in ascending mode:
 
 ```php
+<?php
+
 $records = Item::find()->orderBy(['position' => SORT_ASC])->all();
 foreach ($records as $record) {
     echo $record->position . ', ';
@@ -72,60 +79,71 @@ foreach ($records as $record) {
 ```
 
 
-## Position saving <span id="position-saving"></span>
+### Position saving <span id="position-saving"></span>
 
 Being attached, behavior automatically fills up `positionAttribute` value for the new record, placing it to the end
 of the list:
 
 ```php
+<?php
+
 echo Item::find()->count(); // outputs: 4
 
 $item = new Item();
 $item->save();
 
-echo $item->position // outputs: 5
+echo $item->position; // outputs: 5
 ```
 
 However, you may setup position for the new record explicitly:
 
 ```php
+<?php
+
 echo Item::find()->count(); // outputs: 4
 
 $item = new Item();
 $item->position = 2; // enforce position '2'
 $item->save();
 
-echo $item->position // outputs: 2 !!!
+echo $item->position; // outputs: 2 !!!
 ```
 
 
-## Position switching <span id="position-switching"></span>
+### Position switching <span id="position-switching"></span>
 
 Existing record can be moved to another position using following methods:
 
- - [[movePrev()]] - moves record by one position towards the start of the list.
- - [[moveNext()]] - moves record by one position towards the end of the list.
- - [[moveFirst()]] - moves record to the start of the list.
- - [[moveLast()]] - moves record to the end of the list.
- - [[moveToPosition()]] - moves owner record to the specific position.
+ - `movePrev()` - moves record by one position towards the start of the list.
+ - `moveNext()` - moves record by one position towards the end of the list.
+ - `moveFirst()` - moves record to the start of the list.
+ - `moveLast()` - moves record to the end of the list.
+ - `moveToPosition()` - moves owner record to the specific position.
 
 You may as well change record position through the attribute, provided to `positionAttribute` directly:
 
 ```php
+<?php
+
 $item = Item::find()->andWhere(['position' => 3])->one();
 $item->position = 5; // switch position to '5'
 $item->save();
 ```
 
 
-## Position in group <span id="position-in-group"></span>
+### Position in group <span id="position-in-group"></span>
 
 Sometimes single database entity contains several listings, which require custom ordering, separated logically
 by grouping attributes. For example: FAQ questions may be grouped by categories, while inside single category
-questions should be ordered manually. For this case [[\yii2tech\ar\position\PositionBehavior::$groupAttributes]]
+questions should be ordered manually. For this case `\yii2tech\ar\position\PositionBehavior::$groupAttributes`
 can be used:
 
 ```php
+<?php
+
+use yii\db\ActiveRecord;
+use yii2tech\ar\position\PositionBehavior;
+
 class FaqQuestion extends ActiveRecord
 {
     public function behaviors()
@@ -147,28 +165,32 @@ In this case behavior will use owner values of `groupAttributes` as additional c
 calculation and changing:
 
 ```php
+<?php
+
 echo FaqQuestion::find()->andWhere(['categoryId' => 1])->count(); // outputs: '4'
 echo FaqQuestion::find()->andWhere(['categoryId' => 2])->count(); // outputs: '7'
 
 $record = new FaqQuestion();
 $record->categoryId = 1;
 $record->save();
-echo $record->position // outputs: '5'
+echo $record->position; // outputs: '5'
 
 $record = new FaqQuestion();
 $record->categoryId = 2;
 $record->save();
-echo $record->position // outputs: '8'
+echo $record->position; // outputs: '8'
 ```
 
 
-## List navigation <span id="list-navigation"></span>
+### List navigation <span id="list-navigation"></span>
 
 Records with custom position order applied make a chained list, which you may navigate if necessary.
-You may use [[\yii2tech\ar\position\PositionBehavior::getIsFirst()]] and [[\yii2tech\ar\position\PositionBehavior::getIsLast()]]
+You may use `\yii2tech\ar\position\PositionBehavior::getIsFirst()` and `\yii2tech\ar\position\PositionBehavior::getIsLast()`
 methods to determine if particular record is the first or last one in the list. For example:
 
 ```php
+<?php
+
 echo Item::find()->count(); // outputs: 10
 
 $firstItem = Item::find()->andWhere(['position' => 1])->one();
@@ -181,10 +203,12 @@ echo $lastItem->getIsLast(); // outputs: true
 ```
 
 Having a particular record instance, you can always find record, which is located at next or previous position to it,
-using [[\yii2tech\ar\position\PositionBehavior::getNext()]] or [[\yii2tech\ar\position\PositionBehavior::getPrev()]] method.
+using `\yii2tech\ar\position\PositionBehavior::getNext()` or `\yii2tech\ar\position\PositionBehavior::getPrev()` method.
 For example:
 
 ```php
+<?php
+
 $item = Item::find()->andWhere(['position' => 5])->one();
 
 $nextItem = $item->findNext();
@@ -197,6 +221,8 @@ echo $prevItem->position; // outputs: 4
 You may as well get the first and the last records in the list. For example:
 
 ```php
+<?php
+
 echo Item::find()->count(); // outputs: 10
 $item = Item::find()->andWhere(['position' => 5])->one();
 

src/PositionBehavior.php

@@ -14,7 +14,7 @@
 /**
  * PositionBehavior allows managing custom order for the records in the database.
  * Behavior uses the specific integer field of the database entity to set up position index.
- * Due to this the database entity, which the model refers to, must contain field [[positionAttribute]].
+ * Due to this the database entity, which the model refers to, must contain field {@see positionAttribute}.
  *
  * ```php
  * class Item extends ActiveRecord
@@ -439,7 +439,7 @@ public function beforeUpdate($event)
 
     /**
      * This event raises after owner inserted or updated.
-     * It applies previously set [[positionOnSave]].
+     * It applies previously set {@see positionOnSave}.
      * This event supports other functionality.
      * @param ModelEvent $event event instance.
      */