dframe / dframe

PHP framework to build web applications, APIs and microservices.

Dframe - PHP Framework

The basic framework to help you build MVC project.

• Requirements
• Installation
• Documentation
• Overview
  • Good Practice
• Extensions
  • Router
  • Session
• License

What's included?

• Class Loader PHP
• Router PHP
• Template PHP
• Cron PHP

Requirements

• PHP >= 8.1
• Rewrite Module (Nginx/Apache )
• Composer

Installation

Framework Core

$ composer require dframe/dframe

Demo skeleton project

$ composer create-project dframe/dframe-demo project_name

License

Open-sourced software licensed under the MIT license

dframe's Issues

Switching between friendly links

Describe the bug
After Switch friendly links can not find route

To Reproduce
Steps to reproduce the behavior:

1. Work localhost/page/index
2. Stop working localhost/index.php?task=page&action=index

no implementation $ttl in cron

no implementation $ttl in cron

Remove Unnecessary fully qualified name

Remove Unnecessary fully qualified name

Add Cron module

Add Cron module

Implement spl_autoload_register in Loader

Implement spl_autoload_register in Loader

setTemplateDir for modules

Add property that can change template directory for modules.

Rename SESSION_NAME

Rename SESSION_NAME to APP_NAME

Annotation Route Config

The possibility of switching on and off Route annotations

Undefined namespace Exception

/src/View.php:12

use Dframe\View\Exception\ViewException;

Should be

use Dframe\View\Exceptions\ViewException;

Fix sugesion Code Smell

Fix suggestion Code Smell

Exception not found

Wrong namespace

View change variables are ignored

