• Главная
• Contao
• Model

PHP Класс Contao\Model

The class allows you to find and automatically join database records and to convert the result into objects. It also supports creating new objects and persisting them in the database. Usage: Write $user = new UserModel(); $user->name = 'Leo Feyer'; $user->city = 'Wuppertal'; $user->save(); Read $user = UserModel::findByCity('Wuppertal'); while ($user->next()) { echo $user->name; } Показать файл Открыть проект Примеры использования класса

Защищенные свойства (Protected)

Свойство	Тип	Описание
$arrClassNames	array	Class name cache
$arrData	array	Data
$arrModified	array	Modified keys
$arrRelated	array	Related
$arrRelations	array	Relations
$blnPreventSaving	boolean	Prevent saving
$strPk	string	Primary key
$strTable	string	Table name

Открытые методы

Метод	Описание
__callStatic ( string $name, array $args ) : static | Collection | null	Magic method to map Model::findByName() to Model::findBy('name')
__clone ( )	Unset the primary key when cloning an object
__construct ( Result $objResult = null )	Load the relations and optionally process a result set
__get ( string $strKey ) : mixed | null	Return an object property
__isset ( string $strKey ) : boolean	Check whether a property is set
__set ( string $strKey, mixed $varValue )	Set an object property
attach ( )	Attach the model to the registry
cloneOriginal ( ) : static	Clone a model with its original values
countAll ( ) : integer	Return the total number of rows
countBy ( mixed $strColumn = null, mixed $varValue = null, array $arrOptions = [] ) : integer	Return the number of records matching certain criteria
current ( ) : static	Return the object instance
delete ( ) : integer	Delete the current record and return the number of affected rows
detach ( boolean $blnKeepClone = true )	Detach the model from the registry
findAll ( array $arrOptions = [] ) : Collection | null	Find all records
findBy ( mixed $strColumn, mixed $varValue, array $arrOptions = [] ) : static | Collection | null	Find records by various criteria
findByIdOrAlias ( mixed $varId, array $arrOptions = [] ) : static	Find a single record by its ID or alias
findByPk ( mixed $varValue, array $arrOptions = [] ) : static	Find a single record by its primary key
findMultipleByIds ( array $arrIds, array $arrOptions = [] ) : Collection | null	Find multiple records by their IDs
findOneBy ( mixed $strColumn, mixed $varValue, array $arrOptions = [] ) : static	Find a single record by various criteria
getClassFromTable ( string $strTable ) : string	Compile a Model class name from a table name (e.g. tl_form_field becomes FormFieldModel)
getPk ( ) : string	Return the name of the primary key
getRelated ( string $strKey, array $arrOptions = [] ) : static | Collection | null	Lazy load related records
getTable ( ) : string	Return the name of the related table
getUniqueFields ( ) : array	Return an array of unique field/column names (without the PK)
isModified ( ) : boolean	Return true if the model has been modified
markModified ( string $strKey )	Mark a field as modified
mergeRow ( array $arrData ) : static	Set the current record from an array preserving modified but unsaved fields
onRegister ( Registry $registry )	Called when the model is attached to the model registry
onUnregister ( Registry $registry )	Called when the model is detached from the model registry
originalRow ( ) : array	Return the original values as associative array
preventSaving ( boolean $blnKeepClone = true )	Prevent saving the model
refresh ( )	Reload the data from the database discarding all modifications
row ( ) : array	Return the current record as associative array
save ( ) : static	Save the current record
setRow ( array $arrData ) : static	Set the current record from an array

Защищенные методы

Метод	Описание
buildCountQuery ( array $arrOptions ) : string	Build a query based on the given options to count the number of records
buildFindQuery ( array $arrOptions ) : string	Build a query based on the given options
createCollection ( array $arrModels, string $strTable ) : Collection	Create a Model\Collection object
createCollectionFromDbResult ( Result $objResult, string $strTable ) : Collection	Create a new collection from a database result
createModelFromDbResult ( Result $objResult ) : static	Create a model from a database result
find ( array $arrOptions ) : static | Collection | null	Find records and return the model or model collection
postFind ( Result $objResult ) : Result	Modify the database result before the model is created
postSave ( integer $intType )	Modify the current row after it has been stored in the database
preFind ( Statement $objStatement ) : Statement	Modify the database statement before it is executed
preSave ( array $arrSet ) : array	Modify the current row before it is stored in the database

Описание методов

Описание свойств