Docker, call to action buttons for specific callback, transform column with image url for image, transform column with video url for html video player, change app name easily, add menu external links, force field for foreign-key mapping, introduction text in listing page

.dockerignore

@@ -0,0 +1,2 @@
+.git
+.idea

.gitignore

@@ -1,2 +1,4 @@
+.idea
 vendor/
 composer.lock
+config.php

Dockerfile

@@ -0,0 +1,11 @@
+#vim:set ft=dockerfile:
+FROM jnmik/docker-centos7-httpd-utilities-php5.6:latest
+MAINTAINER Jean-Michael Cyr <[email protected]>
+ADD . /var/www/html
+WORKDIR /var/www/html
+COPY ./apache.conf /etc/httpd/conf.d/apache.conf
+
+# Install composer
+RUN bash -c "wget http://getcomposer.org/composer.phar && php composer.phar install"
+
+CMD ["/bin/bash", "/var/www/html/boot-init.sh"]

README.md

@@ -16,6 +16,20 @@ It has been programmed with the Silex framework, so the resulting code is PHP.
 Installation
 ------------
 
+Here's examples how to use this project with docker
+
+    docker run -p <port-you-want>:80 -v /path/to/local/config.php:/var/www/html/config.php <image-id>
+
+    or with docker compose
+
+    project-name:
+      image: jnmik/crud-admin-generator:0.0.1
+      ports:
+      - <port-you-want>:80
+      volumes:
+      - /path/to/local/config.php:/var/www/html/config.php
+
+
 Clone the repository
 
     git clone https://github.com/jonseg/crud-admin-generator.git admingenerator
@@ -30,6 +44,10 @@ Install vendors:
 
     php composer.phar install
 
+Prepare your environment configs:
+
+    cp -f config.php.dist config.php
+
 You need point the document root of your virtual host to /path_to/admingenerator/web
 
 This is an example of VirtualHost:
@@ -57,7 +75,7 @@ You can customize the url using the .htaccess file, maybe this will help you:
 Generate CRUD backend
 ---------------------
 
