Восемь причин изучить PHPDoc

<?php
<?php
/* @var $this yii\web\View */
/* @var $searchModel \app\models\search\UserSearch */
/* @var $dataProvider yii\data\ActiveDataProvider */
?>

/**
 * This is the model class for table "{{%user}}".
 *
 * @property integer $id
 * @property string $username
 * @property string $auth_key
 * @property string $password_hash
 * @property string $email
 */
class User extends ActiveRecord
{
    ...
}

/**
 * Saves the current record.
 
 * @param boolean $runValidation whether to perform validation before saving the record.
 * @param array $attributeNames list of attribute names that need to be saved.
 * @return boolean whether the saving succeeded (i.e. no validation errors occurred).
 */
public function save($runValidation = true, $attributeNames = null)
{
    ...
}

namespace yii\db;
 
/**
 * ActiveRecord is the base class for classes representing relational data in terms of objects.
 *
 * ...
 *
 * As an example, say that the `Customer` ActiveRecord class is associated with the `customer` table.
 * This would mean that the class's `name` attribute is automatically mapped to the `name` column in `customer` table.
 * Thanks to Active Record, assuming the variable `$customer` is an object of type `Customer`, to get the value of
 * the `name` column for the table row, you can use the expression `$customer->name`.
 * In this example, Active Record is providing an object-oriented interface for accessing data stored in the database.
 * But Active Record provides much more functionality than this.
 *
 * To declare an ActiveRecord class you need to extend [[\yii\db\ActiveRecord]] and
 * implement the `tableName` method:
 *
 * ```php
 * <?php
 *
 * class Customer extends \yii\db\ActiveRecord
 * {
 *     public static function tableName()
 *     {
 *         return 'customer';
 *     }
 * }
 * ```
 * ...
 */
class ActiveRecord extends BaseActiveRecord
{
    ...
}

class Post extends ActiveRecord
{
    public static function tableName() {
        return '{{%post}}';
    }
}

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property integer $created_at
 * @property integer $updated_at
 * @property string $title
 * @property string $content
 * @property integer $status
 */
class Post extends ActiveRecord
{
    public static function tableName() {
        return '{{%post}}';
    }
}

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property string $title
 * @property string $content
 */
class Post extends ActiveRecord
{
    public function getCategory()
    {
        return $this->hasOne(Category::className(), ['id' => 'category_id']);
    }
 
    public function getUser()
    {
        return $this->hasOne(Category::className(), ['id' => 'category_id']);
    }
 
    public function getTags()
    {
        return $this->hasMany(Tag::className(), ['id' => 'tag_id'])->viaTable(PostTag::tableName(), ['post_id' => 'id']);
    }
}

echo $post->category->name;
 
echo $post->user->username;
 
foreach ($post->tags as $tag) {
    echo $tag->name;
}

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property string $title
 * @property string $content
 
 * @property User $user
 * @property Category $category
 * @property Tag[] $tags
 */
class Post extends ActiveRecord
{
    ...
}

class PasswordChangeForm extends Model
{
    ...
 
    private $_user;
 
    public function __construct($user, $config = [])
    {
        $this->_user = $user;
        parent::__construct($config);
    }
 
    ...
 
    public function changePassword()
    {
        if ($this->validate()) {
            $user = $this->_user;
            $user->setPassword($this->newPassword);
            return $user->save();
        } else {
            return false;
        }
    }
}

$user = $this->_user;
$user->setPassword($this->newPassword);
return $user->save();

class PasswordChangeForm extends Model
{
    /**
     * @var User
     */
    private $_user;
}

class UsersController extends Controller
{
    /**
     * @param integer $id
     * @return User
     * @throws NotFoundHttpException
     */
    protected function findModel($id)
    {
        if (($model = User::findOne($id)) !== null) {
            return $model;
        } else {
            throw new NotFoundHttpException('The requested page does not exist.');
        }
    }
}

class UsersController extends Controller
{
    public function actionUpdate($id)
    {
        $model = $this->findModel($id);
 
        if ($model->load(Yii::$app->request->post()) && $model->save()) {
            return $this->redirect(['view', 'id' => $model->id]);
        } else {
            return $this->render('update', [
                'model' => $model,
            ]);
        }
    }
}

<?php
<?php
use yii\helpers\Html;
use yii\widgets\DetailView;
 
$this->title = $model->meta_title;
$this->registerMetaTag(['name' => 'description', 'content' => $model->meta_description]);
$this->registerMetaTag(['name' => 'keywords', 'content' => $model->meta_keywords]);
 
