Каковы преимущества и преимущества классов сущностей? - PullRequest
0 голосов
/ 25 мая 2018

Я часто сталкиваюсь с кодом, подобным следующему (ссылка Slim tutorial на github ).

TicketMapper.php

class TicketMapper extends Mapper
{
    public function getTickets() {
        $sql = "SELECT t.id, t.title, t.description, c.component
            from tickets t
            join components c on (c.id = t.component_id)";
        $stmt = $this->db->query($sql);
        $results = [];
        while($row = $stmt->fetch()) {
            $results[] = new TicketEntity($row);
        }
        return $results;
    }
    /**
     * Get one ticket by its ID
     *
     * @param int $ticket_id The ID of the ticket
     * @return TicketEntity  The ticket
     */
    public function getTicketById($ticket_id) {
        $sql = "SELECT t.id, t.title, t.description, c.component
            from tickets t
            join components c on (c.id = t.component_id)
            where t.id = :ticket_id";
        $stmt = $this->db->prepare($sql);
        $result = $stmt->execute(["ticket_id" => $ticket_id]);
        if($result) {
            return new TicketEntity($stmt->fetch());
        }
    }
    public function save(TicketEntity $ticket) {
        $sql = "insert into tickets
            (title, description, component_id) values
            (:title, :description, 
            (select id from components where component = :component))";
        $stmt = $this->db->prepare($sql);
        $result = $stmt->execute([
            "title" => $ticket->getTitle(),
            "description" => $ticket->getDescription(),
            "component" => $ticket->getComponent(),
        ]);
        if(!$result) {
            throw new Exception("could not save record");
        }
    }
}

TicketEntity.php

class TicketEntity
{
    protected $id;
    protected $title;
    protected $description;
    protected $component;
    /**
     * Accept an array of data matching properties of this class
     * and create the class
     *
     * @param array $data The data to use to create
     */
    public function __construct(array $data) {
        // no id if we're creating
        if(isset($data['id'])) {
            $this->id = $data['id'];
        }
        $this->title = $data['title'];
        $this->description = $data['description'];
        $this->component = $data['component'];
    }
    public function getId() {
        return $this->id;
    }
    public function getTitle() {
        return $this->title;
    }
    public function getDescription() {
        return $this->description;
    }
    public function getShortDescription() {
        return substr($this->description, 0, 20);
    }
    public function getComponent() {
        return $this->component;
    }
}

Моя текущая практика не использует классы сущностей, и мои методы отображения просто возвращают класс stdClass, как показано ниже:

class TicketMapper extends Mapper
{
    public function getTickets() {
        $sql = "...";
        $stmt = $this->db->query($sql);
        return $stmt->fetchAll(PDO::FETCH_OBJ);
    }
    public function getTicketById($ticket_id) {
        $sql = "...";
        $stmt = $this->db->prepare($sql);
        $result = $stmt->execute(["ticket_id" => $ticket_id]);
        return $stmt->fetch();  //Assuming my PDO is configured to return an object only
    }
    public function save($ticket) {/* no change */}
}

Почему результаты базы данных часто заключаются вкакой-то класс сущности?Есть ли критерии, по которым можно было бы определить, стоит ли это делать?

Ответы [ 2 ]

0 голосов
/ 25 мая 2018

Смысл преобразователя данных заключается в том, чтобы действовать в качестве постоянного уровня между вашей бизнес-логикой и хранилищем.Он заполняет или хранит данные в объектах сущности.

И эти объекты имеют несколько целей:

  • инкапсуляция: у вас есть возможность отслеживать и контролировать доступ и изменение данных, содержащихся в этих объектах,

  • проверка: обеспечение того, чтобы состояние объекта соответствовало бизнес-правилам, и способность обнаруживать, вошел ли объект (или собирается войти) в недопустимое состояние

  • контракты: вы можете использовать typehints, чтобы определить, какие другие модули (классы, функции) могут использовать эту сущность и какие типы вещей она может принимать в качестве параметров.Вы также получаете возможность определить, какой интерфейс заменитель этой сущности должен реализовывать

  • поведение: сущность часто будет иметь ассоциированное поведение (или бизнес-логику), например: $article->markAsApproved() операция не будет тривиальным установщиком, а вместо этого сделает атомарное изменение состояния.

Что касается критериев ... ну ... "используете ли вы ООП или нет" будет самым близким.stdClass - это просто прославленный массив без поведения.

Вам, наверное, стоит посмотреть эту лекцию .

0 голосов
/ 25 мая 2018

Инкапсуляция: класс - это полезный пакет, содержащий код и соответствующие данные вместе, изолированный от всего остального.Это облегчает его перемещение без поиска точных переменных, без коллизий с существующим кодом / данными.

Конечно, у классов есть и другое применение, но в средах сценариев, таких как PHP, я думаю, что самое большое преимущество - это.

Повторное использование кода

Наследование

Простота обслуживания

и т. Д.Проведите небольшое исследование, чтобы узнать, чему научиться

...