-Edit the file /path_to/admingenerator/src/app.php and set your database conection data:
+Edit the file config.php and set your database connection data:
 
     $app->register(new Silex\Provider\DoctrineServiceProvider(), array(
         'dbs.options' => array(
@@ -83,6 +101,58 @@ For the url of your project, for example:
 
     $app['asset_path'] = 'http://domain.com/crudadmin/resources';
 
+There is also more optional customization you can do
+
+    // determine image path for image fields in database
+    // I.E field value would be image.jpg, result would be <img src="http://somepath/dist/images/image.jpg" />
+    $app['image_fields'] = array(
+        //'table_name.field_name' => 'http://somepath/dist/images/',
+    );
+
+    // If the automapping of foreign key for drop down list does not the job, you can
+    // force a mapping here
+    $app['foreign_key_mapping'] = array(
+        //'main_table_name.main_table_field' => 'foreign_table_name.foreign_table_field'
+    );
+
+    // Allow user to add additional menu links
+    $app['menu_links'] = array(
+        //['name' => 'MENU NAME', 'url' => 'http://menu-url.com', 'fa-icon' => ''],
+    );
+
+    // Allow user to transform column with video url to player
+    $app['video_fields'] = array(
+        //'your_table_name.your_column' => '',
+    );
+
+    // add introduction text on list page
+    $app['table_intro'] = array(
+      //'your_table_name' => "some text"
+    );
+
+    // Allow user to add additional buttons in the action menu, to call external APIs
+    $app['call_to_action'] = array(
+      'synonyms' => array(
+          0 => array(
+              'btn_name' => 'btn name 1',
+              'method' => 'put',
+              'url' => 'http://some-url/1.0/route/{id}',
+              'data'=> json_encode(array(
+                  'param' => value
+              )),
+              'callback' => 'refresh'
+          ),
+          1 => array(
+              'btn_name' => 'btn name 2',
+              'method' => 'post',
+              'url' => 'http://some-url/1.0/route/{id}',
+              'data'=> json_encode(array(
+                  'param' => value
+              )),
+              'callback' => 'refresh'
+          )
+      )
+    );
 
 Now, execute the command that will generate the CRUD backend:
 
@@ -98,6 +168,8 @@ Customize the result
 --------------------
 
 The generated code is fully configurable and editable, you just have to edit the corresponding files.
+However, this approach is not recommended. Doing so will prevent you from re-generating the admin, which might
+be necessary in case you are doing changes to the database structure.
 
  - The **controller** you can find it in **/web/controllers/TABLE_NAME/index.php**
  - The **views** are in **/web/views/TABLE_NAME**
@@ -125,5 +197,9 @@ Author
 * Twitter: *[@jonseg](https://twitter.com/jonseg)*
 * CRUD Admin Generator webpage: [http://crud-admin-generator.com](http://crud-admin-generator.com)
 
+Contributors
+------------
+* Jean-Michael Cyr
+
 
   [1]: http://crud-admin-generator.com

apache.conf

@@ -0,0 +1,16 @@
+<VirtualHost *:80>
+
+  ServerName _
+  DocumentRoot /var/www/html/web
+
+  <Directory /var/www/html/web>
+      Options Indexes FollowSymLinks MultiViews
+      AllowOverride All
+      Order deny,allow
+      Allow from all
+  </Directory>
+
+  #ErrorLog ${APACHE_LOG_DIR}/error.log
+  #CustomLog ${APACHE_LOG_DIR}/access.log combined
+
+</VirtualHost>

boot-init.sh

@@ -0,0 +1,7 @@
+!#/bin/bash
+
+echo "Generate admin based on current mysql schema ... "
+php console generate:admin
+
+echo "Start supervisord ... "
+/usr/bin/supervisord -n -c /etc/supervisord.conf

config.php.dist

@@ -0,0 +1,75 @@
+<?php
+$app->register(new Silex\Provider\DoctrineServiceProvider(), array(
+
+		'dbs.options' => array(
+			'db' => array(
+				'driver'   => 'pdo_mysql',
+				'dbname'   => 'DATABASE_NAME',
+				'host'     => '127.0.0.1',
+				'user'     => 'DATABASE_USER',
+				'password' => 'DATABASE_PASS',
+				'charset'  => 'utf8',
+			),
+		)
+));
+
+$app['asset_path'] = '/resources';
+
+$app['application_name'] = 'Admin Generator';
+
+// determine image path for image fields in database
+// I.E field value would be image.jpg, result would be <img src="http://somepath/dist/images/image.jpg" />
+$app['image_fields'] = array(
+    //'table_name.field_name' => 'http://somepath/dist/images/',
+);
+
+// If the automapping of foreign key for drop down list does not the job, you can
+// force a mapping here
+$app['foreign_key_mapping'] = array(
+    //'main_table_name.main_table_field' => 'foreign_table_name.foreign_table_field'
+);
+
+// Allow user to add additional menu links
+$app['menu_links'] = array(
+    //['name' => 'MENU NAME', 'url' => 'http://menu-url.com', 'fa-icon' => ''],
+);
+
+// Allow user to transform column with video url to player
+$app['video_fields'] = array(
+    //'your_table_name.your_column' => '',
+);
+
+// add introduction text on list page
+$app['table_intro'] = array(
+  //'your_table_name' => "some text"
+);
+
+$app['debug'] = true;
+	// array of REGEX column name to display for foreigner key insted of ID
+	// default used :'name','title','e?mail','username'
+$app['usr_search_names_foreigner_key'] = array();
+
+$app['call_to_action'] = array(
+/*
+  'synonyms' => array(
+      0 => array(
+          'btn_name' => 'btn name 1',
+          'method' => 'put',
+          'url' => 'http://some-url/1.0/route/{id}',
+          'data'=> json_encode(array(
+              'param' => value
+          )),
+          'callback' => 'refresh'
+      ),
+      1 => array(
+          'btn_name' => 'btn name 2',
+          'method' => 'post',
+          'url' => 'http://some-url/1.0/route/{id}',
+          'data'=> json_encode(array(
+              'param' => value
+          )),
+          'callback' => 'refresh'
+      )
+  )
+  */
+);

console

@@ -14,6 +14,7 @@
 require_once __DIR__.'/vendor/autoload.php';
 
 $app = require __DIR__.'/src/app.php';
+require_once(__DIR__.'/config.php');
 $console = require __DIR__.'/src/console.php';
 $console->run();
 

docker/build-docker-image.sh

@@ -0,0 +1,61 @@
+#!/bin/bash
+name=jnmik/crud-admin-generator
+
+version=
+while [ -z $version ]; do
+  printf "\e[1;46mEnter the tag of your image:\e[0m ";
+  read -r version;
+done
+
+branch=$(git branch | grep '*')
+echo -e "you are building an image from the following branch of your project : \e[1;41m${branch:2}\e[0m"
+echo -e "your image will be \e[1;41m$name:$version\e[0m"
+echo -e "do you want to continue? [Y/n]"
+read accept
+
+if [ "$accept" != "Y" ]; then
+  echo -e "\e[0;41mprocess aborted by user!\e[0m";
+  exit 1;
+fi
+
+echo -e "\e[1;30;43m-- Starting to build docker image --\e[0m"
+docker build -t $name:$version .
+
+if [ $? -ne 0 ];
+  then
+    echo -e "\e[0;41mTask build docker image failed and return an non 0 code. Abort!\e[0m";
+    exit 4;
+  else
+    echo -e "\e[0;42mTask build docker image successfully executed\e[0m"
+fi
+
+echo -e "Do you want to push the new image to the repository? [Y/n]"
+read push
+
+if [ "$push" != "Y" ]; then
+  echo -e "\e[0;42mDocker image will not be push. Use can use it localy! Process over.\e[0m";
+  exit 5;
+fi
+
+echo -e "\e[1;30;43m-- Starting to push image to docker hub --\e[0m"
+docker push $name:$version
+
+if [ $? -ne 0 ];
+  then
+    echo -e "\e[0;41mTask push docker image failed and return an non 0 code. Abort!\e[0m";
+    exit 6;
+  else
+    echo -e "\e[0;42mTask psuh docker image successfully executed\e[0m"
+fi
+
+echo -e "Build LATEST and push it  ? [Y/n]"
+read pushlatest
+
+if [ "$pushlatest" != "Y" ]; then
+    echo -e "\e[0;42mLatest image will not be built & pushed. Process over.\e[0m";
+    exit 7;
+fi
+
+imageId=$(docker images | grep $name | grep $version | awk '{ print $3; }')
+docker tag -f $imageId $name:latest
+docker push $name:latest

gen/base.php

@@ -13,7 +13,7 @@
 
 require_once __DIR__.'/../../vendor/autoload.php';
 require_once __DIR__.'/../../src/app.php';
-
+require_once __DIR__.'/../../config.php';
 
 __BASE_INCLUDES__
 

gen/controller.php

@@ -63,7 +63,7 @@
             $whereClause =  $whereClause . " OR"; 
         }
 
-        $whereClause =  $whereClause . " " . $col . " LIKE '%". $searchValue ."%'";
+        $whereClause =  $whereClause . " `" . $col . "` LIKE '%". $searchValue ."%'";
 
         $i = $i + 1;
     }
@@ -137,11 +137,58 @@
 __TABLECOLUMNS_ARRAY__
     );
 
-    $primary_key = "__TABLE_PRIMARYKEY__";	
+    $primary_key = "__TABLE_PRIMARYKEY__";
+
+    $image_tag_insertion = array();
+    $video_tag_insertion = array();
+    $call_to_action = array();
+    $table_intro = '';
+
+    foreach($table_columns as $idx => $table_column) {
+        if(isset($app['image_fields'])) {
+            if(isset($app['image_fields']['__TABLENAME__' . '.' . $table_column])) {
+                $image_tag_insertion[] = array(
+                    'column_idx' => $idx,
+                    'image_path' => $app['image_fields']['__TABLENAME__' . '.' . $table_column],
+                    'column_name' => $table_column
+                );
+            }
+        }
+        if(isset($app['video_fields'])) {
+            if(isset($app['video_fields']['__TABLENAME__' . '.' . $table_column])) {
+                $video_tag_insertion[] = array(
+                    'column_idx' => $idx,
+                    'video_path' => $app['video_fields']['__TABLENAME__' . '.' . $table_column],
+                    'column_name' => $table_column
+                );
+            }
+        }
+    }
+
+    if(isset($app['call_to_action'])) {
+        if(isset($app['call_to_action']['__TABLENAME__'])) {
+            $call_to_action = $app['call_to_action']['__TABLENAME__'];
+        }
+    }
+
+    if(isset($app['table_intro'])) {
+        if(isset($app['table_intro']['__TABLENAME__'])) {
+            $table_intro = $app['table_intro']['__TABLENAME__'];
+        }
+    }
+
+    if(!is_string($table_intro)) {
+        $table_intro = '';
+    }
+
 
     return $app['twig']->render('__TABLENAME__/list.html.twig', array(
     	"table_columns" => $table_columns,
-        "primary_key" => $primary_key
+        "primary_key" => $primary_key,
+        "image_tag_insertion" => $image_tag_insertion,
+        "video_tag_insertion" => $video_tag_insertion,
+        "call_to_action" => $call_to_action,
+        "table_intro" => $table_intro
     ));
 
 })