$this->params['breadcrumbs'][] = ['label' => 'Блог', 'url' => ['index']];
$this->params['breadcrumbs'][] = $this->title;
?>
<div class="user-view">
 
    <h1><?= Html::encode($this->title) ?></h1>
 
    ...
 
</div>

<?php
<?php
use yii\helpers\Html;
use yii\widgets\DetailView;
 
/** @var $this \yii\web\View */
/** @var $model \app\models\User */
 
$this->title = $model->meta_title;
...
?>

/** @var \app\models\User $model */

$model = Post::find()->where(['id' => $id])->andWhere(...)->one();
 
echo $model->title;

class ActiveRecord extends BaseActiveRecord
{
    /**
     * @inheritdoc
     * @return ActiveQuery the newly created [[ActiveQuery]] instance.
     */
    public static function find()
    {
        return Yii::createObject(ActiveQuery::className(), [get_called_class()]);
    }

interface ActiveRecordInterface
{
    /**
     * Creates an ActiveQueryInterface instance for query purpose.
     * ...
 
     * @return ActiveQueryInterface the newly created [[ActiveQueryInterface]] instance.
     */
    public static function find();
}

/**
 * @return ActiveQuery
 */

class ActiveQuery extends Query implements ActiveQueryInterface
{
    ...
 
    /**
     * Executes query and returns a single row of result.
     * @param Connection $db the DB connection used to create the DB command.
     * @return ActiveRecord|array|null a single row of query result.
     */
    public function one($db = null)
    {
        ...
    }
}

$model = Post::find()->where(['id' => $id])->one();
 
echo $model->title;

/** @var \app\models\Post $model */
$model = Post::find()->where(['id' => $id])->one();
 
echo $model->title;

$model = Post::find()->where(['id' => $id])->one();
 
/** @var \app\models\Post $model */
echo $model->title;

foreach (Category::find()->orderBy('name')->each() as $category) {
    /** @var \app\models\Category $category */
    echo $category->title;
}

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property string $title
 * @property string $content
 * @property string $image
 */
class Post extends ActiveRecord
{
    ...
 
    public function behaviors()
    {
        return [
            [
                'class' => ImageUploadBehavior::className(),
                'createThumbsOnRequest' => true,
                'attribute' => 'image',
                'filePath' => '@webroot/uploads/posts/[[pk]].[[extension]]',
                'fileUrl' => '@web/uploads/posts/[[pk]].[[extension]]',
                'thumbPath' => '@webroot/uploads/posts/[[profile]]_[[pk]].[[extension]]',
                'thumbUrl' => '@web/uploads/posts/[[profile]]_[[pk]].[[extension]]',
                'thumbs' => [
                    'thumb' => ['width' => 100, 'height' => 100],
                    'preview' => ['width' => 250, 'height' => 180],
                ],
            ],
        ];
    }
}

<?php
<?= Html::img($post->getImageFileUrl('image')) ?>
<?= Html::img($post->getThumbFileUrl('image', 'preview')) ?>

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property string $title
 * @property string $content
 * @property string $image
 *
 * @mixin ImageUploadBehavior
 */
class Post extends ActiveRecord
{
    ...
}

/**
 * @property integer $id
 * @property integer $user_id
 * @property integer $category_id
 * @property string $title
 * @property string $content
 * @property string $image
 *
 * @method getImageFileUrl($attribute, $emptyUrl = null)
 * @method getThumbFileUrl($attribute, $profile = 'thumb', $emptyUrl = null)
 */
class Post extends ActiveRecord
{
    ...
}

$r = new ReflectionClass($class);
$doc = $r->getDocComment();
preg_match_all('#@(.*?)\n#s', $doc, $annotations);
print_r($annotations[1]);

namespace AppBundle\Entity;
 
use Doctrine\ORM\Mapping as ORM;
 
/**
 * @ORM\Entity
 * @ORM\Table(name="product")
 */
class Product
{
    /**
     * @ORM\Column(type="integer")
     * @ORM\Id
     * @ORM\GeneratedValue(strategy="AUTO")
     */
    protected $id;
 
    /**
     * @ORM\Column(type="string", length=100)
     */
    protected $name;
 
    /**
     * @ORM\Column(type="decimal", scale=2)
     */
    protected $price;
 
    /**
     * @ORM\Column(type="text")
     */
    protected $description;
}

class BlogController extends Controller
{
    /**
     * @Route("/blog/{slug}", name="blog_show")
     */
    public function showAction($slug)
    {
        // ...
    }
}

class Product
{
    /**
     * @var string
     * @ORM\Column(type="string", length=100)
     */
    protected $name;
}