Skip to content

Latest commit

 

History

History
65 lines (48 loc) · 3.52 KB

quick-startup.md

File metadata and controls

65 lines (48 loc) · 3.52 KB
Raw

#Teknoo Software - States library - Quick Startup

##Presentation

###Requirements This library works with PHP 7 and newer. It does not require external library except a Composer.

##Write your first stated class All following instructions are illustrated in the demo available in the folder demo at the root of this library.

###Load the library To load the library, you can include the file bootstrap.php located in the folder /src/Teknoo/States of this library. It does it :

  • This bootstrap file instantiate the library.
  • Creates the service to build a new finder (object to locate files of each stated class).
  • Find the Composer instance
  • Instantiates a new loader instance with the composer instance.
  • Registers the loader in the stack __autoload.

###Prepare folders The files of your stated classes must be placed into folder called with the same name as the stated class. A subfolder, called States must be added in these folders. It will welcome states files.

###Create factory The factory is a mandatory file. It used by the loader to determine the stated class and load it. The factory must be defined in the file Factory.php. The factory class must be called Factory (independently of the stated class's name) and must implement the interface \Teknoo\States\Factory\FactoryInterface.

To help you, your factory class can extend the embedded factories \Teknoo\States\Factory\Integrated or \Teknoo\States\Factory\Standard.

###Create states and the default state The states must be declared in separate files. A state is represented by PHP class and must implement the interface \Teknoo\States\State\StateInterface. To help you, you can use the trait \Teknoo\States\State\StateTrait or directly extend the class \Teknoo\States\State\AbstractState.

Each stated class must have at least one state and this state must be called StateDefault. It is the default state enabled in the constructor of each stated class instance.

###Create the proxy You can define it in the file <StatedClassName>.php. The proxy class must be called with the same name as the stated class and must implement the interface \Teknoo\States\Proxy\ProxyInterface.

To help you, you can use the trait \Teknoo\States\Proxy\ProxyTrait or directly extend one of these implementations : \Teknoo\States\Proxy\Standard or \Teknoo\States\Proxy\Integrated. Warning, if you use the factory \Teknoo\States\Factory\Integrated, you must extend the proxy Integrated, else, you must extend the proxy Standard.

The trait proxy is already compliant with standard interfaces \Serializable, \ArrayAccess, \SeekableIterator, \Countable and magic methods. But theirs are not implemented in proxy's implementation.

To enable them, you must implement these interface, according to your needs, and add traits (available in \Teknoo\States\Proxy*) in your proxy

###Enjoy Now, you can use your stated class. If you use the integrated proxy, you can directly instantiate your objects with the operator new like this $myObject = new \Your\NameSpace\YourStateName();.

It is not needed to call the directly the proxy class like this $myObject = new \Your\NameSpace\YourStateName\YourStateName();, you can directly use the stated class name. The factory has created an alias from \Your\NameSpace\YourStateName to \Your\NameSpace\YourStateName\Your\NameSpace\YourStateName

###CLI Helper A CLI helper is available at /bin/console.php to create easily new stated class (standard or integrated), create new state, and extract state information from your stated class.