A chunk of HTML we don't want displayed at the moment
-A chunk of HTML we don't want displayed at the moment
*} -``` - -### Conditional Segments - -Another useful template feature is the `Appears when condition is true
- Appears when condition is false
- HTML chunk to be included if condition is true
-{{ trim(@fruit) }}
-apple
-orange
-banana
-``` - -The framework allows unlimited nesting of `
-
-{{ @ikey }}
-
-
-
-coffee
-- arabica - barako - liberica - kopiluwak -
-
-
-```
-
-Amazing, isn't it? And the only thing you had to do in PHP was to define the contents of a single F3 variable `div` to replace the `@div` token. Fat-Free makes both programming and Web template design really easy.
-
-The `tea
-- darjeeling - pekoe - samovar -
-{{ trim(@fruit) }}
-Welcome, and thanks for joining {{ @site }}!
-``` - -Save the above e-mail template as welcome.txt. The associated F3 code would be:- - -``` php -$f3->set('from','{{ @love }}
-
-{{ @today,time() | format }}.
-{{ @money,365.25 | format }}
-{{ @pi }}
-
get('love'); ?>
-
- get('today',time()); ?>.
- get('money',365.25); ?>
- get('pi'); ?>
-
'; - if ($result['status']) - echo 'Pass'; - else - echo 'Fail ('.$result['source'].')'; - echo '
'; -} -``` - -Save it in a file called `test.php`. This way we can preserve the integrity of `hello.php`. - -Now here's the meat of our unit testing process. - -F3's built-in `Test` class keeps track of the result of each `expect()` call. The output of `$test->results()` is an array of arrays with the keys `text` (mirroring argument 2 of `expect()`), `status` (boolean representing the result of a test), and `source` (file name/line number of the specific test) to aid in debugging. - -Fat-Free gives you the freedom to display test results in any way you want. You can have the output in plain text or even a nice-looking HTML template. So how do we run our unit test? If you saved `test.php` in the document root folder, you can just open your browser and specify the address `http://localhost/test.php`. That's all there is to it. - -### Mocking HTTP Requests - -F3 gives you the ability to simulate HTTP requests from within your PHP program so you can test the behavior of a particular route. Here's a simple mock request:- - -``` php -$f3->mock('GET /test?foo=bar'); -``` - -To mock a POST request and submit a simulated HTML form:- - -``` php -$f3->mock('POST /test',['foo'=>'bar']); -``` - -### Expecting the Worst that can Happen - -Once you get the hang of testing the smallest units of your application, you can then move on to the bigger components, modules, and subsystems - checking along the way if the parts are correctly communicating with each other. Testing manageable chunks of code leads to more reliable programs that work as you expect, and weaves the testing process into the fabric of your development cycle. The question to ask yourself is:- Have I tested all possible scenarios? More often than not, those situations that have not been taken into consideration are the likely causes of bugs. Unit testing helps a lot in minimizing these occurrences. Even a few tests on each fixture can greatly reduce headaches. On the other hand, writing applications without unit testing at all invites trouble. - -## Quick Reference - -### System Variables - -`string AGENT` - -* Auto-detected HTTP user agent, e.g. `Mozilla/5.0 (Linux; Android 4.2.2; Nexus 7) AppleWebKit/537.31`. - -`bool AJAX` - -* `TRUE` if an XML HTTP request is detected, `FALSE` otherwise. - -`string AUTOLOAD` - -* Search path for user-defined PHP classes that the framework will attempt to autoload at runtime. Accepts a pipe (`|`), comma (`,`), or semi-colon (`;`) as path separator. - -`string BASE` - -* Path to the `index.php` main/front controller. - -`string BODY` - -* HTTP request body for ReSTful post-processing. - -`bool/string CACHE` - -* Cache backend. Unless assigned a value like `'memcache=localhost'` (and the PHP memcache module is present), F3 auto-detects the presence of APC, WinCache and XCache and uses the first available PHP module if set to TRUE. If none of these PHP modules are available, a filesystem-based backend is used (default directory: `tmp/cache`). The framework disables the cache engine if assigned a `FALSE` value. - -`bool CASELESS` - -* Pattern matching of routes against incoming URIs is case-insensitive by default. Set to `FALSE` to make it case-sensitive. - -`array COOKIE, GET, POST, REQUEST, SESSION, FILES, SERVER, ENV` - -* Framework equivalents of PHP globals. Variables may be used throughout an application. However, direct use in templates is not advised due to security risks. - -`integer DEBUG` - -* Stack trace verbosity. Assign values 1 to 3 for increasing verbosity levels. Zero (0) suppresses the stack trace. This is the default value and it should be the assigned setting on a production server. - -`string DNSBL` - -* Comma-separated list of [DNS blacklist servers](http://whatismyipaddress.com/blacklist-check). Framework generates a `403 Forbidden` error if the user's IPv4 address is listed on the specified server(s). - -`array DIACRITICS` - -* Key-value pairs for foreign-to-ASCII character translations. - -`string ENCODING` - -* Character set used for document encoding. Default value is `UTF-8`. - -`array ERROR` - -* Information about the last HTTP error that occurred. `ERROR.code` is the HTTP status code. `ERROR.status` contains a brief description of the error. `ERROR.text` provides more detail. For HTTP 500 errors, use `ERROR.trace` to retrieve the stack trace. - -`bool ESCAPE` - -* Used to enable/disable auto-escaping. - -`string EXEMPT` - -* Comma-separated list of IPv4 addresses exempt from DNSBL lookups. - -`string FALLBACK` - -* Language (and dictionary) to use if no translation is available. - -`bool HALT` - -* If TRUE (default), framework stops execution after a non-fatal error is detected. - -`array HEADERS` - -* HTTP request headers received by the server. - -`bool HIGHLIGHT` - -* Enable/disable syntax highlighting of stack traces. Default value: `TRUE` (requires `code.css` stylesheet). - -`string HOST` - -* Server host name. If `$_SERVER['SERVER_NAME']` is not available, return value of `gethostname()` is used. - -`string IP` - -* Remote IP address. The framework derives the address from headers if HTTP client is behind a proxy server. - -`array JAR` - -* Default cookie parameters. - -`string LANGUAGE` - -* Current active language. Value is used to load the appropriate language translation file in the folder pointed to by `LOCALES`. If set to `NULL`, language is auto-detected from the HTTP `Accept-Language` request header. - -`string LOCALES` - -* Location of the language dictionaries. - -`string LOGS` - -* Location of custom logs. - -`mixed ONERROR` - -* Callback function to use as custom error handler. - -`string PACKAGE` - -* Framework name. - -`array PARAMS` - -* Captured values of tokens defined in a `route()` pattern. `PARAMS.0` contains the captured URL relative to the Web root. - -`string PATTERN` - -* Contains the routing pattern that matches the current request URI. - -`string PLUGINS` - -* Location of F3 plugins. Default value is the folder where the framework code resides, i.e. the path to `base.php`. - -`int PORT` - -* TCP/IP listening port used by the Web server. - -`string PREFIX` - -* String prepended to language dictionary terms. - -`bool QUIET` - -* Toggle switch for suppressing or enabling standard output and error messages. Particularly useful in unit testing. - -`bool RAW` - -* Disable automatic storage of HTTP request body into `BODY`. Should be TRUE when processing large data coming from `php://input` which will not fit in memory. Default value: `FALSE` - -`string REALM` - -* Full canonical URL. - -`string RESPONSE` - -* The body of the last HTTP response. F3 populates this variable regardless of the `QUIET` setting. - -`string ROOT` - -* Absolute path to document root folder. - -`array ROUTES` - -* Contains the defined application routes. - -`string SCHEME` - -* Server protocol, i.e. `http` or `https`. - -`string SERIALIZER` - -* Default serializer. Normally set to `php`, unless PHP `igbinary` extension is auto-detected. Assign `json` if desired. - -`string TEMP` - -* Temporary folder for cache, filesystem locks, compiled F3 templates, etc. Default is the `tmp/` folder inside the Web root. Adjust accordingly to conform to your site's security policies. - -`string TZ` - -* Default timezone. Changing this value automatically calls the underlying `date_default_timezone_set()` function. - -`string UI` - -* Search path for user interface files used by the `View` and `Template` classes' `render()` method. Default value is the Web root. Accepts a pipe (`|`), comma (`,`), or semi-colon (`;`) as separator for multiple paths. - -`callback UNLOAD` - -* Executed by framework on script shutdown. - -`string UPLOADS` - -* Directory where file uploads are saved. - -`string URI` - -* Current HTTP request URI. - -`string VERB` - -* Current HTTP request method. - -`string VERSION` - -* Framework version. - -### Template Directives - -``` -@token -``` -* Replace `@token` with value of equivalent F3 variable. - -``` -{{ mixed expr }} -``` -* Evaluate. `expr` may include template tokens, constants, operators (unary, arithmetic, ternary and relational), parentheses, data type converters, and functions. If not an attribute of a template directive, result is echoed. - -``` -{{ string expr | raw }} -``` -* Render unescaped `expr`. F3 auto-escapes strings by default. - -``` -{{ string expr | esc }} -``` -* Render escaped `expr`. This is the default framework behavior. The `| esc` suffix is only necessary if `ESCAPE` global variable is set to `FALSE`. - -``` -{{ string expr, arg1, ..., argN | format }} -``` -* Render an ICU-formatted `expr` and pass the comma-separated arguments, where `arg1, ..., argn` is one of:- `'date'`, `'time'`, `'number, integer'`, `'number, currency'`, or `'number, percent'`. - -``` -
-
- convert(Base::instance()->read('readme.md')); ?>
-
diff --git a/vendor/fatfree/ui/welcome.htm b/vendor/fatfree/ui/welcome.htm
deleted file mode 100644
index 31f69f9..0000000
--- a/vendor/fatfree/ui/welcome.htm
+++ /dev/null
@@ -1,62 +0,0 @@
-
-
-
-
-
-
-
diff --git a/vendor/fatfree/lib/utf.php b/vendor/fatfree/utf.php
similarity index 100%
rename from vendor/fatfree/lib/utf.php
rename to vendor/fatfree/utf.php
diff --git a/vendor/fatfree/lib/web.php b/vendor/fatfree/web.php
similarity index 100%
rename from vendor/fatfree/lib/web.php
rename to vendor/fatfree/web.php
diff --git a/vendor/fatfree/lib/web/geo.php b/vendor/fatfree/web/geo.php
similarity index 100%
rename from vendor/fatfree/lib/web/geo.php
rename to vendor/fatfree/web/geo.php
diff --git a/vendor/fatfree/lib/web/google/recaptcha.php b/vendor/fatfree/web/google/recaptcha.php
similarity index 100%
rename from vendor/fatfree/lib/web/google/recaptcha.php
rename to vendor/fatfree/web/google/recaptcha.php
diff --git a/vendor/fatfree/lib/web/google/staticmap.php b/vendor/fatfree/web/google/staticmap.php
similarity index 100%
rename from vendor/fatfree/lib/web/google/staticmap.php
rename to vendor/fatfree/web/google/staticmap.php
diff --git a/vendor/fatfree/lib/web/oauth2.php b/vendor/fatfree/web/oauth2.php
similarity index 100%
rename from vendor/fatfree/lib/web/oauth2.php
rename to vendor/fatfree/web/oauth2.php
diff --git a/vendor/fatfree/lib/web/openid.php b/vendor/fatfree/web/openid.php
similarity index 100%
rename from vendor/fatfree/lib/web/openid.php
rename to vendor/fatfree/web/openid.php
diff --git a/vendor/fatfree/lib/web/pingback.php b/vendor/fatfree/web/pingback.php
similarity index 100%
rename from vendor/fatfree/lib/web/pingback.php
rename to vendor/fatfree/web/pingback.php
Version
-The first thing you might want to do is visualize your directory structures. Fat-Free gives you total control over your Web site. Organize your folders in any way that pleases you (or your development team if you're part of a group). Decide where you want to store the following:
--
-
- Application and code libraries -
- HTML templates -
- Graphics and media files -
- Javascript and CSS files -
- Database (if you plan to use an embedded DB like SQLite) -
- Configuration files -
- Uploads/Downloads -
For security reasons, consider relocating the lib/ folder to a path that's not Web-accessible. If you decide to move this folder, just change the line in index.php containing require 'lib/base.php'; so it points to the new location. The lib/ folder also contains framework plug-ins that extend F3's capabilities. You can change the default location of all plug-ins by moving the files to your desired subdirectory. Then, it's just a matter of pointing the PLUGINS global variable to the new location. You may delete the plug-ins that you don't need. You can reinstate them later as you find necessary.
F3 can autoload OOP classes for you. Just add the path to the AUTOLOAD variable.
When you're ready to write your F3-enabled site, you can start editing the rest of the code contained in the index.php file that displayed this Web page. Developing PHP applications will never be the same!
PHP Dependencies
-Some framework features in this version will not be available if PHP is not configured with the modules needed by your application.
-| Class/Plug-in | -PHP Module | -
|---|---|
| - |
-
- onclick="return false"> - - |
-
-
-
- The
Baseclass requires all listed PHP modules enabled to function properly.
- - The
Cacheclass will use any available module in the list. If none can be found, it will use the filesystem as fallback.
- - The
DB\SQLclass requires thepdomodule and a PDO driver relevant to your application.
- - The
Bcryptclass will use themcryptoropensslmodule for entropy generation. Otherwise, it employs a custom random function.
- - The
Webclass will use thecurlmodule for HTTP requests to another server. If this is not detected, it will use other transports available, such as the HTTP stream wrapper or native sockets.
- - The
geoipmodule listed in theWeb\Geoclass is optional; the class will use an alternative Web service for geo-location.
- - Other framework classes in the list need all its listed modules enabled. -
Need Help?
-If you have any questions regarding the framework, technical support is available at https://groups.google.com/forum/?fromgroups#!forum/f3-framework
You can also join our Slack Channel to get support
-Need live support? You can talk to the development team and the rest of the Fat-Free community via IRC. We're on the FreeNode (chat.freenode.net) #fatfree channel. If the channel appears quiet, the development team might just be busy with the next great release, or it's probably due to time zone differences. Just hang around.
The User Reference is designed to serve as a handbook and programming guide. However, the online documentation at https://github.com/bcosca/fatfree provides the latest and most comprehensive information about the framework.
Fair Licensing
-Fat-Free Framework is free software covered by the terms of the GNU Public License (GPL v3). You may not use the software, documentation, and samples except in compliance with the license. If the terms and conditions of this license are too restrictive for your use, alternative licensing is available for a very reasonable fee.
-If you feel that this software is one great weapon to have in your programming arsenal, it saves you a lot of time and money, use it for commercial gain or in your business organization, please consider making a donation to the project. A significant amount of time, effort, and money has been spent on this project. Your donations help keep this project alive and the development team motivated. Donors and sponsors get priority support commensurate to your contribution (24-hour response time on business days).
-Support F3
-F3 is community-driven software. Support the development of the Fat-Free Framework. Your contributions help keep this project alive.
-