Как правильно писать функции с префиксом get?

Question

[Никита Гусаков]

Допустим у нас есть класс, один из его методов — получение содержимого файла, функция приватная, значит сохранить можно только в объект, напрашиваются две реализации — используя return или сразу запись в поле класса. Какой из вариантов лучше и почему?

PS получение содержимого файла — это лишь пример.

Answer 1

[serso]

Не очень понятно, что это за объект. Допустим, наш объект — класс приложения. При открытие дополнительного окна нужно прочитать большой файл, например, таблицу CSV. При этом, понятно, что при старте приложения грузить этот файл не надо (потому как дополнительное окно может и не быть открыто), но в случае когда мы его хотя бы один раз прочитали, читать второй раз уже не хочется. В таком случае можно использовать паттерн lazy loading:

public class Application {

    private CsvData csvData = null;

    public CsvData getCsvData() {
        if ( csvData == null ) {
            csvData = readCsvData();
        }
        return csvData;
    }

    private CsvData readCsvData() {
        // read file from the disk, do not forget about synchronization
        // ...
        return csvData;
    }
}

Comments

[Никита Гусаков]

Имелось ввиду следующее:
Допустим есть функция, разбивающая url на части, мы ее можем написать так:

private function getSections($addr)
{
	$this->sections = explode("/", $addr);
	$num = count($this->sections)-1;
	if($num>0)
	{
		unset($this->sections[0]);
		if($this->sections[$num]=="") unset($this->sections[$num]);
	}
}

или так:

private function getSections($addr)
{
	$sections = explode("/", $addr);
	$num = count($sections)-1;
	if($num>0)
	{
		unset($sections[0]);
		if($sections[$num]=="") unset($sections[$num]);
	}
	return $sections;
}

И то, в конструкторе или еще где-то $this->sections = $this->getSections($addr);
Плюсом второго варианта является нечеткость названия поля в объекте, и соотв этих полей может быть несколько, а плюс первого — строгосость названия поля, сколько бы мы раз не вызвали — будет меняться содержание, но не само поле.
В принципе я наверно для себя уже озвучил за и против каждого из методов, но возможно правильнее тогда первому варианту давать префик set, чтобы не путаться?

[Ivan Kryak]

Если секции разбиваются, то логичнее функцию назвать splitSections, а для получения их уже getSections, где при необходимости и вызвать splitSections

Answer 2

[xanep]

У вас подход к разработке вывернут наизнанку. Цепочка разработки такая: требования->архитектура->реализация. Вы же из реализации пытаетесь выяснить как «правильно». Это принципиально невозможно. Правильно так, как удовлетворяет требованиям. А требований нет. Поэтому сначала нужно определиться с требованиями к интерфейсу класса, а потом уже делать реализацию (ну а приватный методы — это ни что иное как способ реализации интерфейса).

Comments

[Никита Гусаков]

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

[xanep]

Хорошо, что вы поняли. Тогда вы поняли, что ваш вопрос лежит в плоскости архитектуры, а не реализации. Ну и ответьте на простой вопрос из ООП — являются ли секции состоянием сущности Application. Тогда я вам отвечу как нужно реализовывать (хотя вы и сами автоматом будете знать). Ответить же на этот вопрос можно лишь поняв что за приложение вы разрабатываете (уяснив требования).

[xanep]

Хе, я принял код в верхнем комментарии за ваш. Ну в целом, вы поняли что нужно делать.