Как в php отделить объявление класса от его реализации?

Question

[germn]

Заранее извиняюсь, если вопрос глупый, Гуглил долго, но так и не нашел ответа.


Допустим, есть класс DataKeeper:

class DataKeeper {
  private $data;

  public function setData($data) {
    // реализация
  }
  public function getData() {
    // реализация
  }
  public function saveData() {
    // реализация
  }
  private function processData() {
    // реализация
  }
}

Тому, кто будет использовать класс нет необходимости знать, как именно работают функции. Ему достаточно знать только о наличии открытых функций, с которыми он может работать.


Раскрытие деталей реализации класса я хочу вынести в отдельный файл, а в «основном» иметь что-то типа:

class DataKeeper {
  public function getData()
  public function setData($data)
  public function saveData()
}

Как это сделать?

Upd:


Спасибо за ответы про интерфейсы. Наверное, я туплю, но мне кажется, это не решение проблемы.


Живой пример:


Вот, допустим, есть у меня файл DataKeeper.php. В нем объявлен интерфейс DataKeeper.

Его реализует класс FileDataKeeper (сохраняет данные в файл), находящийся в своём файле.

class FileDataKeeper implements DataKeeper


Получается, что в проекте, мне все равно надо будет писать:

$dk = new FileDataKeeper;


В файле DataKeeper.php (а только его, по идее, мы должны смотреть) нет ни слова о FileDataKeeper.


Кроме того, если я захочу поменять реализацию хранения, заменив класс FileDataKeeper, например, на MySQLDataKeeper, интерфейс и открытые методы-то не изменятся, а вот «new FileDataKeeper» надо будет менять по всему проекту.

Answer 1

[Skpd]

Интерфейсы.

class DataKeeper implements IDataKeeper {
  private $data;

  public function setData($data) {
    // реализация
  }
  public function getData() {
    // реализация
  }
  public function saveData() {
    // реализация
  }
  private function processData() {
    // реализация
  }
}

interface IDataKeeper {
    public function getData();
    public function setData($data);
    public function saveData();
}

Comments

[germn]

Спасибо за ответ, уточнил свой вопрос.

Answer 2

[evilbloodydemon]

Кроме того, если я захочу поменять реализацию хранения, заменив класс FileDataKeeper, например, на MySQLDataKeeper, интерфейс и открытые методы-то не изменятся, а вот «new FileDataKeeper» надо будет менять по всему проекту.

en.wikipedia.org/wiki/Dependency_injection

Answer 3

[deadkrolik]

Интерфейсы?

Comments

[germn]

Спасибо за ответ, уточнил свой вопрос.

Answer 4

[patashnik]

В этом и прелесть интерфейсов, потом в коде FileDataKeeper будет использоваться только при создании объекта, а сам объект передаваться по типу DataKeeper, т.е.

$keeper = new FileDataKeeper();
$someService->setDataKeeper($keeper);
// or 
$keeper = new MysqlDataKeeper();
$someService->setDataKeeper($keeper);

class SomeService
{
    // ...
    public function setDataKeeper(DataKeeper $keeper)
    {
         // ...
    }
    // ...
}

Comments

[patashnik]

Type Hinting

Answer 5

[zhulan0v]

Можно в коде юзать класс DataKeeper, который внутри себя определяет, например, на основании конфига приложения, какой конкретно драйвер использовать — FileDataKeeper или MySQLDataKeeper.

В таком случае, для приложения переход от одного драйвера к другом будет прозрачным.

А вообще почитайте про паттерны проектирования.

Comments

[zhulan0v]

<?
//Что-то вроде этого, код условный:
class MySQLDataKeeper {
  public function getData(){
	return 'test';
  }
}

class DataKeeper {
  private static $driver_instance;

  public function __construct(){
    //откуда-нибудь узнаем какой драйвер использовать
   $driver_name = 'MySQLDataKeeper';
   self::$driver_instance = new $driver_name();
  }
  
  public function getData(){
	return self::$driver_instance->getData();
  }
}

