Introduction

Summary
This is generated documentation for phpBlamework by NaturalDocs.
I learned some conventions and I took them to self.
Copy these files to web server doc directory.
Default user/password is admin/admin.
So at the and, framework is these files
Copyright © 2005, Ondřej Tůma Blackmouse All rights reserved.

Introduction

This is generated documentation for phpBlamework by NaturalDocs.  Other documentation like FAQ, how-to, Todo or Changelog, updates and other info you can find on homepage http://phpblamework.webjet.cz.  Mainer of this project is Ondřej Tůma ondra.tu at webjet.cz.

code conventions

I learned some conventions and I took them to self.  I know, they are not ideal, and it could be better but...

Variables

all variables begins with two lower case first could be

gvariable is global
lvariable is local
ivariable is input

second char designates type of variables

aarray
bboolean
cchar
nnumber
Oobject
ppointer
rreference (so object too)
sstring

it continues by name of variable with upper case.  Some examples

lsMyTextlocal string variable
ioSqlinput object as variable
gaMainMenuglobal menu

I know, that I don’t use at all, but I will :)

Module names

Next convention is about module functions and variables.  All module items has module name with ‘_’ char.

gaWLogin_usersglobal array variable for module WLogin
WTexts_TextAddTextAdd function from module WTexts

Install

Sessions

Copy these files to web server doc directory.  Session ID is create with self settings so, there can be many systems base on this framework in one domain.  It’s important to one system per one directory (subdirectory) in domain tree.  For example:

www.example.com/system1
www.example.com/system2
www.example.com/system2/newsystem

Administration

Default user/password is admin/admin.  You must generate new sha hash of your password and correct file modules/w_login.php.  You can add another user with another name, and of course withe another rights.

Database have four tables, events is not in use yet.  Be carefully if you want change admin page in table Menu.

Files

So at the and, framework is these files

.
|-- admin.php
|-- data
| |-- fill.sql
| |-- logo.png
| |-- powered
| | |-- blackmouse2.png
| | |-- btn_vim.gif
| | |-- explorer.png
| | |-- firefox.png
| | |-- konqueror.gif
| | |-- mozilla.png
| | |-- mysql.gif
| | |-- mysql.png
| | |-- opera.png
| | |-- php-power-micro.png
| | |-- seamonkey.png
| | |-- utf8.png
| | `-- xhtml.png
| `-- webpages.sql
|-- forms
| `-- template.html
|-- images
| |-- close.gif
| |-- delete.gif
| |-- delete.png
| |-- delete.svg
| |-- edit.gif
| |-- edit.png
| |-- edit.svg
| |-- f_down.gif
| |-- f_next.gif
| |-- f_prev.gif
| |-- f_up.gif
| |-- hide.gif
| |-- reklama.gif
| |-- save.gif
| |-- sflake.gif
| |-- sflake2.gif
| |-- shear.gif
| |-- view.gif
| |-- view.png
| |-- view.svg
| `-- vlocka.gif
|-- index.css
|-- index.php
|-- jsblase.js
|-- modules
| |-- config.php
| `-- modules.php
`-- system
|-- forms.php
|-- mail.php
|-- menu.php
|-- misc.php
|-- sql.php
`-- views.php

You don’t need LICENCE and Doc to using, fill.sql and webpades.sql you need only to install.  And others files are code patterns, how you can use the framework.

Licence

BSD Licence

Copyright © 2005, Ondřej Tůma Blackmouse All rights reserved.  Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met:

  • Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer.
  • Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution.
  • Neither the name of the University of California, Berkeley nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS’’ AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.