ScopeyNZ
commented
5 years ago This is a pretty worn out drum that I'm banging here, but it's completely dependant on context. I really don't think you can have "default" visibility. If it's an implementation detail of the class/object then it's private. If it's API that conforms with the intention of the class, then consider the idea that someone might wish to extend the class to update compatibility or something, and make it protected. If it's just the API of the class, then it's public.
Example:
class Lottery
{
protected $numberOfNumbers;
public function __construct($numberOfNumbers)
{
$this->numberOfNumbers = $numberOfNumbers;
}
public function drawNumbers()
{
return $this->generateNumberList();
}
protected function generateNumber()
{
return random_int(0, 45);
}
private function generateNumberList()
{
$numbers = [];
for ($i = 0; $i < $this->numberOfNumbers; $i++) {
do {
$number = $this->generateNumber();
} while (!in_array($number, $numbers));
$numbers[] = $number;
}
return $numbers;
}
}My most complex logic which is an implementation detail is kept in a private method. I could change that at any time to return a generator instead of an array - for example.
dnsl48
sminnee
chillu
robbieaverill
Affected Version
All
Description
Lately there have been some discussions in pull requests around whether we prefer private or protected methods (when not public).
Key questions:
Acceptance criteria:
cc @silverstripe/core-team @silverstripe/open-sourcerers @silverstripe/creative-commoners
Outcomes
Protected scope IS public API
Protected methods and properties MUST NOT receive incompatible changes in minor and patch releases.
Pros
Cons
PRs