PHP Class Sleimanx2\Plastic\Mappings\Mapper

Show file Open project: sleimanx2/plastic Class Usage Examples

Protected Properties

Property Type Description
$notes array The message notes for the current operation.

Public Methods

Method Description
__construct ( Mappings $repository, Illuminate\Filesystem\Filesystem $files ) Mapper constructor.
getFilesystem ( ) : Illuminate\Filesystem\Filesystem Return a filesystem instance.
getMappingFiles ( $path ) : array Get all of the migration files in a given path.
getNotes ( ) : array Return the registered notes.
getRepository ( ) : Illuminate\Filesystem\Filesystem Return a filesystem instance.
repositoryExists ( ) : mixed Check if the mappings repository exists.
requireFiles ( $path, array $files ) Require All migration files in a given path.
resolve ( $file ) : mixed Resolve mapping file from.
run ( $path, array $options = [] )
runMap ( $file, $batch ) Run the given mapping file.
runMappingList ( array $mappings, array $options = [] ) Run an array of mappings.
setConnection ( string $name ) : void Set the default connection name.

Protected Methods

Method Description
note ( $message ) Add a message to the note array.

Method Details

__construct() public method

Mapper constructor.
public __construct ( Mappings $repository, Illuminate\Filesystem\Filesystem $files )
$repository Mappings
$files Illuminate\Filesystem\Filesystem

getFilesystem() public method

Return a filesystem instance.
public getFilesystem ( ) : Illuminate\Filesystem\Filesystem
return Illuminate\Filesystem\Filesystem

getMappingFiles() public method

Get all of the migration files in a given path.
public getMappingFiles ( $path ) : array
$path
return array

getNotes() public method

Return the registered notes.
public getNotes ( ) : array
return array

getRepository() public method

Return a filesystem instance.
public getRepository ( ) : Illuminate\Filesystem\Filesystem
return Illuminate\Filesystem\Filesystem

note() protected method

Add a message to the note array.
protected note ( $message )
$message

repositoryExists() public method

Check if the mappings repository exists.
public repositoryExists ( ) : mixed
return mixed

requireFiles() public method

Require All migration files in a given path.
public requireFiles ( $path, array $files )
$path
$files array

resolve() public method

Resolve mapping file from.
public resolve ( $file ) : mixed
$file
return mixed

run() public method

public run ( $path, array $options = [] )
$options array

runMap() public method

Run the given mapping file.
public runMap ( $file, $batch )
$file
$batch

runMappingList() public method

Run an array of mappings.
public runMappingList ( array $mappings, array $options = [] )
$mappings array
$options array

setConnection() public method

Set the default connection name.
public setConnection ( string $name ) : void
$name string
return void

Property Details

$notes protected property

The message notes for the current operation.
protected array $notes
return array