A17\Twill\Services\Blocks\BlockMaker

class BlockMaker (View source)

Properties

protected Filesystem	$files
protected Command	$command
protected Block	$blockBase
protected	$icon

Methods

__construct(Filesystem $files)

No description

mixed

make($blockName, $baseName, $iconName, bool $generateView = false)

Make a new block.

bool

checkBlockStub($baseName)

No description

bool

checkIconFile($iconName)

No description

bool

checkBlockFile($blockFile)

No description

checkBlockBaseFormat($stubFileName)

No description

checkRepeaters($repeaters)

No description

string|string[]|null

makeBlock($blockName, $iconName, $stubFileName = null, null|string $stub = null)

No description

string

makeBlockIdentifier($blockName)

No description

string

makeBlockPath(string $blockIdentifier, string $type = 'block')

No description

string

makeBlockTitle($string)

No description

mixed

getBlockByName($block, array $sources = [])

No description

mixed

getIconFile($icon, $addExtension = true)

No description

Collection

generateRepeaters($baseName, $blockName, $blockBase)

No description

array

createRepeater($repeaterName, $baseName, $blockName, $blockBase, $blockString)

No description

put($filePath, $contents)

No description

bool

saveAllFiles($blockName, string $blockFile, Collection $repeaters, string $blockIdentifier, bool $generateView = false)

No description

BlockMaker

setCommand(Command $command)

No description

info($message)

No description

error($message)

No description

Details

at line 37
`__construct(Filesystem $files)`

No description

Parameters

Filesystem

$files

at line 53
`mixed make($blockName, $baseName, $iconName, bool $generateView = false)`

Make a new block.

Parameters

	$blockName
	$baseName
	$iconName
bool	$generateView

Return Value

mixed

Exceptions

FileNotFoundException
Exception

at line 109
`protected bool checkBlockStub($baseName)`

No description

Parameters

$baseName

Return Value

bool

Exceptions

Exception

at line 124
`protected bool checkIconFile($iconName)`

No description

Parameters

$iconName

Return Value

bool

at line 139
`protected bool checkBlockFile($blockFile)`

No description

Parameters

$blockFile

Return Value

bool

at line 152
`protected checkBlockBaseFormat($stubFileName)`

No description

Parameters

$stubFileName

at line 167
`protected checkRepeaters($repeaters)`

No description

Parameters

$repeaters

at line 192
`string|string[]|null makeBlock($blockName, $iconName, $stubFileName = null, null|string $stub = null)`

No description

Parameters

	$blockName
	$iconName
	$stubFileName
null\|string	$stub

Return Value

string|string[]|null

Exceptions

FileNotFoundException

at line 268
`protected string makeBlockIdentifier($blockName)`

No description

Parameters

$blockName

Return Value

string

Exceptions

Exception

at line 281
`protected string makeBlockPath(string $blockIdentifier, string $type = 'block')`

No description

Parameters

string	$blockIdentifier
string	$type

Return Value

string

at line 306
`string makeBlockTitle($string)`

No description

Parameters

$string

Return Value

string

at line 321
`mixed getBlockByName($block, array $sources = [])`

No description

Parameters

	$block
array	$sources

Return Value

mixed

Exceptions

Exception

at line 330
`mixed getIconFile($icon, $addExtension = true)`

No description

Parameters

	$icon
	$addExtension

Return Value

mixed

at line 364
`Collection generateRepeaters($baseName, $blockName, $blockBase)`

No description

Parameters

	$baseName
	$blockName
	$blockBase

Return Value

Collection

Exceptions

FileNotFoundException

at line 421
`array createRepeater($repeaterName, $baseName, $blockName, $blockBase, $blockString)`

No description

Parameters

	$repeaterName
	$baseName
	$blockName
	$blockBase
	$blockString

Return Value

array

Exceptions

FileNotFoundException
Exception

at line 464
`put($filePath, $contents)`

No description

