diff --git a/README.md b/README.md index ec60146..745ee2c 100644 --- a/README.md +++ b/README.md @@ -1,130 +1,124 @@ # Boz PHP - Another PHP Framework This framework is my laser cannon that serves dozen of very-different Content Management Systems "made from zero" by me in my single Debian GNU/Linux server. Note that I very often deprecate and kill stuff depending on how I feel in the morning. ## Benefits You can create a RDBMS CMS with these features: * efficient * query builder * database associative options * very small framework with few flat files (BTW not required on startup) * implicit support for DB table prefixes * login and user capabilities WITHOUT requiring PHP sessions * secure file uploads ## Requirements Obviously a webserver with PHP and MySQL or MariaDB working. Personally I have a simple GLAMP machine (GNU/Linux + Apache + PHP + MySQL or MariaDB). Extra packages suggested: * `libmagic-dev` The `libmagic-dev` package is in the main Debian GNU/Linux repository and so I think it is in all other GNU/Linux distributions. It is needed in order to upload files safetely. ## Simplest shared installation As a shared library: one can serve many sites with a simple `require`. Start cloning the source-code in a shared folder as `/usr/share`: bzr branch lp:boz-php-another-php-framework /usr/share/boz-php-another-php-framework That's it! Leave that folder as is, you don't have to touch it anymore. ## Use it Go to your website folder (e.g. `/var/www/blog`), and create your friendly config file. I use to call it `load.php` and please do so. Write in something as: ```php time; echo "If you see the datetime, the database works!"; ``` ## Database installation You can add support for user *autentication* / user *permissions* and *associative options* importing the database schema into your database. To do it you should have received a file called `example-schema.sql` in the `examples` framework folder. Import it into your database. Actually there are only two tables. ## Stuff in `load.php` Have to specify these: * `$username` (`string`) The database username. * `$password` (`string`) The password of the database username. * `$database` (`string`) The database name. * `$location` (`string`) The database location. * `$prefix` (`string`) The database table prefix. * `ABSPATH` (`string`) The absolute pathname of your site (`__DIR__` is your friend). No trailing slash. * `ROOT` (`string`) The absolute request pathname (something as `/blog` or simply an empty string). No trailing slash. Definibles (as (`type`) `default`): * `DEBUG` (`bool`) `false`: Enable verbose debugging. * `SHOW_EVERY_SQL` (`bool`) `false`: It does what you think. Only if `DEBUG`. * `REQUIRE_LOAD_POST` (`string|false`) `string`: As default it's `ABSPATH . '/load-post.php` and it's a file that describes your CMS. * `PROTOCOL` (`string`): Default is the protocol of the request (`http://` / `https://`). It builds the `URL` constant. * `DOMAIN` (`string`): Default is your domain name. You can override it. It builds the `URL` constant. * `URL` (`string`): Default is `PROTOCOL . DOMAIN . ROOT`. ## What you have then Well. I hope to auto-document it with inline comments. For now you can just see `functions.php` in the framework folder. ## Own functions / stuff It's normal to have your own custom configuration of this framework. So the `load-post.php` file is made for you. Create it and write in it what you want: ```php 'pdf', 'application/x-pdf' => 'pdf', 'application/x-bzpdf' => 'pdf', 'application/x-gzpdf' => 'pdf' ] ); // Custom menu tree declaration add_menu_entries( [ - new MenuEntry('home', URL . '/home.php', _("Home") ), - new MenuEntry('services', URL . '/services.php', _("Our services") ), - new MenuEntry('meet', URL . '/meet.php', _("Meet us"), 'services'), - new MenuEntry('colorado', URL . '/meet.php', _("Meet us in Colorado"), 'meet'), - new MenuEntry('cast', URL . '/cast.php', _("Cast") ) -] ); - -// Create a submenu in certain conditions -has_permission('do-wonderful-things') && add_menu_entries( [ - new MenuEntry('cast-edit', URL . '/foo.php', _("Cast administration"), 'cast' ) + new MenuEntry( 'index', 'home.php', __("Home") ), + new MenuEntry( 'services', 'services.php', __("Our services") ), + new MenuEntry( 'contact', 'meet.php', __("Meet us"), 'services'), + new MenuEntry( 'fsf', 'https://fsf.org/', __("Meet us in Colorado"), 'contact'), ] ); // Use of custom associative options // $visits = get_option('visits', 0); // set_option('visits', ++$visits); ``` ## License This is a **Free** as in **Freedom** project. It comes with ABSOLUTELY NO WARRANTY. You are welcome to redistribute it under the terms of the **GNU Affero General Public License v3+**.