PHP Class NerdsAndCompany\Schematic\Services\Base

See link: http://www.nerds.company
Author: Nerds & Company
Inheritance: extends Craft\BaseApplicationComponent
Show file Open project: itmundi/schematic

Protected Properties

Property Type Description
$resultModel NerdsAndCompany\Schematic\Models\Result

Public Methods

Method Description
__construct ( ) Constructor to setup result model.
export ( array $data = [] ) : mixed Required export method.
getResultModel ( ) : Result Returns current result model.
import ( array $data, boolean $force ) : Result Required import method.

Protected Methods

Method Description
addError ( $message, string $attribute = 'errors' ) Adds error to result model.
addErrors ( array $messages, string $attribute = 'errors' ) Adds multiple errors to result model.
beginTransaction ( ) Starts DB transaction.
commitTransaction ( ) Commits transaction.
getDbService ( ) : DbConnection
getTransaction ( ) : CDbTransaction Returns current transaction.
hasErrors ( string $attribute = 'errors' ) : boolean Returns if there are errors or not.
rollbackTransaction ( ) Rolls back transaction.

Method Details

__construct() public method

Constructor to setup result model.
public __construct ( )

addError() protected method

Adds error to result model.
protected addError ( $message, string $attribute = 'errors' )
$message
$attribute string

addErrors() protected method

Adds multiple errors to result model.
protected addErrors ( array $messages, string $attribute = 'errors' )
$messages array
$attribute string

beginTransaction() protected method

Starts DB transaction.
protected beginTransaction ( )

commitTransaction() protected method

Commits transaction.
protected commitTransaction ( )

export() abstract public method

Required export method.
abstract public export ( array $data = [] ) : mixed
$data array
return mixed

getDbService() protected method

protected getDbService ( ) : DbConnection
return DbConnection

getResultModel() public method

Returns current result model.
public getResultModel ( ) : Result
return NerdsAndCompany\Schematic\Models\Result

getTransaction() protected method

Returns current transaction.
protected getTransaction ( ) : CDbTransaction
return CDbTransaction

hasErrors() protected method

Returns if there are errors or not.
protected hasErrors ( string $attribute = 'errors' ) : boolean
$attribute string
return boolean

import() abstract public method

Required import method.
abstract public import ( array $data, boolean $force ) : Result
$data array
$force boolean
return NerdsAndCompany\Schematic\Models\Result

rollbackTransaction() protected method

Rolls back transaction.
protected rollbackTransaction ( )

Property Details

$resultModel protected property

protected Result,NerdsAndCompany\Schematic\Models $resultModel
return NerdsAndCompany\Schematic\Models\Result