Parameters

	$filePath
	$contents

at line 480
`protected bool saveAllFiles($blockName, string $blockFile, Collection $repeaters, string $blockIdentifier, bool $generateView = false)`

No description

Parameters

	$blockName
string	$blockFile
Collection	$repeaters
string	$blockIdentifier
bool	$generateView

Return Value

bool

at line 515
`BlockMaker setCommand(Command $command)`

No description

Parameters

Command

$command

Return Value

BlockMaker

at line 525
`info($message)`

No description

Parameters

$message

at line 535
`error($message)`

No description

Parameters

$message

BlockMaker

Properties

Methods

Details

at line 37 __construct(Filesystem $files)

Parameters

at line 53 mixed make($blockName, $baseName, $iconName, bool $generateView = false)

Parameters

Return Value

Exceptions

at line 109 protected bool checkBlockStub($baseName)

Parameters

Return Value

Exceptions

at line 124 protected bool checkIconFile($iconName)

Parameters

Return Value

at line 139 protected bool checkBlockFile($blockFile)

Parameters

Return Value

at line 152 protected checkBlockBaseFormat($stubFileName)

Parameters

at line 167 protected checkRepeaters($repeaters)

Parameters

at line 192 string|string[]|null makeBlock($blockName, $iconName, $stubFileName = null, null|string $stub = null)

Parameters

Return Value

Exceptions

at line 268 protected string makeBlockIdentifier($blockName)

Parameters

Return Value

Exceptions

at line 281 protected string makeBlockPath(string $blockIdentifier, string $type = 'block')

Parameters

Return Value

at line 306 string makeBlockTitle($string)

Parameters

Return Value

at line 321 mixed getBlockByName($block, array $sources = [])

Parameters

Return Value

Exceptions

at line 330 mixed getIconFile($icon, $addExtension = true)

Parameters

Return Value

at line 364 Collection generateRepeaters($baseName, $blockName, $blockBase)

Parameters

Return Value

Exceptions

at line 421 array createRepeater($repeaterName, $baseName, $blockName, $blockBase, $blockString)

Parameters

Return Value

Exceptions

at line 464 put($filePath, $contents)

Parameters

at line 480 protected bool saveAllFiles($blockName, string $blockFile, Collection $repeaters, string $blockIdentifier, bool $generateView = false)

Parameters

Return Value

at line 515 BlockMaker setCommand(Command $command)

Parameters

Return Value

at line 525 info($message)

Parameters

at line 535 error($message)

Parameters

at line 37
`__construct(Filesystem $files)`

at line 53
`mixed make($blockName, $baseName, $iconName, bool $generateView = false)`

at line 109
`protected bool checkBlockStub($baseName)`

at line 124
`protected bool checkIconFile($iconName)`

at line 139
`protected bool checkBlockFile($blockFile)`

at line 152
`protected checkBlockBaseFormat($stubFileName)`

at line 167
`protected checkRepeaters($repeaters)`

at line 192
`string|string[]|null makeBlock($blockName, $iconName, $stubFileName = null, null|string $stub = null)`

at line 268
`protected string makeBlockIdentifier($blockName)`

at line 281
`protected string makeBlockPath(string $blockIdentifier, string $type = 'block')`

at line 306
`string makeBlockTitle($string)`

at line 321
`mixed getBlockByName($block, array $sources = [])`

at line 330
`mixed getIconFile($icon, $addExtension = true)`

at line 364
`Collection generateRepeaters($baseName, $blockName, $blockBase)`

at line 421
`array createRepeater($repeaterName, $baseName, $blockName, $blockBase, $blockString)`

at line 464
`put($filePath, $contents)`

at line 480
`protected bool saveAllFiles($blockName, string $blockFile, Collection $repeaters, string $blockIdentifier, bool $generateView = false)`

at line 515
`BlockMaker setCommand(Command $command)`

at line 525
`info($message)`

at line 535
`error($message)`