PHP Interface ManaPHP\Mvc\ModelInterface

Datei anzeigen Open project: manaphp/manaphp

Public Methods

Method	Description
assign ( array $data, array $whiteList = null ) : static	Assigns values to a model from an array `$city->assign(['city_id'=>1,'city_name'=>'beijing']); $city->assign(['city_id'=>1,'city_name'=>'beijing'],['city_name']);`
average ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : double	Allows to calculate the average value on a column matching the specified conditions
count ( string \| array $parameters = null, string $column = '*', integer \| array $cacheOptions = null ) : integer \| array	Allows to count how many records match the specified conditions
create ( array $data = null, array $whiteList = null ) : void	Inserts a model instance. If the instance already exists in the persistence it will throw an exception Returning true on success or false otherwise.
delete ( ) : void	Deletes a model instance. Returning true on success or false otherwise.
deleteAll ( string \| array $conditions, array $bind = [] ) : integer
exists ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : boolean
find ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static[]	Allows to query a set of records that match the specified conditions
findAll ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static[]	alias of find
findFirst ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static \| false	Allows to query the first record that match the specified conditions
getChangedFields ( ) : array	Returns a list of changed values
getReadConnection ( ) : ManaPHP\DbInterface	Gets internal database connection
getReadConnectionService ( ) : string	Returns DependencyInjection connection service used to read data
getSnapshotData ( ) : array	Returns the internal snapshot data
getSource ( ) : string	Returns table name mapped in the model `$city->getSource();`
getWriteConnection ( ) : ManaPHP\DbInterface	Gets internal database connection
getWriteConnectionService ( ) : string	Returns DependencyInjection connection service used to write data
hasChanged ( string \| array $fields ) : boolean	Check if a specific attribute has changed This only works if the model is keeping data snapshots
max ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed	Allows to get the max value of a column that match the specified conditions
min ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed	Allows to get the min value of a column that match the specified conditions
query ( ManaPHP\DiInterface $dependencyInjector = null ) : ManaPHP\Mvc\Model\QueryBuilderInterface	Create a criteria for a special model
save ( array $data = null, array $whiteList = null ) : void	Inserts or updates a model instance. Returning true on success or false otherwise.
setConnectionService ( string $connectionService ) : static	Sets both read/write connection services
setReadConnectionService ( string $connectionService ) : static	Sets the DependencyInjection connection service used to read data
setWriteConnectionService ( string $connectionService ) : static	Sets the DependencyInjection connection service used to write data
sum ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed	Allows to calculate a summary on a column that match the specified conditions
toArray ( ) : array	Returns the instance as an array representation
update ( array $data = null, array $whiteList = null ) : void	Updates a model instance. If the instance does n't exist in the persistence it will throw an exception Returning true on success or false otherwise.
updateAll ( array $columnValues, string \| array $conditions, array $bind = [] ) : integer

Method Details

assign() public method

Assigns values to a model from an array


 $city->assign(['city_id'=>1,'city_name'=>'beijing']);
 $city->assign(['city_id'=>1,'city_name'=>'beijing'],['city_name']);

public assign ( array $data, array $whiteList = null ) : static
$data	array
$whiteList	array
return	static

average() public static method

Allows to calculate the average value on a column matching the specified conditions

public static average ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : double
$column	string
$parameters	string \| array
$cacheOptions	integer \| array
return	double

count() public static method


City::count(['country_id'=>2]);

public static count ( string \| array $parameters = null, string $column = '*', integer \| array $cacheOptions = null ) : integer \| array
$parameters	string \| array
$column	string
$cacheOptions	integer \| array
return	integer \| array

create() public method

Inserts a model instance. If the instance already exists in the persistence it will throw an exception Returning true on success or false otherwise.

public create ( array $data = null, array $whiteList = null ) : void
$data	array
$whiteList	array
return	void

delete() public method

Deletes a model instance. Returning true on success or false otherwise.

public delete ( ) : void
return	void

deleteAll() public static method

public static deleteAll ( string \| array $conditions, array $bind = [] ) : integer
$conditions	string \| array
$bind	array
return	integer

exists() public static method

public static exists ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : boolean
$parameters	string \| array
$cacheOptions	integer \| array
return	boolean

