Maslosoft Signals API

Name: Signals
Brand: Maslosoft

Class Signal

Main signals components

Maslosoft\Signals\Signal implements Psr\Log\LoggerAwareInterface

Namespace: Maslosoft\Signals
Author: Piotr
Located at Signal.php

Methods summary

`public`	# `__construct( $configName = self::ConfigName )`
`public mixed`	# `__get( string $name )` Getter Getter Parameters `$name` Returns mixed
`public mixed`	# `__set( string $name, mixed $value )` Setter Setter Parameters `$name` `$value` Returns mixed
`public string`	# `getVersion( )` Get current signals version Get current signals version Returns string Codecoverageignore
`public`	# `init( )`
`public Maslosoft\Signals\Signal`	# `filter( Maslosoft\Signals\Interfaces\FilterInterface\|string\|mixed $filter )` Apply filter to current emit. Apply filter to current emit. Pass false as param to disable all filters. Parameters `$filter` Returns `Maslosoft\Signals\Signal` Throws UnexpectedValueException
`public object[]`	# `emit( object\|string $signal )` Emit signal to inform slots Emit signal to inform slots Parameters `$signal` Returns object[]
`public`	# `gather( object $slot, string $interface = null )` Call for signals from slot Call for signals from slot Parameters `$slot` `$interface` Interface or class name which must be implemented, instanceof or sub class of to get into slot
`public Maslosoft\Signals\Interfaces\PreFilterInterface[]\|Maslosoft\Signals\Interfaces\PostFilterInterface[]`	# `getFilters( string $interface )` Get filters Get filters Parameters `$interface` Returns `Maslosoft\Signals\Interfaces\PreFilterInterface[]`\|`Maslosoft\Signals\Interfaces\PostFilterInterface[]`
`public Psr\Log\LoggerInterface`	# `getLogger( )` Get logger Get logger Returns Psr\Log\LoggerInterface Codecoverageignore
`public Maslosoft\Signals\Signal`	# `setLogger( Psr\Log\LoggerInterface $logger )` Set logger Set logger Parameters `$logger` Returns `Maslosoft\Signals\Signal` Codecoverageignore
`public Maslosoft\EmbeDi\EmbeDi`	# `getDi( )` Get dependency injection container Get dependency injection container Returns Maslosoft\EmbeDi\EmbeDi
`public`	# `setDi( Maslosoft\EmbeDi\EmbeDi $di )`
`public Maslosoft\Signals\Interfaces\BuilderIOInterface`	# `getIO( )` Get Input/Output adapter Get Input/Output adapter Returns `Maslosoft\Signals\Interfaces\BuilderIOInterface` I/O Adapter Codecoverageignore
`public Maslosoft\Signals\Signal`	# `setIO( Maslosoft\Signals\Interfaces\BuilderIOInterface $io )` Set Input/Output interface Set Input/Output interface Parameters `$io` Returns `Maslosoft\Signals\Signal` Codecoverageignore
`public Maslosoft\Signals\Interfaces\ExtractorInterface`	# `getExtractor( )` Returns `Maslosoft\Signals\Interfaces\ExtractorInterface` Codecoverageignore
`public Maslosoft\Signals\Signal`	# `setExtractor( Maslosoft\Signals\Interfaces\ExtractorInterface $extractor )` Parameters `$extractor` Returns `Maslosoft\Signals\Signal` Codecoverageignore
`public`	# `resetCache( )` Reloads signals cache and reinitializes component. Reloads signals cache and reinitializes component.

Constants summary

`string`	`Slots`	# `'slots'`
`string`	`Signals`	# `'signals'`
`string`	`ConfigName` Config file name Config file name	# `"signals"`

Properties summary

`public string`	`$runtimePath` Runtime path is directory where config cache from yml file will be stored. Path is relative to project root. This must be writable by command line user. Runtime path is directory where config cache from yml file will be stored. Path is relative to project root. This must be writable by command line user.	# `'runtime'`
`public string[]`	`$paths` This paths will be searched for `SlotFor` and `SignalFor` annotations. This paths will be searched for `SlotFor` and `SignalFor` annotations. TODO Autodetect based on composer autoload	# `[ 'vendor', ]`
`public string[]`	`$ignoreDirs` Directories to ignore while scanning Directories to ignore while scanning	# `[ 'vendor', // Vendors in vendors 'generated', // Generated data, including signals 'runtime', // Runtime data ]`
`public string[]\|object[]`	`$filters` Filters configuration. This filters will be applied to every emit. This property should contain array of class names implementing filters. Filters configuration. This filters will be applied to every emit. This property should contain array of class names implementing filters.	# `[]`
`public string[]\|object[]`	`$sorters` Sorters configuration. Sorters configuration.	# `[]`
`public string\|[]\|object`	`$extractor` Extractor configuration Extractor configuration	# `Maslosoft\Signals\Addendum::class`
`public string\|[]\|object`	`$io` Input/Output configuration, at minimum it should contain class name for builder input output interface. It can also contain array configurable options for IO class. Input/Output configuration, at minimum it should contain class name for builder input output interface. It can also contain array configurable options for IO class.	# `Maslosoft\Signals\PhpFile::class`

Magic properties

`public Psr\Log\LoggerInterface`	`$logger` Logger, set this to log warnings, notices errors. This is shorthand for `get/setLogger`.

API documentation generated by ApiGen

Maslosoft Signals API

Namespaces

Classes

Interfaces

Class Signal

Methods summary

Parameters

Returns

Parameters

Returns

Returns

Codecoverageignore

Parameters

Returns

Throws

Parameters

Returns

Parameters

Parameters

Returns

Returns

Codecoverageignore

Parameters

Returns

Codecoverageignore

Returns

Returns

Codecoverageignore

Parameters

Returns

Codecoverageignore

Returns

Codecoverageignore

Parameters

Returns

Codecoverageignore

Constants summary

Properties summary

Magic properties

Contact us