README

Getting started

composer create-project strukt/strukt:1.1.5-alpha --prefer-dist

Listing console commands:

./xcli -l

Generate Application

./xcli app:make payroll

The file structure generated should look as below:

app
└── src
    └── Payroll
        ├── AuthModule
        │   ├── Controller
        │   │   └── User.php
        │   ├── Form
        │   │   └── User.php
        │   ├── PayrollAuthModule.php
        │   ├── Router
        │   │   ├── Auth.php
        │   │   └── Index.php
        │   └── Tests
        │       └── UserTest.php
        └── User.php

There is a default module i.e AuthModule when you generate an application. Folders generate in a module can be changed in cfg/module.ini this also indicates part of alias used to access classes/objects. You'll also find a config file cfg/app.ini that holds the active applications name.

When an application or module is created/generated they are loaded by running the command below, otherwise strukt won't detect them:

./xcli app:reload

The above command will create a App/Loader.php in the lib/ folder at the root of your project. This file should NEVER be edited because everything will be overwritten once the above command is run.

Generate Module

Command syntax for generating a module:

./xcli make:module <app_name> <module_name> <module_alias>

Example command:

./xcli make:module payroll human_resource hr

Now the file structure should look as below:

app/
└── src
    └── Payroll
        ├── AuthModule
        └── HumanResourceModule

Remember to run the make:reload command to load the module.

Execute Shell

strukt-strukt uses psysh.

$ ./xcli shell:exec
>>> ls
Variables: $core, $reg
>>> $core->get("au.ctr.User")->getAll()
=> "AuthModule\Controller\User::getAll Not Yet Implemented!"
>>> $core->get("User")
=> Payroll\User {#...

Cli

View middlewares and providers

View console middlewares.

./xcli sys:ls middlewares

View index.php middlewares

./xcli sys:ls middlewares --idx

You can also view providers by replacing middlewares

Cli Utility

Enable and disable commands , middlewares and providers

Example:

./xcli sys:util enable commands pub-make

Run Application

./xcli app:exec

Uses .env server_{var} to run application.

Notes

The make:router and make:module commands will not appear on cli console until you run app:make and app:reload commands firstly and respectively.

IMPORTANT: The folder .tpl/ in the root of the project contains sgf/ folder that has class template files used to generate the application its modules and migrations. Ensure to not change it until you've understood strukt-generator

Have a good one!

strukt / strukt

Maintainers

Details