Геттер і сетер?

Я не розробник PHP, тому мені цікаво, чи в PHP популярніше використовувати явні геттери / сетери, в чистому стилі OOP, з приватними полями (як мені подобається):

class MyClass {
    private $firstField;
    private $secondField;

    public function getFirstField() {
        return $this->firstField;
    }
    public function setFirstField($x) {
        $this->firstField = $x;
    }
    public function getSecondField() {
        return $this->secondField;
    }
    public function setSecondField($x) {
        $this->secondField = $x;
    }
}

або просто загальнодоступні поля:

class MyClass {
    public $firstField;
    public $secondField;
}

Дякую

Ви можете використовувати магічні методи php __get та __set.

<?php
class MyClass {
  private $firstField;
  private $secondField;

  public function __get($property) {
    if (property_exists($this, $property)) {
      return $this->$property;
    }
  }

  public function __set($property, $value) {
    if (property_exists($this, $property)) {
      $this->$property = $value;
    }

    return $this;
  }
}
?>

Навіщо використовувати геттери та сетери?

1. Масштабованість : простіше отримати рефактор, ніж шукати всі завдання в коді проекту.
2. Налагодження : Ви можете ставити точки перерви у встановниках та на геттерах.
3. Очисник : Магічні функції не є гарним рішенням для того, щоб писати менше, ваш IDE не запропонує код. Краще використовувати шаблони для швидкозаписуючих.

Google вже опублікував посібник з оптимізації PHP, і висновок:

Ніяких геттерів та налаштувань Оптимізація PHP

І ні, ви не повинні використовувати магічні методи . Для PHP Магічний метод - це зло. Чому?

1. Їх важко налагодити.
2. Відбувається негативний вплив на продуктивність.
3. Вони вимагають написати більше коду.

PHP - це не Java, C ++ або C #. PHP відрізняється і грає з різними ролями.

Інкапсуляція важлива для будь-якої мови ОО, популярність тут нічого спільного. У динамічно набраних мовах, як PHP, це особливо корисно, оскільки існує мало способів забезпечити властивість конкретного типу без використання сетерів.

У PHP це працює:

class Foo {
   public $bar; // should be an integer
}
$foo = new Foo;
$foo->bar = "string";

У Java це:

class Foo {
   public int bar;
}
Foo myFoo = new Foo();
myFoo.bar = "string"; // error

Використання магічних методів ( __getі __set) також працює, але лише при доступі до ресурсу, який має меншу видимість, ніж поточний діапазон, може отримати доступ. Він може легко доставити вам головні болі при спробі налагодження, якщо він не використовується належним чином.

Якщо ви хочете використовувати функцію __call, ви можете використовувати цей метод. Це працює з

• GET => $this->property()
• SET => $this->property($value)
• GET => $this->getProperty()
• SET => $this->setProperty($value)

калсдас

public function __call($name, $arguments) {

    //Getting and setting with $this->property($optional);

    if (property_exists(get_class($this), $name)) {


        //Always set the value if a parameter is passed
        if (count($arguments) == 1) {
            /* set */
            $this->$name = $arguments[0];
        } else if (count($arguments) > 1) {
            throw new \Exception("Setter for $name only accepts one parameter.");
        }

        //Always return the value (Even on the set)
        return $this->$name;
    }

    //If it doesn't chech if its a normal old type setter ot getter
    //Getting and setting with $this->getProperty($optional);
    //Getting and setting with $this->setProperty($optional);
    $prefix = substr($name, 0, 3);
    $property = strtolower($name[3]) . substr($name, 4);
    switch ($prefix) {
        case 'get':
            return $this->$property;
            break;
        case 'set':
            //Always set the value if a parameter is passed
            if (count($arguments) != 1) {
                throw new \Exception("Setter for $name requires exactly one parameter.");
            }
            $this->$property = $arguments[0];
            //Always return the value (Even on the set)
            return $this->$name;
        default:
            throw new \Exception("Property $name doesn't exist.");
            break;
    }
}

На додаток до вже чудових і шанованих відповідей тут, я хотів би поширитись на PHP, не маючи сеттерів / гетерів.