find() public static method


 $cities=City::find(['country_id'=>2]);
 $cities=City::find(['conditions'=>['country_id'=>2],'order'=>'city_id desc']);
 $cities=City::find([['country_id'=>2],'order'=>'city_id desc']);
 $cities=City::find(['conditions'=>'country_id =:country_id','bind'=>['country_id'=>2]]);

public static find ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static[]
$parameters	string \| array
$cacheOptions	integer \| array
return	static[]

findAll() public static method

alias of find

public static findAll ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static[]
$parameters	string \| array
$cacheOptions	integer \| array
return	static[]

findFirst() public static method


 $city=City::findFirst(10);
 $city=City::findFirst(['city_id'=>10]);
 $city=City::findFirst(['conditions'=>['city_id'=>10]]);
 $city=City::findFirst(['conditions'=>'city_id =:city_id','bind'=>['city_id'=>10]]);

public static findFirst ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static \| false
$parameters	string \| array
$cacheOptions	integer \| array
return	static \| false

getChangedFields() public method

Returns a list of changed values

public getChangedFields ( ) : array
return	array

getReadConnection() public method

Gets internal database connection

public getReadConnection ( ) : ManaPHP\DbInterface
return	ManaPHP\DbInterface

getReadConnectionService() public method

Returns DependencyInjection connection service used to read data

public getReadConnectionService ( ) : string
return	string

getSnapshotData() public method

Returns the internal snapshot data

public getSnapshotData ( ) : array
return	array

getSource() public method

Returns table name mapped in the model


 $city->getSource();

public getSource ( ) : string
return	string

getWriteConnection() public method

Gets internal database connection

public getWriteConnection ( ) : ManaPHP\DbInterface
return	ManaPHP\DbInterface

getWriteConnectionService() public method

Returns DependencyInjection connection service used to write data

public getWriteConnectionService ( ) : string
return	string

hasChanged() public method

Check if a specific attribute has changed This only works if the model is keeping data snapshots

public hasChanged ( string \| array $fields ) : boolean
$fields	string \| array
return	boolean

max() public static method

Allows to get the max value of a column that match the specified conditions

public static max ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed
$column	string
$parameters	string \| array
$cacheOptions	integer \| array
return	mixed

min() public static method

Allows to get the min value of a column that match the specified conditions

public static min ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed
$column	string
$parameters	string \| array
$cacheOptions	integer \| array
return	mixed

query() public static method

Create a criteria for a special model

public static query ( ManaPHP\DiInterface $dependencyInjector = null ) : ManaPHP\Mvc\Model\QueryBuilderInterface
$dependencyInjector	ManaPHP\DiInterface
return	ManaPHP\Mvc\Model\QueryBuilderInterface

save() public method

Inserts or updates a model instance. Returning true on success or false otherwise.

public save ( array $data = null, array $whiteList = null ) : void
$data	array
$whiteList	array
return	void

setConnectionService() public method

Sets both read/write connection services

public setConnectionService ( string $connectionService ) : static
$connectionService	string
return	static

setReadConnectionService() public method

Sets the DependencyInjection connection service used to read data

public setReadConnectionService ( string $connectionService ) : static
$connectionService	string
return	static

setWriteConnectionService() public method

Sets the DependencyInjection connection service used to write data

public setWriteConnectionService ( string $connectionService ) : static
$connectionService	string
return	static

sum() public static method

Allows to calculate a summary on a column that match the specified conditions

public static sum ( string $column, string \| array $parameters = null, integer \| array $cacheOptions = null ) : mixed
$column	string
$parameters	string \| array
$cacheOptions	integer \| array
return	mixed

toArray() public method


print_r($robot->toArray());

public toArray ( ) : array
return	array

update() public method

Updates a model instance. If the instance does n't exist in the persistence it will throw an exception Returning true on success or false otherwise.

public update ( array $data = null, array $whiteList = null ) : void
$data	array
$whiteList	array
return	void

updateAll() public static method

public static updateAll ( array $columnValues, string \| array $conditions, array $bind = [] ) : integer
$columnValues	array
$conditions	string \| array
$bind	array
return	integer

public static findFirst ( string \| array $parameters = null, integer \| array $cacheOptions = null ) : static \| false
$parameters	string \| array
$cacheOptions	integer \| array
return	static \| false