Author

PatrissolJuns

https://patrissol-juns.com | Github | E-Mail

About JunsPHP

JunsPHP is a fast, open-source, minimalist web Framework for PHP. It is simply the best choice for simple website and small apps such as portfolio page, landing page and so on.

JunsPHP like others web framework implements MVC architecture and brings out the powerful side of it.

Install JunsPHP

In order to use the framework, just get the zip of the latest version at Github

Then extract it and run with this command:

php -S localhost:8080

You will therefore get the default home page of the framework

How to use JunsPHP

Since JunsPHP is using MVC architecture, the usage is a little bit similar than other framework such as Laravel, Symfony and so on.

This framework use concept like routing, Controller, Model, View and later soon Template Engine.

The Routing

All about routing is found into Routes/routes file.

If you want to and a get request to the controller ThingController and the action index, just add this code into Routes/routes

Router::get('/thing/index', 'ThingController@index');

This will be available at the route /thing/index

This is the same thing for all other method

The Controller

Controllers are found in Controllers folder and their goal is to execute different action.

The syntax is very similar to a normal php file just that it may include Model and other folders.

here is an example of controller file

require(ROOT . 'Models/Thing.php');

class ThingController extends Controller
{
    public function __construct($request)
    {
        parent::__construct($request);
    }
    
    function index()
    {
        $thing = new Thing();
		
		// data to send
        $data['things'] = $thing->findAll();
        
        return View::render("thing/index", $data);
    }
    function create()
    {
        return View::render("thing/create");
    }

    function save()
    {
        if ($this->request->getMethod() == 'POST')
        {
            $thing= new Thing();
			
            $thing->title = $this->request->getParams()['title'];
			
            $thing->description = $this->request->getParams()['description'];
			
            if ($thing->save())
            {
                $this->redirect("thing/index");
            }
        }
    }
}

Note: Here we have defined a constructor in order to be able to access information about request so a controller must have this constructor.

The View

View in this framework are found in Views.

Since we have yet include a template engine, the manipulation of variable is done directly in PHP code.

If you pass a variable from the controller to a view trough a table like this example up so, that variable will be directly accessible form the views.

Still continuous our example of Thing, here is a way to display a list of things:

<h1>Thing</h1>
<div class="row col-md-12 centered">
    <a href='<?php route("/thing/create") ?>'>Create</a>
    <img src='<?php asset("assets/images/home.png") ?>' alt="logo" />
    <table class="table table-striped custab">
        <thead>
        <tr>
            <th>ID</th>
            <th>Name</th>
            <th>Description</th>
        </tr>
        </thead>
        <?php
        foreach ($things as $thing) 
        {
        ?>
            <tr>
            <td><?php print_r($thing['id'])?></td>
            <td><?php echo $thing['title']?></td>
            <td><?php echo $thing['description']?></td>
            </tr>
        <?php
        }
        ?>
    </table>
</div>

Assets files

The assets files can be found into public/assets folder.

However, you can set your own structure within public folder.

The Model

All model is found in the folder Models. Each Modal extends the Model class which provide a sample of method such as:

// findModel($ModelName, $id);

// Example:
findModel("Thing", $id);

which will retrieve a particular model passed in parameter.

This is an example of a Model

class Thing extends Model
{
    public $title;
    public $description;
    
    public function find($id){
        return $this->findModel("Thing", $id);
    }
    public function findAll(){
        return $this->findModelAll("Thing");
    }
    public function save()
    {
        return $this->saveModel("thing", ['title', 'description'], [$this->title, $this->description]);
    }
}

Note: please open this file Core/Model to get all the available methods.

DATABASE Connection

All the configuration about the database is inside Config/Database file.

You just need to change the database credentials in order to match your own.

Contributing

I will be very happy if you can contribute for this framework in order to built a more powerful framework.

Do not hesitate to contact me at my email [email protected].

License

JunsPHP is a open source project under the MIT license.