У PHP немає синтаксису getter та setter . Він надає підкласові або магічні методи, що дозволяють "підключити" і перекрити процес пошуку властивостей, на що вказував Дейв .

Магія дозволяє нам лінивим програмістам робити більше з меншим кодом за той час, коли ми активно займаємось проектом і знаємо його інтимно, але зазвичай за рахунок читабельності.

Продуктивність Кожна непотрібна функція, що виникає внаслідок примусового кодування архітектури коду в Getter / Setter в PHP, включає власний стек-кадр пам'яті після виклику і витрачає цикли процесора.

Читання: У базі коду виникають здуті рядки коду, що впливає на кодову навігацію, оскільки більше LOC означає більше прокрутки.

Перевага: Особисто я, як правило, сприймаю невдачу аналізу статичного коду як знак, щоб уникнути магічної дороги до тих пір, поки очевидні довготермінові переваги ухиляються від мене на той час.

Несправедливості:

Поширений аргумент - читабельність. Наприклад, $someobject->widthце легше читати, ніж $someobject->width(). Однак на відміну від планети circumferenceабо width, як можна вважати static, екземпляр об'єкта, такий як $someobject, який вимагає функції ширини, ймовірно, проводить вимірювання ширини екземпляра об'єкта.
Тому читабельність збільшується, головним чином, через асертивні схеми іменування, а не через приховування функції, яка виводить задане значення властивості.

__get / __set використовує:

• попередня перевірка та попередня санація цінностей майна

• струни, наприклад

  "
  some {mathsobj1->generatelatex} multi
  line text {mathsobj1->latexoutput}
  with lots of variables for {mathsobj1->generatelatex}
   some reason
  "

  У цьому випадку generatelatexбуде дотримуватися схема імен імені action name + namename

• особливі, очевидні випадки

  $dnastringobj->homeobox($one_rememberable_parameter)->gattaca->findrelated()
  $dnastringobj->homeobox($one_rememberable_parameter)->gttccaatttga->findrelated()

Примітка: PHP вирішив не застосовувати синтаксис getter / setter. Я не стверджую, що геттери / сетери в цілому погані.

class MyClass {
    private $firstField;
    private $secondField;
    private $thirdField;

    public function __get( $name ) {
        if( method_exists( $this , $method = ( 'get' . ucfirst( $name  ) ) ) )
            return $this->$method();
        else
            throw new Exception( 'Can\'t get property ' . $name );
    }

    public function __set( $name , $value ) {
        if( method_exists( $this , $method = ( 'set' . ucfirst( $name  ) ) ) )
            return $this->$method( $value );
        else
            throw new Exception( 'Can\'t set property ' . $name );
    }

    public function __isset( $name )
    {
        return method_exists( $this , 'get' . ucfirst( $name  ) ) 
            || method_exists( $this , 'set' . ucfirst( $name  ) );
    }

    public function getFirstField() {
        return $this->firstField;
    }

    protected function setFirstField($x) {
        $this->firstField = $x;
    }

    private function getSecondField() {
        return $this->secondField;
    }
}

$obj = new MyClass();

echo $obj->firstField; // works
$obj->firstField = 'value'; // works

echo $obj->getFirstField(); // works
$obj->setFirstField( 'value' ); // not works, method is protected

echo $obj->secondField; // works
echo $obj->getSecondField(); // not works, method is private

$obj->secondField = 'value'; // not works, setter not exists

echo $obj->thirdField; // not works, property not exists

isset( $obj->firstField ); // returns true
isset( $obj->secondField ); // returns true
isset( $obj->thirdField ); // returns false

Готово!

Ну, PHP має магічні методи __get, __set, __issetі __unset, завжди початок. На жаль, властивості OO - це більше, ніж магічні методи. Основна проблема реалізації PHP полягає в тому, що магічні методи викликаються для всіх недоступних властивостей. Що означає, що вам доведеться повторити себе (наприклад, зателефонувавши у властивості магічних методів property_exists ()), коли визначаєте, чи власне ім'я є власністю вашого об'єкта. І ви не можете реально вирішити цю загальну проблему з базовим класом, якщо всі ваші класи не успадковують, тобто. ClassWithProperties, оскільки PHP не вистачає багаторазового успадкування.

