What is the Data Jukebox Bundle ?

The Data Jukebox Bundle is a PHP/Symfony bundle which aims to provide - for common CRUD (Create-Read-Update-Delete) operations - the same level of abstraction that Symfony does for forms.

By defining and associating so-called Properties to standard ORM (Object Relation Mapper) Entities, one can generate fully-featured list and detail views for those entities, as easily as one generates forms.

The same Properties are used to generate Symfony forms even easier, by automating the form building process.

Developpers can thus concentrate entirely on the data model and have all views build automatically, with just a few lines in the corresponding controllers.

Specifications

Licensing

The Data Jukebox Bundle is distributed under the GNU General Public Licence (GPL) Version 3. The PHP Data Jukebox Bundle includes all resources which contain the mention Data Jukebox Bundle in their documentation and licensing preamble.

Other Open Source resources may come bundled with teh Data Jukebox Bundle release packaging; they are (and must be) used according to their original licence (look for copyright-related files in the folder hierarchy).

Downloading

download tree...

Build

NOTE: By "build", we mean create the necessary tarballs/package required for installation (according to the Installation section below) or distribution.

$ git clone https://github.com/idiap/symfony-bundle-datajukebox

$ tar -xjf symfony-bundle-datajukebox-source-1.0.20150909.tar.bz2
$ cd symfony-bundle-datajukebox-1.0.20150909

$ ./debian/rules build-source-tarball
$ ls -al ../symfony-bundle-datajukebox-source-1.0.20150909.tar.bz2

$ ./debian/rules build-install-tarball
$ ls -al ../symfony-bundle-datajukebox-1.0.20150909.tar.bz2

$ ./debian/rules build-doc-tarball
$ ls -al ../symfony-bundle-datajukebox-doc-1.0.20150909.tar.bz2

$ debuild -us -uc -b
$ ls -al ../symfony-bundle-datajukebox_1.0.20150909_all.deb ../symfony-bundle-datajukebox-doc_1.0.20150909_all.deb

$ debuild -I'.git*' -us -uc -S
$ ls -al ../symfony-bundle-datajukebox_1.0.20150909.dsc ../symfony-bundle-datajukebox_1.0.20150909.tar.gz

$ ./debian/rules release

Installation

WARNING: The Data Jukebox Bundle is actively maintained on Linux. It has not been tested on other platforms.

NOTE: We assume a previously working PHP/Symfony setup.

$ INSTALL_DIR='<installation-directory>'
$ cd "${INSTALL_DIR}"
$ tar -xjf symfony-bundle-datajukebox-1.0.20150909.tar.bz2

$ dpkg -i symfony-bundle-datajukebox_1.0.20150909_all.deb

$ DOC_DIR='<documentation-directory>'
$ cd "${DOC_DIR}"
$ tar -xjf symfony-bundle-datajukebox-doc-1.0.20150909.tar.bz2

$ dpkg -i symfony-bundle-datajukebox-doc_1.0.20150909_all.deb

$ DOC_DIR='<documentation-directory>'
$ pear install -o PhpDocumentor
$ tar -xjf symfony-bundle-datajukebox-source-1.0.20150909.tar.bz2
$ cd symfony-bundle-datajukebox-1.0.20150909
$ ./doc/util/makedoc DataJukeboxBundle "PHP/Symfony Data Jukebox Bundle" "${DOC_DIR}" src doc/phpdoc

Usage

The Data Jukebox Bundle integrates Symfony the same way as any other bundle. Thus, make sure to:

$ ./app/console assets:install --symlink --relative <web-directory>

$ ./app/console assetic:dump <web-directory>

Also refer to the Data Jukebox Tutorial (and Bundle) for detailed explanations on how to use the Data Jukebox Bundle and unleash its full power.

Further documentation

The full documentation of the Data Jukebox Bundle (including source code) is part of this (phpDocumentor-generated) HTML documentation; make sure to browse through the expandable tree located on the left of this text, as well as switch the documentation context using the drop list located on top of this text.