Yii2 framework backup

16 KiB

Raw Blame History Unescape Escape

رعایت اصول و سبک کدنویسی فریمورک Yii2

سبک کدنویسی که در نسخه 2 فریمورک و extension های رسمی استفاده میشه دارای اصول، قواعد و قانون های خودش هست. پس اگر تصمیم دارید چیزی به هسته اضافه کنید باید این قواعد رو در نظر بگیرید حتی در غیر این صورت هم رعایت این موارد خالی از لطف نیست و توصیه میکنم این کارُ انجام بدین. در حالی که میتونید راحت باشید، شما مجبور به رعایت این سبک در application خودتون نیستید...

میتونید برای دریافت پیکره بندی CodeSniffer اینجا رو مطالعه کنید: https://github.com/yiisoft/yii2-coding-standards

1. نگاه کلی

به طور کلی ما از سبک PSR-2 استفاده میکنیم و هر چیزی که در این سبک وجود داره اینجا هم هست. (https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)

در فایل ها باید از برچسب های php?> و =?> استفاده شود.

در پایان هر فایل باید یک خط جدید(newline) داشته باشید.

encoding فایل برای کد های php باید UTF-8 without BOM باشد.

به جای tab از 4 فضای خالی(space) استفاده کنید.

نام کلاس ها باید به صورت StudlyCaps تعریف شوند.

ثابت های داخل کلاس تماما باید با حروف بزرگ و گاهی با جداکننده "_" تعریف شوند.

نام متد ها و پراپرتی ها باید به صورت camelCase تعریف شوند.

پراپرتی های خصوصی(private) باید با "_" شروع شوند.

همیشه از elseif جای else if استفاده کنید.

2. فایل ها

در فایل ها باید از برچسب های php?> و =?> استفاده کرد نه از ?> .

در انتهای فایل های php نباید از تگ

در انتهای هر خط نباید space وجود داشته باشد

پسوند فایل هایی که شامل کد php هستند باید php. باشد.

encoding فایل برای کد های php باید UTF-8 without BOM باشد.

3. نام کلاس ها

نام کلاس ها باید به صورت StudlyCaps تعریف شوند. به عنوان مثال, `Controller`, `Model`.

4. کلاس ها

نام کلاس ها باید به صورت CamelCase تعریف شوند.

آکولاد باز باید در خط بعدی، زیر نام کلاس نوشته شود.

تمام کلاس ها باید بلاک مستندات مطابق استاندارد PHPDoc داشته باشند.

برای تمام کد های داخل کلاس باید با 4 space فاصله ایجاد کنید.

فقط یک کلاس داخل هر فایل php باید موجود باشد.

تمام کلاس ها باید namespaced داشته باشند.

نام کلاس باید معال نام فایل و namespace باید مطابق مسیر آن باشد.

/**
 * Documentation
 */
class MyClass extends \yii\base\BaseObject implements MyInterface
{
    // code
}

4.1. ثابت ها

ثابت های داخل کلاس تماما باید با حروف بزرگ و گاهی با جداکننده "_" تعریف شوند.

<?php
class Foo
{
    const VERSION = '1.0';
    const DATE_APPROVED = '2012-06-01';
}

4.2. پراپرتی ها

از کلید واژه های public، protected و private استفاده کنید.

پراپرتی های public و protected باید در بالای کلاس و قبل از متد ها تعریف شوند. private هم همینطور اما ممکن هست کاهی قبل از متدی که با آن مرتبط هست آورده شود.

ترتیب تعریف پراپرتی ها باید به صورت اول public، دوم protected و سپس private باشد! هیچ قانون سختی برای رعایت این مورد نیست...

برای خوانایی بهتر میتونید از خط خالی بین گروه های public، protected و private استفاده کنید.

متغییر های private باید مثل varName_$ باشند.

اعضای عمومی داخل کلاس باید به صورت camelCase تعریف شوند.(حرف اول کوچک، با CamelCase فرق میکنه).

بهتره از نام هایی مثل i$ و j$ استفاده نکنید.

<?php
class Foo
{
    public $publicProp1;
    public $publicProp2;

