Skip to content

Commit

Permalink
Small documentation improvements
Browse files Browse the repository at this point in the history
  • Loading branch information
alombarte committed Sep 1, 2012
1 parent 23e059b commit 2e52809
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 5 deletions.
7 changes: 3 additions & 4 deletions docs/API/Model.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Of course your application can have models extending from different classes and

**If you are a Mysql-only guy you'll probably want to use `MysqlModel` instead of `Model`. This page talks only about the `Model` class (multidriver)**

If, on the contrary, your application is using a distinct RDBM than Mysql (see supported databases) this is the class you have to extend from.
If, on the contrary, your application is using a distinct RDBM than Mysql [see supported databases](#databases) this is the class you have to extend from.

How it works (`Model` only)
---------------------------
Expand Down Expand Up @@ -89,7 +89,7 @@ This is an approximation of what you could do to avoid this:
return false;
}

Supported databases
Supported databases {#databases}
-------------------
The aim of the class `Model` is to support **multiple database drivers**. It has been very common for us in the past to connect to several *unknown* databases and ADODB gave us a common interface to connect them all. A **non-complete** full list of supported databases is here:

Expand All @@ -115,7 +115,6 @@ The aim of the class `Model` is to support **multiple database drivers**. It has
* Netezza
* Sybase SQL Anywhere

See the [ADODBdriver] [list of drivers] for further detail.
See the [ADODB] [List of supported ADODB drivers](http://phplens.com/lens/adodb/docs-adodb.htm#drivers) for the rarest drivers.

[ADODB]: http://phplens.com/lens/adodb/docs-adodb.htm
[ADODBdriver]: http://phplens.com/lens/adodb/docs-adodb.htm#drivers "List of supported ADODB drivers"
54 changes: 53 additions & 1 deletion docs/API/index.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,55 @@
API: Programmer's Reference Guide
=================================
Sifo framework is based in the Model View Controller (MVC) design pattern. Use the navigation menu and see a list of classes that are included with the SIFO library. Some of this classes are always preloaded by the bootsrap for every execution, you can see which of them are included by default in the file `config/libraries.config.php` of your instance. The rest of them will be automatically included when you use them.
Sifo framework is based in the Model View Controller (MVC) design pattern. You'll need to get familiar with the `Controller` and `Model` classes in the first place to be quickly productive.

Use the navigation menu in the left for explanation and examples on some of the classes that are included with the Sifo framework.
The full list of classes belonging to the framework is [browseable at Github](https://github.com/alombarte/SIFO/tree/master/libs/Sifo). These is a sample (might be outdated, but you can have an idea):

* AmazonS3
* APITwitter
* APIYoutube
* Benchmark
* Cache
* CacheBase
* CacheDisk
* CacheMemcached
* CacheMemcache
* Client
* Config
* Controller
* Cookie
* Crypt
* CssPacker
* Database
* Debug
* DebugMysql
* DirectoryList
* Dir
* Domains
* Exceptions
* Filter
* FlashMessages
* Form
* I18N
* imageController
* Images
* JsPacker
* Keyspace
* LoadBalancer
* Mail
* MediaGenerator
* MediaPacker
* Metadata
* Model
* MysqlModel
* Mysql
* PaypalNotifier
* RedisModel
* Registry
* Router
* Search
* DebugSearch
* Session
* Urls
* View

0 comments on commit 2e52809

Please sign in to comment.