На відміну від нових класів стилів Python дає вам property(), що дозволяє чітко визначити всі свої властивості. C # має спеціальний синтаксис.

http://en.wikipedia.org/wiki/Property_(programming)

Я зробив експеримент, використовуючи магічний метод __call. Не впевнений, чи варто публікувати це (через всі попередження "НЕ ВИКОРИСТОВУЮТЬ МАГІЧНІ МЕТОДИ" в інших відповідях та коментарях), але я залишу це тут. На всякий випадок, якщо хтось вважає це корисним.

public function __call($_name, $_arguments){
    $action  = substr($_name, 0, 4);
    $varName = substr($_name, 4);

    if (isset($this->{$varName})){
        if ($action === "get_") return $this->{$varName};
        if ($action === "set_") $this->{$varName} = $_arguments[0];
    }
}

Просто додайте цей метод вище у своєму класі, тепер ви можете набрати:

class MyClass{
    private foo = "bar";
    private bom = "bim";
    // ...
    // public function __call(){ ... }
    // ...
}
$C = new MyClass();

// as getter
$C->get_foo(); // return "bar"
$C->get_bom(); // return "bim"

// as setter
$C->set_foo("abc"); // set "abc" as new value of foo
$C->set_bom("zam"); // set "zam" as new value of bom

Таким чином ви можете отримати / встановити все у своєму класі, якщо воно існує, якщо вам це потрібно лише для кількох конкретних елементів, ви можете використовувати «білий список» як фільтр.

Приклад:

private $callWhiteList = array(
    "foo" => "foo",
    "fee" => "fee",
    // ...
);

public function __call($_name, $_arguments){
    $action  = substr($_name, 0, 4);
    $varName = $this->callWhiteList[substr($_name, 4)];

    if (!is_null($varName) && isset($this->{$varName})){
        if ($action === "get_") return $this->{$varName};
        if ($action === "set_") $this->{$varName} = $_arguments[0];
    }
}

Тепер ви можете лише отримати / встановити "foo" та "honorar".
Ви також можете використовувати цей "білий список", щоб призначити власні імена для доступу до ваших змін.
Наприклад,

private $callWhiteList = array(
    "myfoo" => "foo",
    "zim" => "bom",
    // ...
);

За допомогою цього списку тепер можна вводити:

class MyClass{
    private foo = "bar";
    private bom = "bim";
    // ...
    // private $callWhiteList = array( ... )
    // public function __call(){ ... }
    // ...
}
$C = new MyClass();

// as getter
$C->get_myfoo(); // return "bar"
$C->get_zim(); // return "bim"

// as setter
$C->set_myfoo("abc"); // set "abc" as new value of foo
$C->set_zim("zam"); // set "zam" as new value of bom

.
.
.
Це все.

Doc: __call () спрацьовує, коли викликає недоступні методи в контексті об'єкта.

Прочитавши інші поради, я схильний сказати, що:

Як правило GENERIC , ви не завжди визначаєте сетерів для ВСІХ властивостей, особливо "внутрішніх" (семафорів, внутрішніх прапорів ...). Очевидно, що властивості лише для читання не матимуть сеттерів, тому деякі властивості матимуть лише getters; ось де __get () приходить, щоб зменшити код:

• визначити __get () (магічні глобальні гетери) для всіх тих властивостей, які однакові,
• згрупуйте їх у масиви так:
  • вони поділять загальні характеристики: грошові величини будуть / можуть виходити належним чином відформатованими, датами у визначеному макеті (ISO, US, Intl.) тощо.
  • сам код може перевірити, чи читаються лише існуючі та дозволені властивості за допомогою цього магічного методу.
  • всякий раз, коли вам потрібно створити нову подібну властивість, просто оголосіть її та додайте її ім'я у відповідний масив, і це зроблено. Таким чином швидше, ніж визначення нового геттера, можливо, з деякими рядками коду повторюються знову і знову по всьому коду класу.