    protected $protectedProp;

    private $_privateProp;


    public function someMethod()
    {
        // ...
    }
}

4.3. متد ها

توابع و متد ها باید camelCase باشند.

نام باید هدف رو نشون بده.

از کلید واژه های public، protected و private استفاده کنید.

آکولاد باز باید در خط بعدی یعنی زیر نام متد قرار بگیره.

/**
 * Documentation
 */
class Foo
{
    /**
     * Documentation
     */
    public function bar()
    {
        // code
        return $value;
    }
}

4.4 بلوک های PHPDoc

برای متد ها باید مستندات بنویسید(PHPDoc).

در PHPDoc نوع param@, var@, property@ و return@ باید مشخص شود(bool, int, string, array یا null).

برای تایپ آرایه در PHPDoc از []ClassName استفاده کنید.

خط اول PHPDoc باید هدف یک متد رو شرح بده.

اگر متد ها چیزی رو بررسی میکنن مثل isActive بخش PHPDoc رو باید با عبارت Checks whether شروع کنید.

return@ در PHPDoc یاید دقیقا مشخص کنه چی بازگردانده میشود.

/**
 * Checks whether the IP is in subnet range
 *
 * @param string $ip an IPv4 or IPv6 address
 * @param int $cidr the CIDR lendth
 * @param string $range subnet in CIDR format e.g. `10.0.0.0/8` or `2001:af::/64`
 * @return bool whether the IP is in subnet range
 */
 private function inRange($ip, $cidr, $range)
 {
   // ...
 }

4.5 Constructors

`__construct` باید به جای استایل PHP 4 constructors استفاده شود.

5 PHP

5.1 نوع ها

تمام انواع و مقادیر باید با حروف کوچک نوشته شوند مثل true, false, null و array.

تغییر نوع یک متغییر خیلی بده، به این مثال توجه کنید:

public function save(Transaction $transaction, $argument2 = 100)
{
    $transaction = new Connection; // bad
    $argument2 = 200; // good
}

5.2 رشته ها

اگر رشته ی شما شامل متغییر های دیگه این نیست از تک کوتیشن جای دابل کوتیشن استفاده کنید.

$str = 'Like this.';

دو روش زیر مناسب برای جایگزینی هستند:

$str1 = "Hello $username!";
$str2 = "Hello {$username}!";

حالت زی مجاز نیست:

$str3 = "Hello ${username}!";

الحاق

برای الحاق قبل و بعد کاراکتر dot فاصله بذارید

$name = 'Yii' . ' Framework';

و اگر رشته ی شما بلند بود میتونید اینطور عمل کنید:

$sql = "SELECT *"
    . "FROM `post` "
    . "WHERE `id` = 121 ";

5.3 آرایه ها

برای تعریف آرایه ها از نحوه ی کوتاه اون یعنی [] استفاده کنید.

از ایندکس منفی در آرایه ها استفاده نکنید.

روش های زیر قابل قبول و مناسب هستند:

$arr = [3, 14, 15, 'Yii', 'Framework'];

$arr = [
    3, 14, 15,
    92, 6, $test,
    'Yii', 'Framework',
];

$config = [
    'name' => 'Yii',
    'options' => ['usePHP' => true],
];

5.4 دستورات کنترلی

در دستورات کنترلی قبل و بعد پرانتز space بذارید.

آکولاد باز در همان خط دستور قرار میگیرد.

آکولاد بسته در خط جدید.

برای دستورات یک خطی همیشه از پرانتز استفاده کنید.

if ($event === null) {
    return new Event();
}
if ($event instanceof CoolEvent) {
    return $event->instance();
}
return null;


// the following is NOT allowed:
if (!$model && null === $event)
    throw new Exception('test');

بعد از return از else استفاده نکنید

$result = $this->getResult();
if (empty($result)) {
    return true;
} else {
    // process result
}

اینطوری بهتره

$result = $this->getResult();
if (empty($result)) {
   return true;
}

// process result

switch

از فرمت زیر برای switch استفاده کنید

