Соглашения по коду Читать обязательно - AlexMuravya/Intranet GitHub Wiki

Читать обязательно

Discalmer: это реально соглашения (то есть обсуждаемо).

  1. Переменные:

Юзаем верблюда: $userName, $isSet и т.д.

  1. В if'ах:

пишем так:

if ("value" == $a){ //do somethings }

Почему так?

Так сказал мужик из курсов

Так мы избегаем ошибок с переприсваиванием значения в случае описки или плохого понимания =,==,===

Поясню:

мы если мы опишемся так: if($a= "value1"){ //do somethings }

То вместо ожидаемого FALSE, у нас будет:

  • TRUE - это повернет логику ифа на оборот и добавит геммора лично Вам.
  • переприсваивание переменной $a - что уже реально хреново и просто некрасиво по отношению к другим разрабам!

А если мы будем юзать так: if ("value1" = $a){ //do }

То php выдаст ошибку, (ибо это и есть ошибка синтаксиса),

Но:

Если пишем правильно ("value1"==$a), то это сравнение и все будет хорошо.

Обработка ошибок

Показывать ошибки юзерам не хорошо! Но нам знать о них надо.

Что делать?

надо сделать метод (функцию) типа handle_error, которая вызывается функцией и делает: 0) принимает тип ошибки.

  1. Выдает нормальное человекопонятное сообщение, в зависимости от типа.

  2. Сообщает нам об ошибке (либо почта - пока настраивать лень, либо пишет в темп-файл на сайте или вне него).

Пример:

описание функции такое: void MyDummyFunc(array $arr)

Человек, который не прочитал описание - урод. Но это плохо поможет коду, если он таки передаст туда число|строку|объект. Код обязательно завалится на каком-нибудь foreach'е

В начале пишем обработчик входящих парамов:

function MyDummyFunc($someArray){ if(!isArray()){ handle_error($errorType); } }

//Хотя так и хочется написать прогеру все, что мы о нем думаем.

В итоге юзер получит понятную фразу, а мы аля "трейс".