PHP AUTH-REG

Core_ORM
in package

PHPAUTHREG

Properties

$_allowedProperties : array<string|int, mixed>: Перечень свойств модели, разрешенных к чтению
$_columns : array<string|int, mixed>: Имена столбцов таблицы в БД и их параметры
$_database : object: Объект подключения к СУБД
$_forbiddenProperties : array<string|int, mixed>: Перечень свойств модели, запрещенных к чтению
$_init : bool: Статус инициализации объекта модели
$_initialData : array<string|int, mixed>: Исходные данные модели из таблицы в БД
$_lastQuery : string: Строка последнего выполненного запроса к БД
$_loaded : bool: Была ли загружена модель из базы данных
$_modelName : string: Имя модели
$_newData : array<string|int, mixed>: Новые данные модели для сохранения в БД
$_primaryKey : string: Наименование поля таблицы, в которой находится первичный ключ В большинстве случаев это будет поле `id`, но нельзя исключать вероятность того, что кто-то назовёт поле с первичным ключом иначе
$_queryBuilder : object: Объект взаимодействия с СУБД
$_queryType : int: Тип выполняемого SQL-запроса 0 - SELECT 1 - INSERT 2 - UPDATE 3 - DELETE
$_sql : string: Строка подготавливаемого запроса к БД
$_statement : object: Объект результирующего запроса или подготовленного запроса
$_tableName : string: Имя таблицы в БД, соответствующей модели

Methods

__get() : mixed: Магический метод для получения значения необъявленного свойства класса Вернет значение из запрошенного поля таблицы, если оно разрешено в массиве $_allowedProperties и есть среди полей таблицы
__set() : mixed: Магический метод для установки значений необъявленных свойств класса
clear() : object: Очищает объект от пользовательских данных
findAll() : array<string|int, mixed>: Получает из базы данных все записи, которые вернет подготовленный запрос в соответствии с условиями
findPrimaryKeyFieldName() : mixed: Получает имя поля, которое имеет первичный ключ
getColumns() : array<string|int, mixed>: Получает и возвращает перечень загруженных полей таблицы
getModelName() : string: Получает и возвращает имя модели
getPrimaryKey() : mixed: Возвращает значение поля первичного ключа
getQueryType() : int: Возвращает тип запроса
getTableName() : string: Получает и возвращает имя таблицы в БД, соответствующей модели
load() : mixed: Загружает указанные данные модели
queryBuilder() : mixed: Взаимодействует с СУБД от лица объекта модели
save() : object: Сохраняет информацию о модели в БД
setQueryType() : object: Устанавливает тип запроса SELECT, INSERT и т.п.
update() : mixed
__construct() : mixed: Конструктор класса. Его можно вызвать только изнутри, либо фабричным методом
_init() : mixed: Инициализирует объект модели Этот метод на текущем этапе не имеет задач, которые должен решать, поэтому просто устанавливаем, что объект инициализирован А ещё загрузим информацию о столбцах таблицы
_load() : mixed: Загружает первичную информацию модели
_loadColumns() : mixed: Загружает информацию о столбцах таблицы модели в БД
_setPrimarykey() : mixed: Устанавливает значение первичного ключа для объекта — не для записи в БД

$_allowedProperties

Перечень свойств модели, разрешенных к чтению


    protected
        array<string|int, mixed>
    $_allowedProperties
     = []

$_columns

Имена столбцов таблицы в БД и их параметры


    protected
        array<string|int, mixed>
    $_columns
     = []

$_database

Объект подключения к СУБД


    protected
        object
    $_database
     = \NULL

Core_Database

$_forbiddenProperties

Перечень свойств модели, запрещенных к чтению


    protected
        array<string|int, mixed>
    $_forbiddenProperties
     = []

$_init

Статус инициализации объекта модели


    protected
        bool
    $_init
     = \FALSE

$_initialData

Исходные данные модели из таблицы в БД


    protected
        array<string|int, mixed>
    $_initialData
     = []

$_lastQuery

Строка последнего выполненного запроса к БД


    protected
        string
    $_lastQuery
     = \NULL

$_loaded

Была ли загружена модель из базы данных


    protected
        bool
    $_loaded
     = \FALSE

$_modelName

Имя модели


    protected
        string
    $_modelName
     = ''

$_newData

Новые данные модели для сохранения в БД


    protected
        array<string|int, mixed>
    $_newData
     = []

$_primaryKey

Наименование поля таблицы, в которой находится первичный ключ В большинстве случаев это будет поле `id`, но нельзя исключать вероятность того, что кто-то назовёт поле с первичным ключом иначе


    protected
        string
    $_primaryKey
     = 'id'

$_queryBuilder

