los / losbase
Library with common classes for Los packages
Installs: 3 856
Dependents: 2
Suggesters: 6
Security: 0
Stars: 5
Watchers: 5
Forks: 1
Open Issues: 2
Requires
- php: >=5.4
- doctrine/doctrine-orm-module: ~0.8
- zendframework/zendframework: >=2.3.2,<3.0.0
Requires (Dev)
- phpunit/phpunit: ~4.4
- satooshi/php-coveralls: dev-master
Suggests
- los/loslog: los/loslog for logging
- los/losui: los/losui for twitter bootstrap 3 styling, jquery, chosen and other libraries
README
Introduction
This module provides some utility classes for ZF2 projects and other LOS modules
Requirements
- PHP 5.4 or greater
- Zend Framework 2 framework.zend.com.
Instalation
Instalation can be done with composer ou manually
Installation with composer
For composer documentation, please refer to getcomposer.org.
-
Enter your project directory
-
Create or edit your
composer.json
file with following contents:{ "minimum-stability": "dev", "require": { "los/losbase": "~2.5" } }
-
Run
php composer.phar install
-
Open
my/project/directory/config/application.config.php
and addLosBase
to yourmodules
Installation without composer
- Clone this module LosBase to your vendor directory
- Enable it in your config/application.config.php like the step 4 in the previous section.
Usage
CRUD
The module provides a console interface for easily creating a CRUD module:
php public/index.php create crud <modulename>
And it will create all necessary files and directories (config, controller, entity and service)
Controller
The AbstractCrudController provides some common operations for simples a CRUD:
- list
- view
- add
- edit
- delete
Doctrine types
- UtcDateTime: converts the datetime to UTC before saving to the database
- BrDateTime: converts the datetime to UTC before saving to the database and to BRST (UTC-3) when loading from database
- BrPrice: handles brazillian price format (1.234,56) for databae operations
Doctrine Entities
- 3 Traits: Id, Created and Updated
- AbstractEntity already using the 3 basic traits above
Module
- AbstractModule providing getAutoloaderConfig and getConfig basic methods
Doctrine Entity Service
- AbstractEntity provides and abstract service class that handles saves and deletes for doctirne entities
- Util: getUserAgent and getIP
- Uuid: static method for UUID creation
Doctirne validators
- NoEntityExists asserts that no entity with the specified field already exists during add operation
- NoOtherEntityExists asserts that no other entity with the specified field already exists during edit operation