Download the PHP package eftec/dashone without Composer

DashOne

A minimalist dashboard /backend library for PHP

This library allows to create a fast dashboard with the basic features without any template and only using code. In the examples, we create a page for a dashboard in less than 80 lines of code ( examples/test.php )

[]() []() []() []() []()

Example ( examples/test.php ):

Another example ( examples/test.php ):

Getting started

Install via composer

composer require eftec/dashone

Create a new object DashOne (you will need to add the required include, via autoload.php or manually)

$dash=new DashOne();

And you could render a page using the object of the class DashOne()

Classes

DashOne

It is the main class that generates the dashboard.

$dash=new DashOne();

It is possible to add new elements using fluent interface (chain methods each one).

Example: It renders an empty page

Example using fluent

Where the method head is required to render the < head > of the page.

The footer is also required to close all the tags.

And every chain of methods must end with the method render() (it draw the page).

Method DashOne->head($title,$extrahtml)

It renders the head of the page. This element is required

$dash->head('Example - test 1');

Method DashOne->menuUpper($leftControls=[],$rightControls=[])

It renders the upper menu of the dashboard.

$dash->menuUpper([new ImageOne('https://via.placeholder.com/32x32')," - ",new LinkOne('Cocacola','#')]);

AlertOne

It renders an alert

new AlertOne($title,$content,$class);

Example:

ButtonOne

It renders a button

new ButtonOne('button1','Click me','btn btn-primary');

You could use the method buttons (DashOne) to render a button (or buttons). The method has a second argument to determine if the buttons must be aligned or not with the form.

$dash->buttons($buttons,true)

$dash->buttons($buttons,false)

ContainerOne

It renders a container where it is possible to add other elements (such as buttons)

new ContainerOne($html);

Example:

The method container() but be followed by a visual method. This method is added inside the container (where it says %control)

Another example:

FormOne

It renders a form. It requires a declarative array.

If it sets a definition, then it uses the definition to define the types of input objects (textbox,textarea,etc.)

If a field of the definition has an array then it is used to render a dropdownitem

If it doesn't have a definition then, it uses the values to define the types of input objects (textboxes,textareas,etc.)

You could also render a message (for example for warning or information) You could draw a form using an associative array. By default, every field will be a textbox

Or you could explicit the type of field

UlOne

It draws a list (unsorted list)

ImageOne

It draws a image

new ImageOne('https://via.placeholder.com/32x32');

LinkOne

It draws a hyperlink

The first value is the name of the link, the second is the address. And the third value (optional), it's a icon (using the classes of Font-Awesome)

new LinkOne('Cocacola','#','far fa-star') $dash->link('Cocacola','#','far fa-star')

TableOne

it renders a table.

A basic page :

Any pages requires at least to call the head(), footer() and Render().

Render() draws the page so it must be called at the end of the chain.

For example, a basic page is as follow:

An empty dashboard:

Login Page

examples/testlogin.php

The library has a build-in login page that it relies on PHP's session variable.

To use a the function, the session must be enabled

And we could read the current session as follow:

Step 1 Initialize Login Page

To create a login page, you must initialize in the constructor as follow

Using an array (user and password)

Or using a method

Step 2 Fetch values

Step 3 Redirect if the user has sign-in correctly

Step 4 Display Login Screen

Step 5 Log out

The validation of the user is keep in the session. So to close a session we could destroy the session or unsetting the session.

Step 6 CSRF protection (optional)

It is possible to add an extra layer of protection by adding the next line

Step 7 Validating the session

It is possible to validate the session

Version

• 1.7 2020-04-23
  • Added .gitattribute Examples and doc are not pushed via composer (it should reduce the size)
• 1.6.2 2020-04-23
  • Fix: cleanups.
• 1.6.1 2020-03-03
  • Fix: TableOne now allows non-base zero array
• 1.6 2020-18-01
  • modified LinkOne::LinkOne()
  • added summernote to textarea
• 1.5 2020-16-01
  • new method getLogin()
  • new method logout()
• 1.4 2020-16-01
  • new method cssLogin()
  • new method login()
  • new method fetchLogin()
  • new method decrypt()
  • new method encrypt()
  • new field var $salt='';
  • new field $validateLogin (callable)
  • changes to __construct()
• 1.3 2020-01-15 new method fetchvalue()
• 1.2 2019-03-30 New changes.
• 1.1 2019-03-17 Fixed some bugs
• 1.0 2019-03-01 First Version.

Copyright

Copyright Jorge Patricio Castro Castillo Dual License (LGPL v3 and Commercial License)

You could use in commercial / close source product or service while

In a nutshell (it is the license):

• You must keep the copyright notices.
• If you modify the library then you must share the changes and modifications.