Объект взаимодействия с СУБД


    protected
        object
    $_queryBuilder
     = \NULL

PDOStatement

$_queryType

Тип выполняемого SQL-запроса 0 - SELECT 1 - INSERT 2 - UPDATE 3 - DELETE


    protected
        int
    $_queryType
     = \NULL

$_sql

Строка подготавливаемого запроса к БД


    protected
        string
    $_sql
     = \NULL

$_statement

Объект результирующего запроса или подготовленного запроса


    protected
        object
    $_statement
     = \NULL

$_tableName

Имя таблицы в БД, соответствующей модели


    protected
        string
    $_tableName
     = ''

__get()

Магический метод для получения значения необъявленного свойства класса Вернет значение из запрошенного поля таблицы, если оно разрешено в массиве $_allowedProperties и есть среди полей таблицы


    public
                    __get(string $property) : mixed

Parameters

$property : string

Return values

mixed —

string|NULL

__set()

Магический метод для установки значений необъявленных свойств класса


    public
                    __set(string $property, mixed $value) : mixed

Parameters

$property : string
$value : mixed

clear()

Очищает объект от пользовательских данных


    public
                    clear() : object

Return values

object —

self

findAll()

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


    public
                    findAll() : array<string|int, mixed>

Return values

array<string|int, mixed>

findPrimaryKeyFieldName()

Получает имя поля, которое имеет первичный ключ


    public
                    findPrimaryKeyFieldName() : mixed

getColumns()

Получает и возвращает перечень загруженных полей таблицы


    public
                    getColumns() : array<string|int, mixed>

Return values

array<string|int, mixed>

getModelName()

Получает и возвращает имя модели


    public
                    getModelName() : string

Return values

string

getPrimaryKey()

Возвращает значение поля первичного ключа


    public
                    getPrimaryKey([mixed $returnedValueIWasNotFound = NULL ]) : mixed

Parameters

$returnedValueIWasNotFound : mixed = NULL: вернется если не было найдено значение поля первичного ключа в случае, если был задан параметр отличный от NULL

getQueryType()

Возвращает тип запроса


    public
                    getQueryType() : int

Return values

int

getTableName()

Получает и возвращает имя таблицы в БД, соответствующей модели


    public
                    getTableName() : string

Return values

string

load()

Загружает указанные данные модели


    public
                    load([mixed $property = NULL ]) : mixed

Parameters

$property : mixed = NULL

queryBuilder()

Взаимодействует с СУБД от лица объекта модели


    public
                    queryBuilder() : mixed

save()

Сохраняет информацию о модели в БД


    public
                    save() : object

Return values

object —

self

setQueryType()

Устанавливает тип запроса SELECT, INSERT и т.п.


    public
                    setQueryType(int $queryType) : object

Parameters

$queryType : int

Return values

object —

self

update()


    public
                    update() : mixed

__construct()

Конструктор класса. Его можно вызвать только изнутри, либо фабричным методом


    protected
                    __construct([mixed $primary_key = NULL ]) : mixed

Parameters

$primary_key : mixed = NULL

_init()

Инициализирует объект модели Этот метод на текущем этапе не имеет задач, которые должен решать, поэтому просто устанавливаем, что объект инициализирован А ещё загрузим информацию о столбцах таблицы


    protected
        final            _init() : mixed

_load()

Загружает первичную информацию модели


    protected
                    _load([mixed $property = NULL ]) : mixed

Parameters

$property : mixed = NULL

_loadColumns()

Загружает информацию о столбцах таблицы модели в БД


    protected
                    _loadColumns() : mixed

_setPrimarykey()

Устанавливает значение первичного ключа для объекта — не для записи в БД


    protected
                    _setPrimarykey(int $primary_key) : mixed

Parameters

$primary_key : int

Core_ORM in package PHPAUTHREG

Table of Contents

Properties

Methods

Properties

$_allowedProperties

$_columns

$_database

$_forbiddenProperties

$_init

$_initialData

$_lastQuery

$_loaded

$_modelName

$_newData

$_primaryKey

$_queryBuilder

$_queryType

$_sql

$_statement

$_tableName

Methods

__get()

Parameters

Return values

__set()

Parameters

clear()

Return values

findAll()

Return values

findPrimaryKeyFieldName()

getColumns()

Return values

getModelName()

Return values

getPrimaryKey()

Parameters

getQueryType()

Return values

getTableName()

Return values

load()

Parameters

queryBuilder()

save()

Return values

setQueryType()

Parameters

Return values

update()

__construct()

Parameters

_init()

_load()

Parameters

_loadColumns()

_setPrimarykey()

Parameters

Core_ORM
in package

PHPAUTHREG