2017 © Pedro PelĂĄez
 

library project-base-bundle

Bundle with base code for projects

image

skwi/project-base-bundle

Bundle with base code for projects

  • Tuesday, June 19, 2018
  • by skwi
  • Repository
  • 1 Watchers
  • 0 Stars
  • 1,914 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 0 Forks
  • 0 Open issues
  • 12 Versions
  • 5 % Grown

The README.md

Deprecated Alert

This bundle is not maintained anylonger because it violates several SOLID principles., (*1)

SkwiProjectBaseBundle

Build Status, (*2)

This is a bundle with some basic code I often use in my projects. Feel free to use it or enhance it., (*3)

Compatibility

The current version of the bundle is only compatible with Symfony 2.5+ Version 1.0 provides compatibility with older versions of Symfony, (*4)

Setup

Install SkwiProjectBaseBundle

Simply run assuming you have installed composer (composer.phar or composer binary) :, (*5)

``` bash php composer.phar require skwi/project-base-bundle "dev-master", (*6)


### Configuration

Register the bundle in `app/AppKernel.php`:

``` php
// app/AppKernel.php
public function registerBundles()
{
    return array(
        // ...
        new \Skwi\Bundle\ProjectBaseBundle\SkwiProjectBaseBundle(),
    );
}

In your app/config.yml file, you may need to set up several parameters, (*7)

``` yaml skwi_project_base: entity_bundle_name: FooBarBundle # Default bundle when extending BaseManager (see below) entity_bundle_namespace: \Foo\Bundle\BarBundle # Default bundle namespace password_encoder: sha512 # Password encoder method pager_max_per_page: 10 # Default max items per page when using paginator in the BaseManager kernel_root_dir: %kernel.root_dir%, (*8)


## Usage

### Base Manager

This abstract class provides methods for object managed by Doctrine ORM or Doctrine ODM and MongoDb.

#### Philosophy

The idea is to extends this class to manage a specific entity. Other entities can be managed by an single manager but the `$objectName` and `$repository` property will be used for a default managed entity.

#### Project setup

It's recommended for a manager extend the class and to be injected as a service.

```yaml
# service.yml
mybundle.manager.poney :
        class  : 'Foo\\Bundle\\BarBundle\\Manager\\PoneyManager'
        parent : skwi.projectbase.base_manager
        calls  :
            - [setObjectManager, [@doctrine.orm.entity_manager]]
            - [setObject, ['FooBarBundle:Poney']]

<?php

namespace Foo\Bundle\BarBundle\Manager;

use Skwi\Bundle\ProjectBaseBundle\Manager;

class PoneyManager extends BaseManager
{
    #...
}

Methods

The method provided by the base manager are described in the class API documentation., (*9)

Password encoder

The password encoder class provides an implementation of Symfony's PasswordEncoderInterface using the algorithm defined in the app/config.yml file, (*10)

It's available as a service in the container., (*11)

``` php $encoder = $this->getContainer()->get('skwi.projectbase.password_encoder'); $encodedPassword = $encoder->encodePassword($rawPassword, $salt); $isPasswordValid = $encoder->isPasswordValid($encodedPassword, $rawPassword, $salt);, (*12)


### Text helper

The text helper is a static class.

``` php
# Slug a string
$sluggedString = TextHelper::slug($rawString);

Note : The slug method is quite basic at the moment, it might be enhance in a future update. Make sure to use 1.* version for compatibility., (*13)

Base view

A base twig view is provided y the bundle., (*14)

``` twig {% extends 'SkwiProjectBaseBundle::base.html.twig' %}, (*15)


It loads the libraries for :

- [Twitter Bootstrap 3](http://getbootstrap.com/)
- [jQuery 1.10](http://jquery.com/)

> **Note :** The libraries are loaded form the CDN, with a local fallback for IE version inferior to IE9.

#### Form templates

The bundle also provide preset form templates for Bootstrap 3.

```twig
{% form_theme form 'SkwiProjectBaseBundle:Form:fields.html.twig' %}
{# or #}
{% form_theme form 'SkwiProjectBaseBundle:Form:fields-horizontal.html.twig' %}

Twig extensions

TextExtension

The TextExtension provides the following Twig filters, (*16)

{{ string|slug # will slug the string using the bundle's TextHelper }} 
{{ string|striptags # will apply the strip_tags php method to the string }}

Testing

Unit tests are written using atoum. You will get atoum, among other dependencies, when running composer install. To run tests, you will need to run the following command :, (*17)

``` sh vendor/bin/atoum, (*18)


## API Documentation

API documentation is generated with [PHPDoc](http://www.phpdoc.org/) and [phpdoc-md](https://github.com/evert/phpdoc-md)

To generate it, you will need to run the following commands :

``` sh
vendor/bin/phpdoc -d src/ -t src/Skwi/Bundle/ProjectBaseBundle/Resources/doc/ --template="xml"
vendor/bin/phpdocmd src/Skwi/Bundle/ProjectBaseBundle/Resources/doc/structure.xml src/Skwi/Bundle/ProjectBaseBundle/Resources/doc

ToDo

  • Remove or enhance the data format helper
  • Enhance the slug method in text helper
  • Remove twig encoder extension not very usefull
  • See with last version of PHP for password encoding
  • Update to symfony 2.5 with the property accessor

Known issues

Versioning

As of version 2.0.0, version tags are formated in a semantic way :, (*19)

MAJOR.MINOR.PATCH., (*20)

  • MAJOR version for incompatible API changes, likely breaking backward compatibility ;
  • MINOR version for new functionality (backwards-compatible) ;
  • PATCH version for backward compatible bug fixes.

The Versions

19/06 2018

dev-master

9999999-dev http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

19/06 2018

2.5

2.5.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

15/02 2018

2.4.2

2.4.2.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

20/12 2017

2.2

2.2.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

20/12 2017

2.4.1

2.4.1.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

25/11 2015

2.4

2.4.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

03/04 2015

2.3

2.3.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

08/01 2015

2.1

2.1.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

17/11 2014

dev-fix-isnew

dev-fix-isnew http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

27/10 2014

2.0.1

2.0.1.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

05/10 2014

2.0.0

2.0.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

The Development Requires

by CĂ©dric Spalvieri

bundle base

14/02 2014

1.0

1.0.0.0 http://github.com/skwi/SkwiProjectBaseBundle

Bundle with base code for projects

  Sources   Download

MIT

The Requires

 

by CĂ©dric Spalvieri

bundle base