Версия для печати темы
Нажмите сюда для просмотра этой темы в оригинальном формате
Форум программистов > PHP: Общие вопросы > Как правильно писать фанкции?


Автор: diktator 27.5.2010, 05:44
Здравствуйте, подскажите как правильно писать функции. А именно интересуют 2 вопроса по return.

1 вопрос - что лучше выводить если функция не смогла получить нужный результат, имею ввиду с точки зрения правильности.

Код

function getContent($url)
{

// если урл не существует
$contents=file_get_contents($url); 
return $contents;
}

getContent();



2 вопрос стоит ли так делать вывод, тоже с точки зрения правильности.

Код

function getId($i)
{

while($i<10) {

if($i==6) {
return $contents;
}

$i++;

}

}

getId(3);

Автор: ksnk 27.5.2010, 08:45
функции - это кирпичи из которых строится программа. Кирпичи бывают разные - огнеупорные, облицовочные, теплоизоляцтонные... в каждом конкретном случае, поведение и структура кирпича соответствует решаемой строителем задаче...

Можно возвращать пустую строку, можно вызывать null, можно вызываать исключение, можно ничего не делать и тогда сам php скажет, что случилась ошибка и файл ненайден. Зависит от используемой в приложении логики работы...

Автор: diktator 27.5.2010, 15:33
ksnk, я имею ввиду как будет правильнее с точки зрения оформления кода чтобы дальше проблемы не возникли, к примеру если до конца не известно что будет нужно. 

Автор: Novich 27.5.2010, 19:56
Каждый программист сам решает как все это оформлять, исходя из текущей задачи. 

Например, если ваша функция возвращает только положительные числовые значения, то в качестве кодов ошибок можно выбрать цифры с минусом. Функция вернула -1, значит произошла такая-то ошибка, вернула -2 - значит другая. Если функция возвращает текстовое значение, значит можно возвращать null, если произошла ошибка. А можно вообще возвращать массив, одно из значений которого будет код статуса - $result['status'], а другое - сам результат $result['result'].

Чтобы не забыть над функцией пишите комментарий, что делает функция, что должно передаваться в параметрах, в каких форматах, какие ограничения, в каком формате возвращается значение, какие могут быть ошибки, как проверять результат на наличие ошибок. Посмотрите примеры как пишут функции профи.

Автор: IgorIV 27.5.2010, 20:28
А я поодержу ТС в вопросе smile
Разовьем пример.
Вариант первый 
Код

function getContent($url)
{
     $contents=file_get_contents($url); 
     return $contents;
}
$file = '/tmp/text';
if (file_exists($file))
{
    echo getContent($temp);
} 


Вариант второй

Код

function getContent($url)
{
    if (file_exists($file))
    { 
        $contents=file_get_contents($url); 
        return $contents;  
    } 
}
$file = '/tmp/text';

echo getContent($file);


Какой вариант вы бы выбрали сами?

Автор: ksnk 27.5.2010, 21:45
Вот такой вариант - однозначно лучше...
Код

file_get_content($fn);

Мне совершенно непонятно, ради какой красоты понадобится может оборачивать стандартную функцию в отдельную обертку. Но если хочется, можно вот так
Код

function getContent($fn){
  return file_get_content($fn);
}


сли почитать инструкцию, то окажется, что если файл не найден, функция выдаст FALSE и такая проверка даст нам заодно и проверку на существование(читабельность) файла.
Код

$res=getContent('myfile.txt');
if($res!==FALSE){
   // $res - содержимое файла...
}

Автор: MoLeX 28.5.2010, 05:47
diktator, IgorIV

да без разницы. но для того что бы сторонний программист знал что вернет ему ваша чудо функция, надо писать комментарии.
Код

/**
 * Моя супер функция для таких то действий
 * @param integer $value значение
 * @return boolean
 */ 
function MySuperFunction( $value )
{
   return ($value > 10)?TRUE:FALSE;
}

Автор: IgorIV 28.5.2010, 18:57
ksnk, просто неудачный пример smile Развил, так сказать, идею, а оно ишь как оказалось smile

Powered by Invision Power Board (http://www.invisionboard.com)
© Invision Power Services (http://www.invisionpower.com)