Skip to content

Latest commit

 

History

History
68 lines (62 loc) · 5.5 KB

main.md

File metadata and controls

68 lines (62 loc) · 5.5 KB

API Reference

Welcome to the API documentation. It's intended as a feature reference to give you more detailed information about working with F3. You can also find extensive working examples in the source code of the framework unit tests.

Quick references are available for System Variables and Template Directives.

Framework Core

    <h3>Databases</h3>
    <ul class="reference">
        <li><a class="label" href="jig" title="The Jig class provides a simple way to store arrays of data into flat ASCII files">Jig</a></li>
        <li><a class="label" href="mongo" title="The Mongo class is a lightweight MongoDB wrapper">Mongo</a></li>
        <li><a class="label" href="sql" title="The SQL class provides a lightweight and consistent interface for accessing SQL databases">SQL</a></li>
    </ul>

    <h3>Data Mappers</h3>
    <ul class="reference">
        <li><a class="label" href="cursor" title="This Cursor class is an abstract foundation of an Active Record implementation, that is used by all F3 Data Mappers">Cursor</a></li>
        <li><a class="label" href="basket" title="Session-based pseudo-mapper">Basket</a></li>
        <li><a class="label" href="jig-mapper" title="The Jig Object-Document-Mapper is an implementation of the abstract Active Record Cursor class">Jig Mapper</a></li>
        <li><a class="label" href="mongo-mapper" title="The Mongo Object-Document-Mapper (ODM) is an implementation of the abstract Active Record Cursor class">Mongo Mapper</a></li>
        <li><a class="label" href="sql-mapper" title="The SQL Object-Relational-Mapper is an implementation of the abstract Active Record Cursor class">SQL Mapper</a></li>
    </ul>
</div>
<div class="col-sm-6">
    <h3>Templating</h3>
    <ul class="reference">
        <li><a class="label" href="markdown" title="This is F3's own implementation of Markdown">Markdown</a></li>
        <li><a class="label" href="template" title="F3's own lightning fast and extendable template engine gives you all the flexibility you need for modern and clean templating">Template</a></li>
    </ul>

    <h3>Web Services</h3>
    <ul class="reference">
        <li><a class="label" href="web" title="The Web class and its descendants Geo and Pingback, contain several helpers to interact with HTTP clients and servers">Web</a></li>
        <li><a class="label" href="geo" title="The Geo plugin gives you a handful of location-based features">Geo</a></li>
        <li><a class="label" href="oauth2" title="Lightweight OAuth2 client">OAuth2</a></li>
        <li><a class="label" href="openid" title="The OpenID class is a OpenID consumer">OpenID</a></li>
        <li><a class="label" href="pingback" title="Pingback 1.0 protocol (client and server) implementation">PingBack</a></li>
        <li><a class="label" href="smtp" title="The SMTP class is a SMTP plug-in">SMTP</a></li>
        <li><a class="label" href="google-static-maps" title="Google Static Maps API v2 plug-in">Google Static Maps</a></li>
        <li><a class="label" href="websocket" title="RFC6455 Compatible WebSocket Server">WebSocket</a></li>
    </ul>
    <h3>Misc</h3>
    <ul class="reference">
        <li><a class="label" href="audit" title="The Audit class is a data validator">Audit</a></li>
        <li><a class="label" href="auth" title="The Auth class is used to authenticate against several storages">Auth</a></li>
        <li><a class="label" href="bcrypt" title="The Bcrypt plugin is a secure and lightweight password hashing library">Bcrypt</a></li>
        <li><a class="label" href="image" title="The Image class offers a bunch of image processing features">Image</a></li>
        <li><a class="label" href="log" title="This is the F3 custom Logger class">Log</a></li>
        <li><a class="label" href="magic" title="A PHP magic wrapper">Magic</a></li>
        <li><a class="label" href="matrix" title="The matrix class offers some generic array utilities">Matrix</a></li>
        <li><a class="label" href="session" title="The SESSION handlers of the framework">Session</a></li>
        <li><a class="label" href="test" title="The Test class is a simple unit testing stack, where you can add multiple tests to and serve out their results">Test</a></li>
        <li><a class="label" href="utf-unicode-string-manager" title="The UTF class is an utility class that eases the handling of Unicode strings">UTF</a></li>
    </ul>
</div>