View change variables are ignored by reloading

    public function renderInclude($name, $path = null)
    {

        $smartyConfig = Config::load('view/smarty');

Undefined varible $str

src\Asset\Assetic.php
In place where is

fwrite($out, $str);

There is no defined $str should be $msg

Add method for Cron

Supporting methods for cron

Module loader - wrong subnamespace

Module loader wrong read subnamespace.

Change namespace tests

Chanage namespace Dframe\tests to Dframe\Tests

Add Prototype Cli

Add prototype command-line interface support.

Session class constructor should pass the $options

Consider the code snippets in Session class.

class Session
{

    function __construct()
    {
        $name = '_sessionName';
        $options = [];

        $this->name = $name;

        if (!isset($_SESSION)) {
            $cookie = array(
                'lifetime' => isset($options['cookie']['lifetime']) ? $options['cookie']['lifetime'] : 0,
                'path' => isset($options['cookie']['path']) ? $options['cookie']['path'] : '/',
                'domain' => isset($options['cookie']['domain']) ? $options['cookie']['domain'] : null,
                'secure' => isset($options['cookie']['secure']) ? $options['cookie']['secure'] : isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : null,
                'httponly' => isset($options['cookie']['httponly']) ? $options['cookie']['httponly'] : false,
            );
.......

It seems that the $options variable will always be empty array and the ?: operator will be useless.
I think it should be the argument for this constructor.

Remove deprecated method in Token.php

Remove deprecated method in Token.php

    public function getToken($key)
    public function setToken($key, $value)
    public function remove($key)

getFingerprint method Dframe\Session class seems to be problematic

Describe the bug
The getFingerprint has the undefined properties:
$this->ipAddress, $this->userAgent, and $this->name.

Expected behavior
It should define these properties.

Update session __construct

Add $this->app->config as argument

Render JSON - status header

Hi,
Please make header status code, by renderJSON function.
It will be very helpfull.

Thanks

Debug in Header

Add to header debug containing details of executed ajax.

Modules do not update changes

The application does not register changes in the modules in the core loader.

Extend Exception

Expand and add new exceptions.

Add ext-json to composer.json

Add ext-json to composer.json

Notification of an empty variable

Add missing else for sGets

Enhance the View module

The View class is simple view to want to try fixing this.
How about considering the Twig or Blade templates.

Demo isn't working

Hi,
I used this command

$ composer create-project dframe/dframe-demo yourAppName
and demo isn't work for me.

The error:
`
Notice: Use of undefined constant APP_DIR - assumed 'APP_DIR' in D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Config.php on line 22

Fatal error: Uncaught Dframe\BaseException: Not Found Config APP_DIRConfig/router.php in D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Config.php:26 Stack trace: #0 D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Config.php(35): Dframe\Config->__construct('router', NULL) #1 D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Router.php(43): Dframe\Config::load('router') #2 D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Core.php(17): Dframe\Router->__construct() #3 D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\web\index.php(13): Dframe\Core->run() #4 {main} thrown in D:\Programy\Xampp\7_1_9\htdocs\afterrent-api\vendor\dframe\dframe\src\Config.php on line 26`

Incorrect matching of routeCollection

Describe the bug

Issue with matching routeCollection

To Reproduce

We have this routeCollection:

 'routes' => array(
        'documents/:pageId/title' => array(
            'page/[pageId]/title',
            'task=page&action=show&pageId=[pageId]'
        ),

        'documents/:pageId/article/title' => array(
            'page/[pageId]/article/title',
            'task=page&action=show&pageId=[pageId]'
        )
 )

When attemting to enter this route

/page/66/article/title

Regexp parses it as:

[pageId] == 66/article

and detects that we want to enter this route:

        'documents/:pageId/title' => array(
            'page/[pageId]/title',
            'task=page&action=show&pageId=[pageId]'
        )

Expected behavior

Should find this route

        'documents/:pageId/article/title' => array(
            'page/[pageId]/article/title',
            'task=page&action=show&pageId=[pageId]'

Additional info

Currently you can work this around with backslash:

 'routes' => array(
        'documents/:pageId/title' => array(
            'page/[pageId]\/title',
            'task=page&action=show&pageId=[pageId]'
        ),

        'documents/:pageId/article/title' => array(
            'page/[pageId]\/article/title',
            'task=page&action=show&pageId=[pageId]'
        )
 )

Missing PHPDoc Comments

Update Missing PHPDoc Comments

Initialize CONTRIBUTING guide

As title, it should add the CONTRIBUTING guide and let others can contribute this correctly.
Here is the Requirements section I suggest:

Requirements

If the project maintainer has any additional requirements, you will find them listed here.

• PSR-2 Coding Standard - The easiest way to apply the conventions is to install PHP Code Sniffer.

• Add tests! - Your patch won't be accepted if it doesn't have tests.

• Document any change in behaviour - Make sure the README.md and any other relevant documentation are kept up-to-date.

• Consider our release cycle - We try to follow SemVer v2.0.0. Randomly breaking public APIs is not an option.

• One pull request per feature - If you want to do more than one thing, send multiple pull requests.

• Send coherent history - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please squash them before submitting.

Happy coding!

Here is the requirements section reference.

Modules wrong merging router config

Modules Overwrites $this->app->config['router'] config

Exception not found

Fix namespaces Exceptions

Import PSR-2 coding style tool

As title, the PSR-2 coding style I think it's important for every repositories in this org.
And I think we can add the PSR-2 coding style tool to detect the coding style and make these codes consistent. Consider the two coding style tools:

• StyleCI: It's a service that can check coding style automatically when pushing the latest commit.
• PHP_CodeSniffer

It can also add this required item in CONTRIBUTING.md 👍 .

Enhance Token module

When I look at the Token class, this is a very simple to implement the token package.
How about considering the csrf-tokenservice
I think we can try to inherit and integrate this with the original Token class methods.

Replace method dirname()

Replace method dirname to DIR

Replace the array() with []

As title, it's time to use the [] to define the array.
And this feature is supported since php-5.4.
It' also related to this PR.

Uncaught TypeError: Argument

When generating assesses throw

[11-Aug-2018 10:31:56 UTC] PHP Fatal error: Uncaught TypeError: Argument 3 passed to Dframe\Asset\Exceptions\AsseticException::__construct() must be an instance of Exception or null, 4. See error

Undefined smarty config

$smartyConfig is undefined in view

Use the identical comparison operator

Use the identical comparison operator (===) instead of the equal comparison operator (==). PHP has dynamic typing and this is a way to keep things more strict. http://php.net/manual/en/language.operators.comparison.php

PSR-16

Implement SimpleCache PSR-16 for Token class and Messages Class

Replace isset function with ?? in Session class

Consider the $cookie array in Session class constructor:

 $cookie = array(
                'lifetime' => isset($options['cookie']['lifetime']) ? $options['cookie']['lifetime'] : 0,
                'path' => isset($options['cookie']['path']) ? $options['cookie']['path'] : '/',
                'domain' => isset($options['cookie']['domain']) ? $options['cookie']['domain'] : null,
                'secure' => isset($options['cookie']['secure']) ? $options['cookie']['secure'] : isset($_SERVER['HTTPS']) ? $_SERVER['HTTPS'] : null,
                'httponly' => isset($options['cookie']['httponly']) ? $options['cookie']['httponly'] : false,
            );

Since php-7.0, it can use the ?? to let this code be readability 👍 .

 $cookie = array(
                'lifetime' => $options['cookie']['lifetime'] ?? 0,
                'path' => $options['cookie']['path'] ?? '/',
                'domain' => $options['cookie']['domain']?? null,
                'secure' => $options['cookie']['secure'] ?? ($_SERVER['HTTPS'] ?? null),
                'httponly' => $options['cookie']['httponly'] ?? false,
            );

No need for underscores for private methods

No need for underscores for private methods. These are a relic of PHP 4 when there was no method.

Replaces array() with [].

Use [] instead of array(). It is shorthand, looks better, and is the standard way of instantiating new arrays.

Rename SESSION_NAME

Rename SESSION_NAME to APP_NAME

Write method from SimpleCache\CacheInterface in Session.php

Write method from SimpleCache\CacheInterface in Session.php

    public function setMultiple($values, $ttl = null)
    {
        //todo
    }

    public function getMultiple($keys, $default = null)
    {
        //todo
    }

    public function deleteMultiple($keys)
    {
        //todo
    }

No start method initialization

In modules loader method start() it is not initiated

static session name

In session.php is static $name

        $name = '_sessionName';

Should be

        $name = SESSION_NAME ?? '_sessionName';

Add more tests

Add test for

-Loader
-View
-Assets
-Messages
-Session