Skip to content


Subversion checkout URL

You can clone with
Download ZIP
Browse files

Added some new doc as well as a new wigbi/NO_MAGIC_QUOTES.htaccess file

  • Loading branch information...
1 parent 02f3770 commit a461988973829d8c3e1746b43f6ebb8b53c5d4be @danielsaidi committed
@@ -10,41 +10,67 @@ well as with your own classes.
The basic Wigbi release contains:
* controllers/ - Basic controller setup and a home controller
- * wigbi/ - The latest Wigbi version, with everything you need
- * plugins/ - Fully working Wigbi data and UI plugin templates
+ * wigbi/ - The latest Wigbi version
+ * plugins/ - Wigbi data and UI plugins
* views/ - A default home index view as well as a master page
* REMOVE_FILE_NAME.htaccess - A .htaccess file used by Wigbi MVC
-Wigbi is developed with TDD, but the unit tests suite are not part
-of the release bundle. To get your hands on the unit tests, go and
-fork the source code on
+The Wigbi unit tests are not part of the release bundle. Grab them
+by forking the source code at
Getting started
-To get started with Wigbi, the easiest thing is to rename the file
-REMOVE_FILE_NAME.htaccess to .htaccess (remove the file name, just
-like the file name says).
+If you are using Wigbi for the first time, you should start off by
+having a look at the short video tutorial that is up at
-Depending on your OS setup, the .htaccess file could become hidden
-when you change the file name, but you probably already know how a
-hidden file can be changed, if you need to do so ;)
+Wigbi does not require the MVC components, but since the home view
+that is included in the release by default helps you configure the
+framework, you should use it at least the first time you set it up.
-You can now visit to the root folder in your web browser (provided
-that you have URL rewriting enabled). It will display a Wigbi page
-that checks if Wigbi is properly setup.
+So, first rename REMOVE_FILE_NAME.htaccess to .htaccess. This file
+will then enable basic URL rewriting for the Wigbi MVC engine. The
+file may become hidden when you remove the file name, but you have
+knowledge about how to access hidden files, I am sure ;)
+If you use Wigbi out of the box, renaming the .htaccess file makes
+it possible to visit the root folder in your browser (even when it
+has no default page) which displays a page that checks if Wigbi is
+properly configured.
If Wigbi is NOT properly setup (which it will not be from scratch),
-you will receive a bunch of exceptions. All you have to do is to:
+you will receive some instructions on how to set it up correctly.
- * open wigbi/config.ini (is auto-generated if it does not exist)
+All you have to do is to:
+ * open wigbi/config.ini (auto-generated when Wigbi is started)
* enter a value for (a name of your choice)
* enter a value for application.webRoot (the web site root URL)
+If you use data plugins, you also need to enter the four DB config
+parameters, which tells Wigbi how to connect to the database where
+the data plugins will be persisted.
That's it! If you reload the page, it should not throw any more of
-these annoying exceptions. For now, the start poage is simple, but
-I will extend due time :)
+these annoying exceptions. The start page is simple, but I will do
+some more work on due time :)
+In Wigbi 1.1.2, I have created a separate wigbi/.htaccess file for
+Wigbi sites that will run on servers that has magic quotes enabled.
+In these cases, replace .htaccess with NO_MAGIC_QUOTES.htaccess to
+make Wigbi disable magic quotes, which otherwise will mess up data
+that is sent through the Wigbi AJAX pipeline.
+Earlier, Wigbi could not be used on servers that did not have this
+magic quote feature installed, since attempting to disable it made
+Wigbi crash. The magic quote disabling line had to be deleted from
+the .htaccess file for Wigbi to work.
+With this new setup, you only have to use the line if you need it.
Contact & downloads
@@ -5,6 +5,6 @@ RewriteEngine On
RewriteCond %{REQUEST_FILENAME} !-f
RewriteCond %{REQUEST_FILENAME} !-d
-RewriteRule ^([a-zA-Z0-9_\-]+)$ controllers/_controller.php?controller=$1&action=index [NC,L,QSA]
-RewriteRule ^([a-zA-Z0-9_\-]+)/([a-zA-Z0-9_\-]+)$ controllers/_controller.php?controller=$1&action=$2 [NC,L,QSA]
-RewriteRule ^$ home/index [NC,L,QSA]
+RewriteRule ^([a-zA-Z0-9_\-]+)$ controllers/_controller.php?controller=$1&action=index [NC,L,QSA]
+RewriteRule ^([a-zA-Z0-9_\-]+)/([a-zA-Z0-9_\-]+)$ controllers/_controller.php?controller=$1&action=$2 [NC,L,QSA]
+RewriteRule ^$ home/index [NC,L,QSA]
15 wigbi/NO_MAGIC_QUOTES.htaccess
@@ -0,0 +1,15 @@
+<Files config.ini>
+order deny,allow
+deny from all
+php_flag magic_quotes_gpc off
+Options -Indexes
+Options +FollowSymLinks
+RewriteEngine On
+RewriteRule ^bundle/css:(.*) pages/bundle.php?type=css&elements=$1 [NC]
+RewriteRule ^bundle/js:(.*) pages/bundle.php?type=js&elements=$1 [NC]
+RewriteRule ^postBack.php$ pages/postBack.php [NC]
+RewriteRule ^wizard.php/?$ pages/wizard.php [NC]

0 comments on commit a461988

Please sign in to comment.
Something went wrong with that request. Please try again.