//Использование
$keeper = new DataKeeper();
echo $keeper->getData();
?>

[denver]

Упомянутый выше DI — наилучшее решение.

[zhulan0v]

Да, согласен, DI — это более унифицированный подход.

Answer 6

[balloon]

Мне кажется, что:
1. В итоге Вы придете к абстрактному классу
2. Все таки придеться создать dependency container, если вы не хотите что бы родительский класс знал о наследниках.

abstract class DataKeeper {
  protected $data;

  public function setData($data) {
    $this->data = $data;
  }

  public function getData() {
    return $this->data;
  }

  abstract public function save()
  
  abstract public function process()
}

class FileDataKeeper extend DataKeeper {

  public function save() {
    // implementation
  }

  public function process() {
    // implementation
  }
}

class Container {
  protected static $classes = array();  

  public static function register($alias, $class) {
    self::$classes[$alias] = $class;    
  }

  public static function get($alias) {
    if (!isset(self::$classes[$alias]))
	throw new Exception("...");      

    $className = self::$classes[$alias];
    return new $className();
  }
}


// bootstrap.php
Container:register("dataKeeper", "FileDataKeeper");

// SomeWhere.php
$dataKeeper = Container::get("dataKeeper");

Answer 7

[Николай Васильчук]

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

Answer 8

[Renat Ibragimov]

interface, abstract

а чтобы в вашем случае не указывать название класса, то почитайте про Фабрики.

Answer 9

[Глеб Старков]

Какую именно вы проблему решаете?
Для чего нужна такая реализация класса?

Comments

[germn]

Хочу программировать правильно :)

А именно: предоставлять тому, кто работает с классом только те данные, которые необходимы для работы с «чёрным ящиком». Любые данные, которые говорят о деталях реализации, я хочу скрыть (например, вынести в отдельный файл).

[Глеб Старков]

Но тогда не понятно в чем проблема.
ООП для этого и предназначено.
Файл с классом у вас будет в отдельном файле, тот, кто его использует будет работать с объектом класса.
Если вы хотите освободить пользователя класса от необходимости заглядывать в файл с классом, для того, чтобы понять, как он работает, используйте аннотации к методам, типа (код из Symfony):

/**
* Sets the response's time-to-live for shared caches.
*
* This method adjusts the Cache-Control/s-maxage directive.
*
* @param integer $seconds Number of seconds
*
* @api
*/
public function setTtl($seconds)
{
    $this->setSharedMaxAge($this->getAge() + $seconds);
}

И пользователь класса сможет в IDE видеть эти аннотации:



Вообщем, — я не могу понять вашу проблему…

Answer 10

[Илья Плотников]

Меняйте структуру Вашего кода. Либо сделайте класс, объединяющий все методы хранения.
$dkm = new DataKeeper("mysql");
$dkf = new DataKeeper("file");

Comments

[Илья Плотников]

Если не хотите менять по всему коду, можно добавить параметр конструктора в константу или конфиг

Answer 11

[shagguboy]

>Получается, что в проекте, мне все равно надо будет писать:
>$dk = new FileDataKeeper;

Автолоад?

Answer 12

[Алексей Захаров]

// в зависимости от конфига или какого нибудь условия $storageMethod = 'имя класса'
$dk = new  $storageMethod;

или я просто не понял вопрос...

Answer 13

[kambur]

Вам все правильно советуют, но нужно все объединить:
1. Для сокрытия реализации класса нужно использовать интерфейсы.
2. Что касается $dk = new FileDataKeeper; - то решение этой проблемы - Фабрика. Вы создаете еще один клас-фабрику Factory с методом скажем getStorrage(); Для каждого варианта хранилища у вас будет свой клас (FileDataKeeper, MySQLDataKeeper ...). Получим:
$dk = Factory::getStorage();
А вот getStorage() будет анализировать ситуацию и возвращать или new FileDataKeeper() или new MySQLDataKeeper() плюс его реализация тоже будет закрыта.
В итоге пользователю мы даем информацию о интерфейсе (доступные методы) и метод для получения класса хранилища.