Так! ми також можемо написати приватний метод для цього, але знову ж таки, у нас буде МНОГО оголошених методів (++ пам'яті), які в кінцевому підсумку викликають інший, завжди той самий, метод. Чому просто не написати єдиний метод, щоб керувати ними всіма ...? [так! каламбур абсолютно призначений! :)]

Магічні налаштування також можуть реагувати ТІЛЬКИ на конкретні властивості, тому всі властивості типу дати можуть бути перевірені проти недійсних значень лише одним методом. Якщо властивості типу дати були перелічені в масиві, їх сеттер можна легко визначити. Просто приклад, звичайно. буває занадто багато ситуацій.

Про читабельність ... Ну ... Це ще одна дискусія: мені не подобається прив'язуватися до використання IDE (насправді я не використовую їх, вони, як правило, говорять мені (і змушують мене), як це зробити пишіть ... і у мене є свої симпатії щодо кодування "краси"). Я схильний бути послідовним щодо імен, тому використання ctags та декількох інших посібників мені достатньо ... У будь-якому разі: як тільки всі ці магічні сеттери та геттери будуть виконані, я записую інші сетери, які є надто специфічними або "особливими" для бути узагальненим методом __set (). І це стосується всього, що мені потрібно про отримання та налаштування властивостей. Зрозуміло: не завжди існує спільної точки зору, або є така кількість властивостей, що не вартує клопотів із кодуванням магічного методу, і тоді ще є стара хороша традиційна пара сеттера та геттера.

Мови програмування - це лише такі: штучні мови людини. Отже, у кожного з них є своя інтонація чи акцент, синтаксис та аромат, тому я не буду робити вигляд, щоб написати код Ruby чи Python, використовуючи той самий "акцент", що і Java або C #, і не писав би JavaScript чи PHP, щоб вони нагадували Perl або SQL ... Використовуйте їх так, як вони призначені для використання.

Взагалі кажучи, перший спосіб є більш популярним загалом, оскільки ті, хто має попередні знання з програмування, можуть легко перейти до PHP та зробити роботу об'єктно-орієнтованою. Перший спосіб більш універсальний. Моя порада полягає в тому, щоб дотримуватися того, що випробувано і правдиво для багатьох мов. Тоді, коли і якщо ви використовуєте іншу мову, ви будете готові щось досягти ( замість того, щоб витрачати час на винахід колеса ).

Існує багато способів створення вихідного коду в netbeans-convention. Це добре. Це змушує думати, що таке полегшення === ЛЖА. Просто використовуйте традиціонель, особливо якщо ви не впевнені, яка з властивостей повинна бути інкапсульована, а яка - ні. Я знаю, це boi .... pla ... код, але для налагодження працює і багато інших думає, що це кращий, зрозумілий шлях. Не витрачайте багато часу з тисячами мистецтв, як зробити прості геттери та сетери. Ви не можете реалізувати занадто деякі шаблони дизайну, як правило деметера тощо, якщо ви використовуєте магію. У конкретній ситуації ви можете використовувати magic_calls або для невеликих, швидких та зрозумілих рішень. Впевнені, що і ти можеш приймати рішення для дизайнерів-дизайнерів таким чином, але навіщо зробити життя важче.

Перевірка + Форматування / Виведення значень

Інструменти дозволяють перевіряти дані, а користувачі можуть форматувати або отримувати дані. Об'єкти дозволяють інкапсулювати дані та їх валідацію та форматування коду в акуратний пакет, який заохочує DRY.

Наприклад, розглянемо наступний простий клас, який містить дату народження.

class BirthDate {

    private $birth_date;

    public function getBirthDate($format='Y-m-d') {
        //format $birth_date ...
        //$birth_date = ...
        return $birth_date;
    }

    public function setBirthDate($birth_date) {                   
        //if($birth_date is not valid) throw an exception ...          
        $this->birth_date = $birth_date;
    }

    public function getAge() {
        //calculate age ...
        return $age;
    }

    public function getDaysUntilBirthday() {
        //calculate days until birth days
        return $days;
    }
}

Ви хочете перевірити встановлене значення

• Дійсна дата
• Не в майбутньому

І ви не хочете робити цю перевірку у всій програмі (або в кількох додатках з цього приводу). Натомість простіше зробити змінну члена захищеною або приватною (щоб зробити сеттер єдиною точкою доступу) та перевірити її в програмі, оскільки тоді ви знаєте, що об'єкт містить дійсну дату народження незалежно від того, яка частина застосувати об'єкт, з якого походить об'єкт, і якщо ви хочете додати більше перевірки, ви можете додати його в одному місці.

Ви можете додати кілька форматування , які працюють на одній і той же змінному членом , тобто getAge()і , getDaysUntilBirthday()і ви можете застосовувати настроюється формат в getBirthDate()залежності від регіону. Тому я віддаю перевагу послідовному доступу до значень через getters, а не змішуванню $date->getAge()з $date->birth_date.

Геттери і сетери також корисні при розширенні об'єктів. Наприклад, припустимо, що вашій заяві потрібно було дозволити дати народження 150+ років у деяких місцях, а не в інших. Одним із способів вирішити проблему без повторення будь-якого коду було б розширення BirthDateоб'єкта та додавання додаткової перевірки в сеттер.

class LivingBirthDate extends BirthDate {

    public function setBirthDate($birth_date) {
        //if $birth_date is greater than 150 years throw an exception
        //else pass to parent's setter
        return parent::setBirthDate($birth_date);
    }
}

Це повідомлення не конкретно про __getі __setа __callщо та ж ідея методу виклику , за винятком. Як правило, я тримаюсь подалі від будь-яких магічних методів, які дозволяють перевантажуватись з причин, викладених у коментарях та дописах ТАКОЖ , я нещодавно наткнувся на сторонній API, який я використовую, який використовує SERVICE та SUB-SERVICE, наприклад :

http://3rdparty.api.com?service=APIService.doActionOne&apikey=12341234

Важливою частиною цього є те, що в цьому API є все те саме, крім суб-дії doActionOne. Ідея полягає в тому, що розробник (я та інші користувачі цього класу) могли викликати під-службу по імені на відміну від чогось типу:

$myClass->doAction(array('service'=>'doActionOne','args'=>$args));

Я міг би зробити це:

 $myClass->doActionOne($args);

Для жорсткого коду це було б дуже багато дублювання (цей приклад дуже вільно нагадує код):

public function doActionOne($array)
    {
        $this->args     =   $array;
        $name           =   __FUNCTION__;
        $this->response =   $this->executeCoreCall("APIService.{$name}");
    }

public function doActionTwo($array)
    {
        $this->args     =   $array;
        $name           =   __FUNCTION__;
        $this->response =   $this->executeCoreCall("APIService.{$name}");
    }

public function doActionThree($array)
    {
        $this->args     =   $array;
        $name           =   __FUNCTION__;
        $this->response =   $this->executeCoreCall("APIService.{$name}");
    }

protected function executeCoreCall($service)
    {
        $cURL = new \cURL();
        return $cURL->('http://3rdparty.api.com?service='.$service.'&apikey='.$this->api.'&'.http_build_query($this->args))
                    ->getResponse();
    }

Але за допомогою магічного методу __call()я можу отримати доступ до всіх служб динамічними методами:

public function __call($name, $arguments)
    {
        $this->args     =   $arguments;
        $this->response =   $this->executeCoreCall("APIService.{$name}");   
        return $this;
    }

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

Редагувати:

Випадково я побачив це через кілька днів після публікації, що окреслює саме мій сценарій. Це не API, про який я мав на увазі, але застосування методів ідентичне:

Чи правильно я використовую api?

Оновлення: Не використовуйте цю відповідь, оскільки це дуже німий код, який я знайшов, коли я вчуся. Просто використовуйте звичайний геттер і сетер, це набагато краще.

Зазвичай я використовую це ім'я змінної як ім'я функції, і додаю необов'язковий параметр до цієї функції, тож коли цей необов'язковий параметр заповнюється викликом, потім встановлюю його у властивість та повертаю $ цей об’єкт (ланцюжок), а потім, коли цей необов'язковий параметр не визначається абонент, я просто повертаю майно абоненту.

Мій приклад:

class Model
{
     private $propOne;
     private $propTwo;

     public function propOne($propVal = '')
     {
          if ($propVal === '') {
              return $this->propOne;
          } else {
              $this->propOne = $propVal;
              return $this;
          }
     }

     public function propTwo($propVal = '')
     {
          if ($propVal === '') {
              return $this->propTwo;
          } else {
              $this->propTwo = $propVal;
              return $this;
          }
     }
}