vitexsoftware/ease-core

An PHP Framework for writing Applications

1.41 2023-10-13 11:56 UTC

Requires

• php: >=7
• composer-runtime-api: *
• ext-intl: *
• pear/mail: >=1.3
• pear/mail_mime: >=1.10

Requires (Dev)

• phpstan/phpstan: *
• phpunit/phpunit: *
• roave/security-advisories: dev-latest

Conflicts

• vitexsoftware/ease-framework: *

MIT

• Vítězslav Dvořák

README

EasePHP Framework Core

Object oriented PHP Framework for easy&fast writing small/middle sized apps.

Installation

Download https://github.com/VitexSoftware/php-ease-core/archive/master.zip or:

Composer:

composer require vitexsoftware/ease-core

Linux

For Debian, Ubuntu & friends please use repo:

sudo apt install lsb-release wget
echo "deb http://repo.vitexsoftware.cz $(lsb_release -sc) main" | sudo tee /etc/apt/sources.list.d/vitexsoftware.list
sudo wget -O /etc/apt/trusted.gpg.d/vitexsoftware.gpg http://repo.vitexsoftware.cz/keyring.gpg
sudo apt update
sudo apt install php-vitexsoftware-ease-core 

You can also install optional packages php-vitexsoftware-ease-core-dev and php-vitexsoftware-ease-core-doc

In this case please add this to your app composer.json:

json "require": { "deb/ease-core": "*" }, "repositories": [ { "type": "path", "url": "/usr/share/php/EaseCore", "options": { "symlink": true } } ]

Docker:

To get Docker image:

docker pull vitexsoftware/ease-core

Framework Constants

• EASE_APPNAME - common name of application. Mainly used in logs. (APP_NAME is also recoginsed)
• EASE_LOGGER - one of memory,console,file,syslog,email,std,eventlog or combination eg. "console|syslog"
• EASE_EMAILTO - recipient email address for Ease/Logger/ToMail
• EASE_SMTP - Custom SMTP Settings (JSON Encoded)
• EASE_FROM - Sent mail sender address
• LOG_DIRECTORY - destination for ToFile logger
• LOG_OPTION - syslog option argument
• LOG_FACILITY - syslog facility argument

Logging

You can use any combination of this logging modules:

• memory - log to array in memory
• console - log to ansi sequence capable console
• file - log to specified file
• syslog - log to linux syslog service
• email - send all messages to constant('EASE_EMAILTO') at end
• std - write messages to stdout/stderr
• eventlog - log to Windows eventlog

  define('EASE_LOGGER', 'console|syslog');
  $logger = new \Ease\Sand();
  $logger->addStatusMessage('Error Message', 'error');

Testing

At first you need initialise create sql user & database with login and password from testing/phinx.yml and initialise testing database by phinx migrate command:

make phpunit

Building

Simply run make deb

Links

Homepage: https://www.vitexsoftware.cz/ease.php

GitHub: https://github.com/VitexSoftware/ease-core

phpDocumentor: http://vitexsoftware.cz/php-ease-core/