rusadrako/model_obj

Модели объектов

0.3.5 2025-02-24 12:13 UTC

Requires

• php: >=7.0.0
• rusadrako/driver_db: >=1.1

MIT

• Petukhov Leonid

README

Модели объектов

Подключение

Для подключения библиотеки к проекту подключите файл src/autoload.php

Доступные классы

Псевдоним	Полное имя класса
RD_Obj_Factory	RusaDrako\model_obj\factory
RD_Obj_Data	RusaDrako\model_obj\data_query
RD_Obj_Data_Core	RusaDrako\model_obj\data
RD_Obj_List	RusaDrako\model_obj\object_list
RD_Obj_Item	RusaDrako\model_obj\object_item

Начало работы

	$data = new $class($obj_db, $class_obj_name, $class_obj_list_name);

• $class - Имя класса, наследующего класс RD_Obj_Data
• $obj_db - Объект подключения к БД, наследующий класс \RD_DB (проект rusadrako\driver_db)
• $class_obj_name - Имя класса, наследующего класс RD_Obj_Item
• $class_obj_list_name - Имя класса, наследующего класс RD_Obj_List

Настройка объекта RD_Obj_Data

namespace \test;

/** Класс data */
class data extends \RD_Obj_Data {

	/** Настройки объекта */
	protected function setting() {
		$this->table_name   = 'table_test';   # Имя таблицы в БД
	}

	/** Пример получения объекта со списком записей */
	public function getList($where) {
		# ... Дополнительные настройки
		$sql = "SELECT :col: FROM :tab: WHERE {$where}";
		$data = $this->select($sql);
		return $data;
	}

	/** Пример получения объекта записи */
	public function getItem($where) {
		# ... Дополнительные настройки
		$sql = "SELECT :col: FROM :tab: WHERE id = {$where}";
		$data = $this->select($sql);
		$data = $data->first();
		return $data;
	}

	/** Пример получения объекта со списком записей с заполнением дополнительного свойства объекта */
	public function getListAddProp($where) {
		# ... Дополнительные настройки
		$sql = "SELECT :col:, 1 AS ADD_NAME FROM :tab: WHERE id = {$where}";
		$data = $this->select($sql);
		$data = $data->first();
		return $data;
	}

	# ... Методы расширения класса

}

Методы объекта RD_Obj_Data

Метод	Доступ	Описание
select(string $sql)	public	Возвращает объект со списком объектов записей из запроса
insert($arr_data)	public	Добавляет запись
update($arr_data, $id)	public	Обновляет запись
replace_column($sql)	protected	Обновляет запроса - замена маркеров
newItem()	public	Создаёт новый объект
getByKey(int $id)	public	Возвращает запись по id
getByKeyOrNew(int $id)	public	Возвращает запись по id или новый элемент
getByKeyArray(arr $arr_id)	public	Возвращает список записей по массиву id
getAll()	public	Возвращает все записи

Настройка объекта RD_Obj_Item

namespace \test;

/** Класс item */
class item extends \RD_Obj_Item {

	/** Подготовка данных к var_dump() и серилизации JSON (JsonSerializable) * /
	protected function __preparationData($arr) {
		$arr = parent::__preparationData($arr);   # Получение массива для вывода
		# ... Дополнительные настройки
		return $arr;
	}/**/

	/** Настройки объекта */
	protected function setting() {

		# Ключевое поле объекта
		$this->set_column_id('id');        # ID записи

		# Остновные свойства объекта (переопределяются в процессе работы, сохраняется через save())
		# Имя поля связанной таблицы => псевдоним (имя свойства)
		$column = [
			'id'        => 'ID',        # ID записи
			'title'     => 'TITLE',     # Заголовок
			'updated'   => 'UPDATED',   # Дата обновления
			'created'   => 'CREATED',   # Дата создания
		];
		foreach ($column as $k => $v) {
			$this->set_column_name($k, $v);
		}

		# Дополнительные свойства объекта (переопределяются в процессе работы, не сохраняется через save())
		$add_prop = [
			'ADD_NAME'   => null,
		];
		foreach ($add_prop as $k => $v) {
			$this->set_add_data($k, $v);
		}

		# Вычисляемые свойства объекта (в процессе работы не могут быть переопределены)
		$function = [
			'FUNC_NAME'   => function() {return $this->TITLE . $this->ID;},
		];
		foreach ($function as $k => $v) {
			$this->set_gen_data($k, $v);
		}

		# Объктные свойства объекта (в процессе работы не могут быть переопределены)
		$object = [
			'OBJ_NAME'   => new \test\new_class(),
		];
		foreach ($object as $k => $v) {
			$this->set_sub_obj($k, $v);
		}
	}

	/** Фильтры при заполнении свойств объекта */
	protected function filter($name, $value) {
		switch ($name) {
			case 'ID':
				$value = (int) $value;
				break;
		}
		return $value;
	}

	/** Сохранение записи */
	public function save() {
		# ... Дополнительные настройки
		parent::save();   # Сохранения записи
	}

	# ... Методы расширения класса

}

Методы объекта RD_Obj_Data

trait__data__set

Метод	Доступ	Описание
set_column_id($name)	protected	Задаёт имя ключевого поля
set_column_name($name, $alias = null)	protected	Задаёт имя и псевдоним поля
set_gen_data($name, $func)	protected	Задаёт связанную со свойством функцию
set_sub_obj($name, $obj)	protected	Задаёт связанный со свойством объект

trait__data_preparation

Метод	Доступ	Описание
__preparationData($arr)	protected	Подготовка данных к var_dump() и серилизации JSON (JsonSerializable)

trait__data

Метод	Доступ	Описание
getKey()	public	Возвращает ключ элемента
getKeyName()	public	Возвращает имя ключевого поля
getProp(string $name)	public	Возвращает значение свойства
setProp(string $name, $value)	public	Задаёт значение свойства
filter(string $name, $value)	protected	Фильтр обновления данных

trait__link_obj

Метод	Доступ	Описание
cleanLinkObj($name)	public	Очищает присоединённый объект
getLinkObj($name)	public	Возвращает присоединённый объект
setLinkObj($name, $value)	public	Добавляет объект как элемент
setLinkObjArr($name, $value)	public	Добавляет объект как элемент массива

trait__data__db

Метод	Доступ	Описание
setDataArrDB(array $arr_data)	public	Присваевает свойства из массива (Данные из БД)
getDBColumnList(int $id)	public	Возвращает список столбцов
save()	public	Сохраняет элемент

Настройка объекта RD_Obj_List

namespace \test;

/** Класс list_t */
class list_t extends \RD_Obj_List {

	/** Подготовка данных к var_dump() и серилизации JSON (JsonSerializable) * /
	protected function __preparationData($arr) {
		$arr = parent::__preparationData($arr);   # Получение массива для вывода
		# ... Дополнительные настройки
		return $arr;
	}/**/

	# ... Методы расширения класса

}

Методы объекта RD_Obj_List

Метод	Доступ	Описание
add(\RusaDrako\model_obj\object_item $item)	public	Добавляет элемент в список
item(int $num)	public	Возвращает указанный элемент
first()	public	Возвращает первый элемент
last()	public	Возвращает последний элемент
iterator()	public	Осуществляет перебор элементов
get_array()	public	Возвращает массив входящих объектов
addList(\RusaDrako\model_obj\object_list $list)	public	Осуществляет добавление элементов из переданного списка
count()	public	Возвращает число элементов