```php switch ($this->phpType) { case 'string': $a = (string) $value; break; case 'integer': case 'int': $a = (int) $value; break; case 'boolean': $a = (bool) $value; break; default: $a = null; } ```

5.5 function calls

روش مناسب صدا زدن توابع همراه با پارامتر ها هم اینطور صحیحه

doIt(2, 3);

doIt(['a' => 'b']);

doIt('a', [
    'a' => 'b',
    'c' => 'd',
]);

5.6 تعریف Anonymous functions (lambda)

در توابع بی نام بین function/use فضای خالی(space) بذارید.

// good
$n = 100;
$sum = array_reduce($numbers, function ($r, $x) use ($n) {
    $this->doMagic();
    $r += $x * $n;
    return $r;
});

// bad
$n = 100;
$mul = array_reduce($numbers, function($r, $x) use($n) {
    $this->doMagic();
    $r *= $x * $n;
    return $r;
});

مستند نویسی

[phpDoc](http://phpdoc.org/) رو بخونید و موارد اونُ رعایت کنید.

کد بدون مستندات مجاز نیست.

تمام کلاس ها باید شامل بلاک مستندات در ابتدای فایل باشند.

نیازی به نوشتن return@ ندارید اگر متد شما اگر چیزی را برنمیگرداند.

به مثال های زیر توجه کنید:

  <?php
  /**
   * Returns the errors for all attribute or a single attribute.
   * @param string $attribute attribute name. Use null to retrieve errors for all attributes.
   * @property array An array of errors for all attributes. Empty array is returned if no error.
   * The result is a two-dimensional array. See [[getErrors()]] for detailed description.
   * @return array errors for all attributes or the specified attribute. Empty array is returned if no error.
   * Note that when returning errors for all attributes, the result is a two-dimensional array, like the following:
   * ...
   */
  public function getErrors($attribute = null)

فایل

<?php
/**
 * @link http://www.yiiframework.com/
 * @copyright Copyright (c) 2008 Yii Software LLC
 * @license http://www.yiiframework.com/license/
 */

کلاس

/**
 * Component is the base class that provides the *property*, *event* and *behavior* features.
 *
 * @include @yii/docs/base-Component.md
 *
 * @author Qiang Xue <qiang.xue@gmail.com>
 * @since 2.0
 */
class Component extends \yii\base\BaseObject

توابع / متد

/**
 * Returns the list of attached event handlers for an event.
 * You may manipulate the returned [[Vector]] object by adding or removing handlers.
 * For example,
 *
 * ```
 * $component->getEventHandlers($eventName)->insertAt(0, $eventHandler);
 * ```
 *
 * @param string $name the event name
 * @return Vector list of attached event handlers for the event
 * @throws Exception if the event is not defined
 */
public function getEventHandlers($name)
{
    if (!isset($this->_e[$name])) {
        $this->_e[$name] = new Vector;
    }
    $this->ensureBehaviors();
    return $this->_e[$name];
}

نظرات

از // برای کامنت گذاری استفاده کنید نه از #.

در خطوطی که کامنت گذاشتین نباید کد بنویسید، یعنی اون خط برای اون کامنت باید باشه.

قوانین بیشتر

تا جایی که میتونید از تابع empty به جای === استفاده کنید.

اگر شرایط تو در تویی در کد شما وجود نداره return زود هنگام یا ساده تر بگم return وسط متد مشکلی نخواهد داشت.

همیشه از static جای self به جز موارد زیر استفاده کنید:

1) دسترسی به ثابت ها باید با self انجام بشه.

2) دسترسی به پراپرتی های خصوصی باید با self انجام بشه.

3) مجاز به استفاده از self برای صدا زدن توابع در مواقعی مثل فراخوانی بازگشتی هستید.

namespace ها

از حرف کوچک استفاده کنید.

از فرم جمع اسم ها برای نشان دادن یک شی استفاده کنید مثل validators.

از فرم منفرد اسم ها برای قابلیت ها و امکانات استفاده کنید مثل web.

بهتره فضای نام تک کلمه ای باشه در غیر این صورت از camelCase استفاده کنید.

16 KiB Raw Blame History Unescape Escape