diff --git a/fatfree/.htaccess b/fatfree/.htaccess new file mode 100644 index 0000000000000000000000000000000000000000..267173e1fee1c610c07591a1eb1a1ed04f96bb2b --- /dev/null +++ b/fatfree/.htaccess @@ -0,0 +1,16 @@ +# Enable rewrite engine and route requests to framework +RewriteEngine On + +# Some servers require you to specify the `RewriteBase` directive +# In such cases, it should be the path (relative to the document root) +# containing this .htaccess file +# +# RewriteBase / + +RewriteRule ^(lib|tmp)\/|\.(ini|php)$ - [R=404] + +RewriteCond %{REQUEST_FILENAME} !-l +RewriteCond %{REQUEST_FILENAME} !-f +RewriteCond %{REQUEST_FILENAME} !-d +RewriteRule .* index.php [L,QSA] +RewriteRule .* - [E=HTTP_AUTHORIZATION:%{HTTP:Authorization},L] diff --git a/fatfree/composer.json b/fatfree/composer.json new file mode 100644 index 0000000000000000000000000000000000000000..afda09e8b8c1a4f1d6124cd4e658fd96aec4a7ae --- /dev/null +++ b/fatfree/composer.json @@ -0,0 +1,18 @@ +{ + "name": "bcosca/fatfree", + "description": "A powerful yet easy-to-use PHP micro-framework designed to help you build dynamic and robust Web applications - fast!", + "homepage": "http://fatfreeframework.com/", + "license": "GPL-3.0", + "require": { + "php": ">=5.3.0" + }, + "repositories": [ + { + "type": "vcs", + "url": "https://github.com/bcosca/fatfree" + } + ], + "autoload": { + "files": ["lib/base.php"] + } +} diff --git a/fatfree/config.ini b/fatfree/config.ini new file mode 100644 index 0000000000000000000000000000000000000000..8911dfcc72b1d0cbc1b3ad6b238215ee2266038e --- /dev/null +++ b/fatfree/config.ini @@ -0,0 +1,4 @@ +[globals] + +DEBUG=3 +UI=ui/ diff --git a/fatfree/index.php b/fatfree/index.php new file mode 100644 index 0000000000000000000000000000000000000000..33932e3b65dd73c446c11cdad840855b54066375 --- /dev/null +++ b/fatfree/index.php @@ -0,0 +1,80 @@ +set('DEBUG',1); +if ((float)PCRE_VERSION<7.9) + trigger_error('PCRE version is out of date'); + +$f3->config('config.ini'); + +$f3->route('GET /', + function($f3) { + $classes=array( + 'Base'=> + array( + 'hash', + 'json', + 'session' + ), + 'Cache'=> + array( + 'apc', + 'memcache', + 'wincache', + 'xcache' + ), + 'DB\SQL'=> + array( + 'pdo', + 'pdo_dblib', + 'pdo_mssql', + 'pdo_mysql', + 'pdo_odbc', + 'pdo_pgsql', + 'pdo_sqlite', + 'pdo_sqlsrv' + ), + 'DB\Jig'=> + array('json'), + 'DB\Mongo'=> + array( + 'json', + 'mongo' + ), + 'Auth'=> + array('ldap','pdo'), + 'Bcrypt'=> + array( + 'mcrypt', + 'openssl' + ), + 'Image'=> + array('gd'), + 'Lexicon'=> + array('iconv'), + 'SMTP'=> + array('openssl'), + 'Web'=> + array('curl','openssl','simplexml'), + 'Web\Geo'=> + array('geoip','json'), + 'Web\OpenID'=> + array('json','simplexml'), + 'Web\Pingback'=> + array('dom','xmlrpc') + ); + $f3->set('classes',$classes); + $f3->set('content','welcome.htm'); + echo View::instance()->render('layout.htm'); + } +); + +$f3->route('GET /userref', + function($f3) { + $f3->set('content','userref.htm'); + echo View::instance()->render('layout.htm'); + } +); + +$f3->run(); diff --git a/fatfree/lib/api/annotated.html b/fatfree/lib/api/annotated.html new file mode 100644 index 0000000000000000000000000000000000000000..9fd19f6ec8c42d9cc7f00015e7496a639305b77f --- /dev/null +++ b/fatfree/lib/api/annotated.html @@ -0,0 +1,85 @@ + + + + + + + +Fat-Free Framework: Class List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Class List
+
+
+
Here are the classes, structs, unions and interfaces with brief descriptions:
+
[detail level 123]
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
 NDB
 NJig
 CMapperFlat-file DB mapper
 CSessionJig-managed session handler
 NMongo
 CMapperMongoDB mapper
 CSessionMongoDB-managed session handler
 NSQL
 CMapperSQL data mapper
 CSessionSQL-managed session handler
 CCursorSimple cursor implementation
 CJigFlat-file DB wrapper
 CMongoMongoDB wrapper
 CSQLPDO wrapper
 NWeb
 NGoogle
 CStaticMapGoogle Static Maps API v2 plug-in
 CGeoGeo plug-in
 COpenIDOpenID consumer
 CPingbackPingback 1.0 protocol (client and server) implementation
 CAuditData validator
 CAuthAuthorization/authentication plug-in
 CBaseBase structure
 CBasketSession-based pseudo-mapper
 CBcryptLightweight password hashing library
 CCacheCache engine
 CF3Legacy mode enabler
 CImageImage manipulation tools
 CISOISO language/country codes
 CLogCustom logger
 CMagicPHP magic wrapper
 CMarkdownMarkdown-to-HTML converter
 CMatrixGeneric array utilities
 CPrefabFactory class for single-instance objects
 CPreviewLightweight template engine
 CRegistryContainer for singular object instances
 CSessionCache-based session handler
 CSMTPSMTP plug-in
 CTemplateXML-style template engine
 CTestUnit test kit
 CUTFUnicode string manager
 CViewView handler
 CWebWrapper for various HTTP utilities
+
+
diff --git a/fatfree/lib/api/bc_s.png b/fatfree/lib/api/bc_s.png new file mode 100644 index 0000000000000000000000000000000000000000..fd162ea76db92647e51fbcd742f46c016f9f633d Binary files /dev/null and b/fatfree/lib/api/bc_s.png differ diff --git a/fatfree/lib/api/bdwn.png b/fatfree/lib/api/bdwn.png new file mode 100644 index 0000000000000000000000000000000000000000..7c943f0178f06cc641b5e069ca6ec290369c8023 Binary files /dev/null and b/fatfree/lib/api/bdwn.png differ diff --git a/fatfree/lib/api/classAudit-members.html b/fatfree/lib/api/classAudit-members.html new file mode 100644 index 0000000000000000000000000000000000000000..8579936652a9bc3e3f3f7fb10e636911d54caf4f --- /dev/null +++ b/fatfree/lib/api/classAudit-members.html @@ -0,0 +1,58 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Audit Member List
+
+
+ +

This is the complete list of members for Audit, including all inherited members.

+ + + + + + + + + + + + + + + + + + +
card($id)Audit
email($str, $mx=TRUE)Audit
entropy($str)Audit
instance()Prefabstatic
ipv4($addr)Audit
ipv6($addr)Audit
isbot()Audit
isdesktop()Audit
ismobile()Audit
isprivate($addr)Audit
ispublic($addr)Audit
isreserved($addr)Audit
mod10($id)Audit
UA_Bot (defined in Audit)Audit
UA_Desktop (defined in Audit)Audit
UA_Mobile (defined in Audit)Audit
url($str)Audit
diff --git a/fatfree/lib/api/classAudit.html b/fatfree/lib/api/classAudit.html new file mode 100644 index 0000000000000000000000000000000000000000..f166d2dff48bcbe6f5fbdc8f2c8c09f11e220190 --- /dev/null +++ b/fatfree/lib/api/classAudit.html @@ -0,0 +1,399 @@ + + + + + + + +Fat-Free Framework: Audit Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +List of all members
+
+
Audit Class Reference
+
+
+ +

Data validator. + More...

+
+ + Inheritance diagram for Audit:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 url ($str)
 
 email ($str, $mx=TRUE)
 
 ipv4 ($addr)
 
 ipv6 ($addr)
 
 isprivate ($addr)
 
 isreserved ($addr)
 
 ispublic ($addr)
 
 isdesktop ()
 
 ismobile ()
 
 isbot ()
 
 mod10 ($id)
 
 card ($id)
 
 entropy ($str)
 
+ + + + + + + + +

+Public Attributes

+const UA_Mobile ='android|blackberry|iphone|ipod|palm|windows\s+ce'
 
+const UA_Desktop ='bsd|linux|os\s+[x9]|solaris|windows'
 
+const UA_Bot ='bot|crawl|slurp|spider'
 
+ + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from Prefab
static instance ()
 
+

Detailed Description

+

Data validator.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
Audit::card ( $id)
+
+

Return credit card type if number is valid

Returns
string|FALSE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Audit::email ( $str,
 $mx = TRUE 
)
+
+

Return TRUE if string is a valid e-mail address; Check DNS MX records if specified

Returns
bool
+
Parameters
+ + + +
$strstring
$mxboolean
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::entropy ( $str)
+
+

Return entropy estimate of a password (NIST 800-63)

Returns
int|float
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::ipv4 ( $addr)
+
+

Return TRUE if string is a valid IPV4 address

Returns
bool
+
Parameters
+ + +
$addrstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::ipv6 ( $addr)
+
+

Return TRUE if string is a valid IPV6 address

Returns
bool
+
Parameters
+ + +
$addrstring
+
+
+ +
+
+ +
+
+ + + + + + + +
Audit::isbot ()
+
+

Return TRUE if user agent is a Web bot

Returns
bool
+ +
+
+ +
+
+ + + + + + + +
Audit::isdesktop ()
+
+

Return TRUE if user agent is a desktop browser

Returns
bool
+ +
+
+ +
+
+ + + + + + + +
Audit::ismobile ()
+
+

Return TRUE if user agent is a mobile device

Returns
bool
+ +
+
+ +
+
+ + + + + + + + +
Audit::isprivate ( $addr)
+
+

Return TRUE if IP address is within private range

Returns
bool
+
Parameters
+ + +
$addrstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::ispublic ( $addr)
+
+

Return TRUE if IP address is neither private nor reserved

Returns
bool
+
Parameters
+ + +
$addrstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::isreserved ( $addr)
+
+

Return TRUE if IP address is within reserved range

Returns
bool
+
Parameters
+ + +
$addrstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::mod10 ( $id)
+
+

Return TRUE if specified ID has a valid (Luhn) Mod-10 check digit

Returns
bool
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Audit::url ( $str)
+
+

Return TRUE if string is a valid URL

Returns
bool
+
Parameters
+ + +
$strstring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classAudit.png b/fatfree/lib/api/classAudit.png new file mode 100644 index 0000000000000000000000000000000000000000..f2bb9eb12d86f0b86050b63c8f2eacd13d765e0c Binary files /dev/null and b/fatfree/lib/api/classAudit.png differ diff --git a/fatfree/lib/api/classAuth-members.html b/fatfree/lib/api/classAuth-members.html new file mode 100644 index 0000000000000000000000000000000000000000..9d87f772a5f1bd114b0c2edc52f1cd6e3c89f1df --- /dev/null +++ b/fatfree/lib/api/classAuth-members.html @@ -0,0 +1,54 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Auth Member List
+
+
+ +

This is the complete list of members for Auth, including all inherited members.

+ + + + + + + + + + + + + + +
$argsAuth
$mapperAuth
$storageAuthprotected
__construct($storage, array $args=NULL)Auth
_jig($id, $pw, $realm)Authprotected
_ldap($id, $pw)Authprotected
_mongo($id, $pw, $realm)Authprotected
_smtp($id, $pw)Authprotected
_sql($id, $pw, $realm)Authprotected
basic($func=NULL)Auth
E_LDAP (defined in Auth)Auth
E_SMTP (defined in Auth)Auth
login($id, $pw, $realm=NULL)Auth
diff --git a/fatfree/lib/api/classAuth.html b/fatfree/lib/api/classAuth.html new file mode 100644 index 0000000000000000000000000000000000000000..27fb8d92bc8a56d87ff4ae3371964e2ea61b3707 --- /dev/null +++ b/fatfree/lib/api/classAuth.html @@ -0,0 +1,431 @@ + + + + + + + +Fat-Free Framework: Auth Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
Auth Class Reference
+
+
+ +

Authorization/authentication plug-in. + More...

+ + + + + + + + +

+Public Member Functions

 login ($id, $pw, $realm=NULL)
 
 basic ($func=NULL)
 
 __construct ($storage, array $args=NULL)
 
+ + + + + + + + + + + + +

+Public Attributes

$mapper
 Mapper object.
 
$args
 Storage options.
 
+const E_LDAP ='LDAP connection failure'
 
+const E_SMTP ='SMTP connection failure'
 
+ + + + + + + + + + + +

+Protected Member Functions

 _jig ($id, $pw, $realm)
 
 _mongo ($id, $pw, $realm)
 
 _sql ($id, $pw, $realm)
 
 _ldap ($id, $pw)
 
 _smtp ($id, $pw)
 
+ + + + +

+Protected Attributes

$storage
 Auth storage.
 
+

Detailed Description

+

Authorization/authentication plug-in.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
Auth::__construct ( $storage,
array $args = NULL 
)
+
+

Instantiate class

Returns
object
+
Parameters
+ + + +
$storagestring|object
$argsarray
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Auth::_jig ( $id,
 $pw,
 $realm 
)
+
+protected
+
+

Jig storage handler

Returns
bool
+
Parameters
+ + + + +
$idstring
$pwstring
$realmstring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Auth::_ldap ( $id,
 $pw 
)
+
+protected
+
+

LDAP storage handler

Returns
bool
+
Parameters
+ + + +
$idstring
$pwstring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Auth::_mongo ( $id,
 $pw,
 $realm 
)
+
+protected
+
+

MongoDB storage handler

Returns
bool
+
Parameters
+ + + + +
$idstring
$pwstring
$realmstring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
Auth::_smtp ( $id,
 $pw 
)
+
+protected
+
+

SMTP storage handler

Returns
bool
+
Parameters
+ + + +
$idstring
$pwstring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
Auth::_sql ( $id,
 $pw,
 $realm 
)
+
+protected
+
+

SQL storage handler

Returns
bool
+
Parameters
+ + + + +
$idstring
$pwstring
$realmstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Auth::basic ( $func = NULL)
+
+

HTTP basic auth mechanism

Returns
bool
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Auth::login ( $id,
 $pw,
 $realm = NULL 
)
+
+

Login auth mechanism

Returns
bool
+
Parameters
+ + + + +
$idstring
$pwstring
$realmstring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classBase-members.html b/fatfree/lib/api/classBase-members.html new file mode 100644 index 0000000000000000000000000000000000000000..3202e49b7d06c13c2ec91eb063726871e5162deb --- /dev/null +++ b/fatfree/lib/api/classBase-members.html @@ -0,0 +1,163 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Base Member List
+
+
+ +

This is the complete list of members for Base, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$fallbackBase
$initBase
$languagesBase
__construct()Base
autoload($class)Baseprotected
base64($data, $mime)Base
blacklisted($ip)Base
build($url)Base
call($func, $args=NULL, $hooks='')Base
camelcase($str)Base
chain($funcs, $args=NULL)Base
clean($arg, $tags=NULL)Base
clear($key)Base
compile($str)Base
concat($key, $val)Base
config($file)Base
copy($src, $dst)Base
CSSBase
csv(array $args)Base
decode($str)Base
devoid($key)Base
dump($expr)Base
E_Class (defined in Base)Base
E_Fatal (defined in Base)Base
E_Hive (defined in Base)Base
E_Method (defined in Base)Base
E_Named (defined in Base)Base
E_Open (defined in Base)Base
E_Pattern (defined in Base)Base
E_Routes (defined in Base)Base
encode($str)Base
error($code, $text='', array $trace=NULL)Base
exists($key, &$val=NULL)Base
expire($secs=0)Base
fixslashes($str)Base
flip($key)Base
format()Base
get($key, $args=NULL)Base
GLOBALSBase
hash($str)Base
highlight($text)Base
hive()Base
HTTP_100 (defined in Base)Base
HTTP_101 (defined in Base)Base
HTTP_200 (defined in Base)Base
HTTP_201 (defined in Base)Base
HTTP_202 (defined in Base)Base
HTTP_203 (defined in Base)Base
HTTP_204 (defined in Base)Base
HTTP_205 (defined in Base)Base
HTTP_206 (defined in Base)Base
HTTP_300 (defined in Base)Base
HTTP_301 (defined in Base)Base
HTTP_302 (defined in Base)Base
HTTP_303 (defined in Base)Base
HTTP_304 (defined in Base)Base
HTTP_305 (defined in Base)Base
HTTP_307 (defined in Base)Base
HTTP_400 (defined in Base)Base
HTTP_401 (defined in Base)Base
HTTP_402 (defined in Base)Base
HTTP_403 (defined in Base)Base
HTTP_404 (defined in Base)Base
HTTP_405 (defined in Base)Base
HTTP_406 (defined in Base)Base
HTTP_407 (defined in Base)Base
HTTP_408 (defined in Base)Base
HTTP_409 (defined in Base)Base
HTTP_410 (defined in Base)Base
HTTP_411 (defined in Base)Base
HTTP_412 (defined in Base)Base
HTTP_413 (defined in Base)Base
HTTP_414 (defined in Base)Base
HTTP_415 (defined in Base)Base
HTTP_416 (defined in Base)Base
HTTP_417 (defined in Base)Base
HTTP_500 (defined in Base)Base
HTTP_501 (defined in Base)Base
HTTP_502 (defined in Base)Base
HTTP_503 (defined in Base)Base
HTTP_504 (defined in Base)Base
HTTP_505 (defined in Base)Base
instance()Prefabstatic
language($code)Base
lexicon($path)Base
map($url, $class, $ttl=0, $kbps=0)Base
merge($key, $src)Base
mock($pattern, array $args=NULL, array $headers=NULL, $body=NULL)Base
MODEBase
mset(array $vars, $prefix='', $ttl=0)Base
mutex($id, $func, $args=NULL)Base
PACKAGE (defined in Base)Base
parse($str)Base
pop($key)Base
push($key, $val)Base
read($file, $lf=FALSE)Base
recursive($arg, $func, $stack=NULL)Base
redirect($pattern, $url)Base
ref($key, $add=TRUE)Base
rel($url)Base
relay($funcs, $args=NULL)Base
REQ_AJAX (defined in Base)Base
REQ_SYNC (defined in Base)Base
reroute($url, $permanent=FALSE)Base
route($pattern, $handler, $ttl=0, $kbps=0)Base
run()Base
scrub(&$var, $tags=NULL)Base
serialize($arg)Base
set($key, $val, $ttl=0)Base
shift($key)Base
sign($num)Base
snakecase($str)Base
split($str)Base
status($code)Base
stringify($arg, array $stack=NULL)Base
sync($key)Base
unload($cwd)Base
unserialize($arg)Base
unshift($key, $val)Base
VERBSBase
VERSION (defined in Base)Base
write($file, $data, $append=FALSE)Base
diff --git a/fatfree/lib/api/classBase.html b/fatfree/lib/api/classBase.html new file mode 100644 index 0000000000000000000000000000000000000000..5ac0cde43b9fc5572395910854c90f7935169bf5 --- /dev/null +++ b/fatfree/lib/api/classBase.html @@ -0,0 +1,2171 @@ + + + + + + + +Fat-Free Framework: Base Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +List of all members
+
+
Base Class Reference
+
+
+ +

Base structure. + More...

+
+ + Inheritance diagram for Base:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 sync ($key)
 
 build ($url)
 
 parse ($str)
 
 compile ($str)
 
ref ($key, $add=TRUE)
 
 exists ($key, &$val=NULL)
 
 devoid ($key)
 
 set ($key, $val, $ttl=0)
 
 get ($key, $args=NULL)
 
 clear ($key)
 
 mset (array $vars, $prefix='', $ttl=0)
 
 hive ()
 
 copy ($src, $dst)
 
 concat ($key, $val)
 
 flip ($key)
 
 push ($key, $val)
 
 pop ($key)
 
 unshift ($key, $val)
 
 shift ($key)
 
 merge ($key, $src)
 
 fixslashes ($str)
 
 split ($str)
 
 stringify ($arg, array $stack=NULL)
 
 csv (array $args)
 
 camelcase ($str)
 
 snakecase ($str)
 
 sign ($num)
 
 hash ($str)
 
 base64 ($data, $mime)
 
 encode ($str)
 
 decode ($str)
 
 recursive ($arg, $func, $stack=NULL)
 
 clean ($arg, $tags=NULL)
 
 scrub (&$var, $tags=NULL)
 
 format ()
 
 language ($code)
 
 lexicon ($path)
 
 serialize ($arg)
 
 unserialize ($arg)
 
 status ($code)
 
 expire ($secs=0)
 
 error ($code, $text='', array $trace=NULL)
 
 mock ($pattern, array $args=NULL, array $headers=NULL, $body=NULL)
 
 route ($pattern, $handler, $ttl=0, $kbps=0)
 
 reroute ($url, $permanent=FALSE)
 
 map ($url, $class, $ttl=0, $kbps=0)
 
 redirect ($pattern, $url)
 
 blacklisted ($ip)
 
 run ()
 
 call ($func, $args=NULL, $hooks='')
 
 chain ($funcs, $args=NULL)
 
 relay ($funcs, $args=NULL)
 
 config ($file)
 
 mutex ($id, $func, $args=NULL)
 
 read ($file, $lf=FALSE)
 
 write ($file, $data, $append=FALSE)
 
 highlight ($text)
 
 dump ($expr)
 
 rel ($url)
 
 unload ($cwd)
 
__construct ()
 Bootstrap.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+const GLOBALS ='GET|POST|COOKIE|REQUEST|SESSION|FILES|SERVER|ENV'
 Mapped PHP globals.
 
+const VERBS ='GET|HEAD|POST|PUT|PATCH|DELETE|CONNECT'
 HTTP verbs.
 
+const MODE =0755
 Default directory permissions.
 
+const CSS ='code.css'
 Syntax highlighting stylesheet.
 
$init
 Initial settings.
 
$languages
 Language lookup sequence.
 
$fallback ='en'
 Default fallback language.
 
+const PACKAGE ='Fat-Free Framework'
 
+const VERSION ='3.3.0-Release'
 
+const HTTP_100 ='Continue'
 
+const HTTP_101 ='Switching Protocols'
 
+const HTTP_200 ='OK'
 
+const HTTP_201 ='Created'
 
+const HTTP_202 ='Accepted'
 
+const HTTP_203 ='Non-Authorative Information'
 
+const HTTP_204 ='No Content'
 
+const HTTP_205 ='Reset Content'
 
+const HTTP_206 ='Partial Content'
 
+const HTTP_300 ='Multiple Choices'
 
+const HTTP_301 ='Moved Permanently'
 
+const HTTP_302 ='Found'
 
+const HTTP_303 ='See Other'
 
+const HTTP_304 ='Not Modified'
 
+const HTTP_305 ='Use Proxy'
 
+const HTTP_307 ='Temporary Redirect'
 
+const HTTP_400 ='Bad Request'
 
+const HTTP_401 ='Unauthorized'
 
+const HTTP_402 ='Payment Required'
 
+const HTTP_403 ='Forbidden'
 
+const HTTP_404 ='Not Found'
 
+const HTTP_405 ='Method Not Allowed'
 
+const HTTP_406 ='Not Acceptable'
 
+const HTTP_407 ='Proxy Authentication Required'
 
+const HTTP_408 ='Request Timeout'
 
+const HTTP_409 ='Conflict'
 
+const HTTP_410 ='Gone'
 
+const HTTP_411 ='Length Required'
 
+const HTTP_412 ='Precondition Failed'
 
+const HTTP_413 ='Request Entity Too Large'
 
+const HTTP_414 ='Request-URI Too Long'
 
+const HTTP_415 ='Unsupported Media Type'
 
+const HTTP_416 ='Requested Range Not Satisfiable'
 
+const HTTP_417 ='Expectation Failed'
 
+const HTTP_500 ='Internal Server Error'
 
+const HTTP_501 ='Not Implemented'
 
+const HTTP_502 ='Bad Gateway'
 
+const HTTP_503 ='Service Unavailable'
 
+const HTTP_504 ='Gateway Timeout'
 
+const HTTP_505 ='HTTP Version Not Supported'
 
+const REQ_SYNC =1
 
+const REQ_AJAX =2
 
+const E_Pattern ='Invalid routing pattern: %s'
 
+const E_Named ='Named route does not exist: %s'
 
+const E_Fatal ='Fatal error: %s'
 
+const E_Open ='Unable to open %s'
 
+const E_Routes ='No routes specified'
 
+const E_Class ='Invalid class %s'
 
+const E_Method ='Invalid method %s'
 
+const E_Hive ='Invalid hive key %s'
 
+ + + +

+Protected Member Functions

 autoload ($class)
 
+ + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from Prefab
static instance ()
 
+

Detailed Description

+

Base structure.

+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + +
Base::autoload ( $class)
+
+protected
+
+

Namespace-aware class autoloader

Returns
mixed
+
Parameters
+ + +
$classstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::base64 ( $data,
 $mime 
)
+
+

Return Base64-encoded equivalent

Returns
string
+
Parameters
+ + + +
$datastring
$mimestring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::blacklisted ( $ip)
+
+

Return TRUE if IPv4 address exists in DNSBL

Returns
bool
+
Parameters
+ + +
$ipstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::build ( $url)
+
+

Replace tokenized URL with current route's token values

Returns
string
+
Parameters
+ + +
$urlarray|string
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::call ( $func,
 $args = NULL,
 $hooks = '' 
)
+
+

Execute callback/hooks (supports 'class->method' format)

Returns
mixed|FALSE
+
Parameters
+ + + + +
$funccallback
$argsmixed
$hooksstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::camelcase ( $str)
+
+

Convert snakecase string to camelcase

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::chain ( $funcs,
 $args = NULL 
)
+
+

Execute specified callbacks in succession; Apply same arguments to all callbacks

Returns
array
+
Parameters
+ + + +
$funcsarray|string
$argsmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::clean ( $arg,
 $tags = NULL 
)
+
+

Remove HTML tags (except those enumerated) and non-printable characters to mitigate XSS/code injection attacks

Returns
mixed
+
Parameters
+ + + +
$argmixed
$tagsstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::clear ( $key)
+
+

Unset hive key

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::compile ( $str)
+
+

Convert JS-style token to PHP expression

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::concat ( $key,
 $val 
)
+
+

Concatenate string to hive string variable

Returns
string
+
Parameters
+ + + +
$keystring
$valstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::config ( $file)
+
+

Configure framework according to .ini-style file settings

Returns
NULL
+
Parameters
+ + +
$filestring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::copy ( $src,
 $dst 
)
+
+

Copy contents of hive variable to another

Returns
mixed
+
Parameters
+ + + +
$srcstring
$dststring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::csv (array $args)
+
+

Flatten array values and return as CSV string

Returns
string
+
Parameters
+ + +
$argsarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::decode ( $str)
+
+

Convert HTML entities back to characters

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::devoid ( $key)
+
+

Return TRUE if hive key is empty and not cached

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::dump ( $expr)
+
+

Dump expression with syntax highlighting

Returns
NULL
+
Parameters
+ + +
$exprmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::encode ( $str)
+
+

Convert special characters to HTML entities

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::error ( $code,
 $text = '',
array $trace = NULL 
)
+
+

Log error; Execute ONERROR handler if defined, else display default error page (HTML for synchronous requests, JSON string for AJAX requests)

Returns
NULL
+
Parameters
+ + + + +
$codeint
$textstring
$tracearray
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::exists ( $key,
$val = NULL 
)
+
+

Return TRUE if hive key is set (or return timestamp and TTL if cached)

Returns
bool
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::expire ( $secs = 0)
+
+

Send cache metadata to HTTP client

Returns
NULL
+
Parameters
+ + +
$secsint
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::fixslashes ( $str)
+
+

Convert backslashes to slashes

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::flip ( $key)
+
+

Swap keys and values of hive array variable

Returns
array
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
Base::format ()
+
+

Return locale-aware formatted string

Returns
string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::get ( $key,
 $args = NULL 
)
+
+

Retrieve contents of hive key

Returns
mixed
+
Parameters
+ + + +
$keystring
$argsstring|array
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::hash ( $str)
+
+

Generate 64bit/base36 hash

Returns
string
+
Parameters
+ + +
$str
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::highlight ( $text)
+
+

Apply syntax highlighting

Returns
string
+
Parameters
+ + +
$textstring
+
+
+ +
+
+ +
+
+ + + + + + + +
Base::hive ()
+
+

Publish hive contents

Returns
array
+ +
+
+ +
+
+ + + + + + + + +
Base::language ( $code)
+
+

Assign/auto-detect language

Returns
string
+
Parameters
+ + +
$codestring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::lexicon ( $path)
+
+

Transfer lexicon entries to hive

Returns
array
+
Parameters
+ + +
$pathstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base::map ( $url,
 $class,
 $ttl = 0,
 $kbps = 0 
)
+
+

Provide ReST interface by mapping HTTP verb to class method

Returns
NULL
+
Parameters
+ + + + + +
$urlstring
$classstring
$ttlint
$kbpsint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::merge ( $key,
 $src 
)
+
+

Merge array with hive array variable

Returns
array
+
Parameters
+ + + +
$keystring
$srcstring|array
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base::mock ( $pattern,
array $args = NULL,
array $headers = NULL,
 $body = NULL 
)
+
+

Mock HTTP request

Returns
NULL
+
Parameters
+ + + + + +
$patternstring
$argsarray
$headersarray
$bodystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::mset (array $vars,
 $prefix = '',
 $ttl = 0 
)
+
+

Multi-variable assignment using associative array

Returns
NULL
+
Parameters
+ + + + +
$varsarray
$prefixstring
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::mutex ( $id,
 $func,
 $args = NULL 
)
+
+

Create mutex, invoke callback then drop ownership when done

Returns
mixed
+
Parameters
+ + + + +
$idstring
$funccallback
$argsmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::parse ( $str)
+
+

Parse string containing key-value pairs and use as routing tokens

Returns
NULL
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::pop ( $key)
+
+

Remove last element of hive array variable

Returns
mixed
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::push ( $key,
 $val 
)
+
+

Add element to the end of hive array variable

Returns
mixed
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::read ( $file,
 $lf = FALSE 
)
+
+

Read file (with option to apply Unix LF as standard line ending)

Returns
string
+
Parameters
+ + + +
$filestring
$lfbool
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::recursive ( $arg,
 $func,
 $stack = NULL 
)
+
+

Invoke callback recursively for all data types

Returns
mixed
+
Parameters
+ + + + +
$argmixed
$funccallback
$stackarray
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::redirect ( $pattern,
 $url 
)
+
+

Redirect a route to another URL

Returns
NULL
+
Parameters
+ + + +
$patternstring|array
$urlstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
& Base::ref ( $key,
 $add = TRUE 
)
+
+

Get hive key reference/contents; Add non-existent hive keys, array elements, and object properties by default

Returns
mixed
+
Parameters
+ + + +
$keystring
$addbool
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::rel ( $url)
+
+

Return path relative to the base directory

Returns
string
+
Parameters
+ + +
$urlstring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::relay ( $funcs,
 $args = NULL 
)
+
+

Execute specified callbacks in succession; Relay result of previous callback as argument to the next callback

Returns
array
+
Parameters
+ + + +
$funcsarray|string
$argsmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::reroute ( $url,
 $permanent = FALSE 
)
+
+

Reroute to specified URI

Returns
NULL
+
Parameters
+ + + +
$urlstring
$permanentbool
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
Base::route ( $pattern,
 $handler,
 $ttl = 0,
 $kbps = 0 
)
+
+

Bind handler to route pattern

Returns
NULL
+
Parameters
+ + + + + +
$patternstring|array
$handlercallback
$ttlint
$kbpsint
+
+
+ +
+
+ +
+
+ + + + + + + +
Base::run ()
+
+

Match routes against incoming URI

Returns
NULL
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::scrub ($var,
 $tags = NULL 
)
+
+

Similar to clean(), except that variable is passed by reference

Returns
mixed
+
Parameters
+ + + +
$varmixed
$tagsstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::serialize ( $arg)
+
+

Return string representation of PHP value

Returns
string
+
Parameters
+ + +
$argmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::set ( $key,
 $val,
 $ttl = 0 
)
+
+

Bind value to hive key

Returns
mixed
+
Parameters
+ + + + +
$keystring
$valmixed
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::shift ( $key)
+
+

Remove first element of hive array variable

Returns
mixed
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::sign ( $num)
+
+

Return -1 if specified number is negative, 0 if zero, or 1 if the number is positive

Returns
int
+
Parameters
+ + +
$nummixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::snakecase ( $str)
+
+

Convert camelcase string to snakecase

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::split ( $str)
+
+

Split comma-, semi-colon, or pipe-separated string

Returns
array
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::status ( $code)
+
+

Send HTTP/1.1 status header; Return text equivalent of status code

Returns
string
+
Parameters
+ + +
$codeint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::stringify ( $arg,
array $stack = NULL 
)
+
+

Convert PHP expression/value to compressed exportable string

Returns
string
+
Parameters
+ + + +
$argmixed
$stackarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::sync ( $key)
+
+

Sync PHP global with corresponding hive key

Returns
array
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::unload ( $cwd)
+
+

Execute framework/application shutdown sequence

Returns
NULL
+
Parameters
+ + +
$cwdstring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Base::unserialize ( $arg)
+
+

Return PHP value derived from string

Returns
string
+
Parameters
+ + +
$argmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Base::unshift ( $key,
 $val 
)
+
+

Add element to the beginning of hive array variable

Returns
mixed
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Base::write ( $file,
 $data,
 $append = FALSE 
)
+
+

Exclusive file write

Returns
int|FALSE
+
Parameters
+ + + + +
$filestring
$datamixed
$appendbool
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classBase.png b/fatfree/lib/api/classBase.png new file mode 100644 index 0000000000000000000000000000000000000000..8b95990b5130288c975a1eb78f7e2cde470e8949 Binary files /dev/null and b/fatfree/lib/api/classBase.png differ diff --git a/fatfree/lib/api/classBasket-members.html b/fatfree/lib/api/classBasket-members.html new file mode 100644 index 0000000000000000000000000000000000000000..ad70f434ffacfa49dcef7807cc887b12958a6525 --- /dev/null +++ b/fatfree/lib/api/classBasket-members.html @@ -0,0 +1,62 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Basket Member List
+
+
+ +

This is the complete list of members for Basket, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + +
$idBasket
$itemBasket
$keyBasketprotected
__construct($key='basket')Basket
checkout()Basket
clear($key)Basket
copyfrom($key)Basket
copyto($key)Basket
count()Basket
drop()Basket
dry()Basket
E_Field (defined in Basket)Basket
erase($key, $val)Basket
exists($key)Basket
find($key=NULL, $val=NULL)Basket
findone($key, $val)Basket
get($key)Basket
load($key, $val)Basket
reset()Basket
save()Basket
set($key, $val)Basket
diff --git a/fatfree/lib/api/classBasket.html b/fatfree/lib/api/classBasket.html new file mode 100644 index 0000000000000000000000000000000000000000..02e1e7d3b1e2de7ddd1a0ebeb291f41bf0b6a0fb --- /dev/null +++ b/fatfree/lib/api/classBasket.html @@ -0,0 +1,517 @@ + + + + + + + +Fat-Free Framework: Basket Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
Basket Class Reference
+
+
+ +

Session-based pseudo-mapper. + More...

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 find ($key=NULL, $val=NULL)
 
 findone ($key, $val)
 
 load ($key, $val)
 
 dry ()
 
 count ()
 
 save ()
 
 erase ($key, $val)
 
 reset ()
 
 drop ()
 
 copyfrom ($key)
 
 copyto ($key)
 
 checkout ()
 
 __construct ($key='basket')
 
+ + + + + + + + + + +

+Public Attributes

$id
 Current item identifier.
 
$item =array()
 Current item contents.
 
+const E_Field ='Undefined field %s'
 
+ + + + +

+Protected Attributes

$key
 Session key.
 
+

Detailed Description

+

Session-based pseudo-mapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
Basket::__construct ( $key = 'basket')
+
+

Instantiate class

Returns
void
+
Parameters
+ + +
$keystring
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
Basket::checkout ()
+
+

Check out basket contents

Returns
array
+ +
+
+ +
+
+ + + + + + + + +
Basket::clear ( $key)
+
+

Delete field

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Basket::copyfrom ( $key)
+
+

Hydrate item using hive array variable

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Basket::copyto ( $key)
+
+

Populate hive array variable with item contents

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
Basket::count ()
+
+

Return number of items in basket

Returns
int
+ +
+
+ +
+
+ + + + + + + +
Basket::drop ()
+
+

Empty basket

Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
Basket::dry ()
+
+

Return TRUE if current item is empty/undefined

Returns
bool
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Basket::erase ( $key,
 $val 
)
+
+

Erase item matching key/value pair

Returns
bool
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Basket::exists ( $key)
+
+

Return TRUE if field is defined

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Basket::find ( $key = NULL,
 $val = NULL 
)
+
+

Return items that match key/value pair; If no key/value pair specified, return all items

Returns
array|FALSE
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Basket::findone ( $key,
 $val 
)
+
+

Return first item that matches key/value pair

Returns
object|FALSE
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Basket::get ( $key)
+
+

Retrieve value of field

Returns
scalar|FALSE
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Basket::load ( $key,
 $val 
)
+
+

Map current item to matching key/value pair

Returns
array
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + +
Basket::reset ()
+
+

Reset cursor

Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
Basket::save ()
+
+

Save current item

Returns
array
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Basket::set ( $key,
 $val 
)
+
+

Assign value to field

Returns
scalar|FALSE
+
Parameters
+ + + +
$keystring
$valscalar
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classBcrypt-members.html b/fatfree/lib/api/classBcrypt-members.html new file mode 100644 index 0000000000000000000000000000000000000000..10d90bfcd0bed6d583bf692f58cc674f1ee36fd7 --- /dev/null +++ b/fatfree/lib/api/classBcrypt-members.html @@ -0,0 +1,48 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Bcrypt Member List
+
+
+ +

This is the complete list of members for Bcrypt, including all inherited members.

+ + + + + + + + +
COSTBcrypt
E_CostArg (defined in Bcrypt)Bcrypt
E_SaltArg (defined in Bcrypt)Bcrypt
hash($pw, $salt=NULL, $cost=self::COST)Bcrypt
instance()Prefabstatic
needs_rehash($hash, $cost=self::COST)Bcrypt
verify($pw, $hash)Bcrypt
diff --git a/fatfree/lib/api/classBcrypt.html b/fatfree/lib/api/classBcrypt.html new file mode 100644 index 0000000000000000000000000000000000000000..6a9834a892870f0a9c5e1f8fe56b8211202b80cb --- /dev/null +++ b/fatfree/lib/api/classBcrypt.html @@ -0,0 +1,201 @@ + + + + + + + +Fat-Free Framework: Bcrypt Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +List of all members
+
+
Bcrypt Class Reference
+
+
+ +

Lightweight password hashing library. + More...

+
+ + Inheritance diagram for Bcrypt:
+
+
+ + + + + + + + + +

+Public Member Functions

 hash ($pw, $salt=NULL, $cost=self::COST)
 
 needs_rehash ($hash, $cost=self::COST)
 
 verify ($pw, $hash)
 
+ + + + + + + + + +

+Public Attributes

+const COST =10
 Default cost.
 
+const E_CostArg ='Invalid cost parameter'
 
+const E_SaltArg ='Salt must be at least 22 alphanumeric characters'
 
+ + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from Prefab
static instance ()
 
+

Detailed Description

+

Lightweight password hashing library.

+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Bcrypt::hash ( $pw,
 $salt = NULL,
 $cost = self::COST 
)
+
+

Generate bcrypt hash of string

Returns
string|FALSE
+
Parameters
+ + + + +
$pwstring
$saltstring
$costint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Bcrypt::needs_rehash ( $hash,
 $cost = self::COST 
)
+
+

Check if password is still strong enough

Returns
bool
+
Parameters
+ + + +
$hashstring
$costint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Bcrypt::verify ( $pw,
 $hash 
)
+
+

Verify password against hash using timing attack resistant approach

Returns
bool
+
Parameters
+ + + +
$pwstring
$hashstring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classBcrypt.png b/fatfree/lib/api/classBcrypt.png new file mode 100644 index 0000000000000000000000000000000000000000..caea9bec3fe53bad2b5593f4509485ed17f4417b Binary files /dev/null and b/fatfree/lib/api/classBcrypt.png differ diff --git a/fatfree/lib/api/classCache-members.html b/fatfree/lib/api/classCache-members.html new file mode 100644 index 0000000000000000000000000000000000000000..e9ab92f61e95c055a2d66c175b44cc2764069f90 --- /dev/null +++ b/fatfree/lib/api/classCache-members.html @@ -0,0 +1,52 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
Cache Member List
+
+
+ +

This is the complete list of members for Cache, including all inherited members.

+ + + + + + + + + + + + +
$dsnCacheprotected
$prefixCache
$refCache
__construct($dsn=FALSE)Cache
clear($key)Cache
exists($key, &$val=NULL)Cache
get($key)Cache
instance()Prefabstatic
load($dsn)Cache
reset($suffix=NULL, $lifetime=0)Cache
set($key, $val, $ttl=0)Cache
diff --git a/fatfree/lib/api/classCache.html b/fatfree/lib/api/classCache.html new file mode 100644 index 0000000000000000000000000000000000000000..0cde884c1a163b19d8b08af6305764fb572a8ec9 --- /dev/null +++ b/fatfree/lib/api/classCache.html @@ -0,0 +1,307 @@ + + + + + + + +Fat-Free Framework: Cache Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
Cache Class Reference
+
+
+ +

Cache engine. + More...

+
+ + Inheritance diagram for Cache:
+
+
+ + + + + + + + + + + + + + + + + +

+Public Member Functions

 exists ($key, &$val=NULL)
 
 set ($key, $val, $ttl=0)
 
 get ($key)
 
 clear ($key)
 
 reset ($suffix=NULL, $lifetime=0)
 
 load ($dsn)
 
 __construct ($dsn=FALSE)
 
+ + + + + + + +

+Public Attributes

$prefix
 Prefix for cache entries.
 
$ref
 MemCache or Redis object.
 
+ + + + +

+Protected Attributes

$dsn
 Cache DSN.
 
+ + + + +

+Additional Inherited Members

- Static Public Member Functions inherited from Prefab
static instance ()
 
+

Detailed Description

+

Cache engine.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + +
Cache::__construct ( $dsn = FALSE)
+
+

Class constructor

Returns
object
+
Parameters
+ + +
$dsnbool|string
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
Cache::clear ( $key)
+
+

Delete cache entry

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Cache::exists ( $key,
$val = NULL 
)
+
+

Return timestamp and TTL of cache entry or FALSE if not found

Returns
array|FALSE
+
Parameters
+ + + +
$keystring
$valmixed
+
+
+ +
+
+ +
+
+ + + + + + + + +
Cache::get ( $key)
+
+

Retrieve value of cache entry

Returns
mixed|FALSE
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + +
Cache::load ( $dsn)
+
+

Load/auto-detect cache backend

Returns
string
+
Parameters
+ + +
$dsnbool|string
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
Cache::reset ( $suffix = NULL,
 $lifetime = 0 
)
+
+

Clear contents of cache backend

Returns
bool
+
Parameters
+ + + +
$suffixstring
$lifetimeint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
Cache::set ( $key,
 $val,
 $ttl = 0 
)
+
+

Store value in cache

Returns
mixed|FALSE
+
Parameters
+ + + + +
$keystring
$valmixed
$ttlint
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classCache.png b/fatfree/lib/api/classCache.png new file mode 100644 index 0000000000000000000000000000000000000000..4093d229535da4c5abb83528a3540214a743e6d2 Binary files /dev/null and b/fatfree/lib/api/classCache.png differ diff --git a/fatfree/lib/api/classDB_1_1Cursor-members.html b/fatfree/lib/api/classDB_1_1Cursor-members.html new file mode 100644 index 0000000000000000000000000000000000000000..e1bbbdfba68ed42822b5159f68687d7db25773c7 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Cursor-members.html @@ -0,0 +1,92 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Cursor Member List
+
+
+ +

This is the complete list of members for DB\Cursor, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$ptrDB\Cursor
$queryDB\Cursorprotected
$triggerDB\Cursor
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\Cursor
clear($key)Magic
copyfrom($key, $func=NULL)DB\Cursor
copyto($key)DB\Cursor
count($filter=NULL, $ttl=0)DB\Cursor
dbtype()DB\Cursor
dry()DB\Cursor
E_Field (defined in DB\Cursor)DB\Cursor
erase()DB\Cursor
exists($key)Magic
find($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)Magic
insert()DB\Cursor
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
reset()DB\Cursor
save()DB\Cursor
set($key, $val)Magic
skip($ofs=1)DB\Cursor
update()DB\Cursor
diff --git a/fatfree/lib/api/classDB_1_1Cursor.html b/fatfree/lib/api/classDB_1_1Cursor.html new file mode 100644 index 0000000000000000000000000000000000000000..a53cdf9470508d2342fa02398f37909c4281e405 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Cursor.html @@ -0,0 +1,987 @@ + + + + + + + +Fat-Free Framework: DB\Cursor Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
DB\Cursor Class Reference
+
+
+ +

Simple cursor implementation. + More...

+
+ + Inheritance diagram for DB\Cursor:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + +

+Public Attributes

$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + + +

+Protected Attributes

$query =array()
 Query results.
 
+

Detailed Description

+

Simple cursor implementation.

+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\Cursor::aftererase ( $func)
+
+

Define aftererase trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::afterinsert ( $func)
+
+

Define afterinsert trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::afterupdate ( $func)
+
+

Define afterupdate trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeerase ( $func)
+
+

Define beforeerase trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeinsert ( $func)
+
+

Define beforeinsert trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::beforeupdate ( $func)
+
+

Define beforeupdate trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\Cursor::cast ( $obj = NULL)
+
+abstract
+
+

Return fields of mapper object as an associative array

Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DB\Cursor::copyfrom ( $key,
 $func = NULL 
)
+
+abstract
+
+

Hydrate mapper object using hive array variable

Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\Cursor::copyto ( $key)
+
+abstract
+
+

Populate hive array variable with mapper fields

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DB\Cursor::count ( $filter = NULL,
 $ttl = 0 
)
+
+abstract
+
+

Count records that match criteria

Returns
int
+
Parameters
+ + + +
$filterarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::dbtype ()
+
+abstract
+
+

Return database type

Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::dry ()
+
+

Return TRUE if current cursor position is not mapped to any record

Returns
bool
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::erase ()
+
+

Delete current record

Returns
int|bool
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+abstract
+
+

Return records (array of mapper objects) that match criteria

Returns
array
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::findone ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return first record (mapper object) that matches criteria

Returns
object|FALSE
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::first ()
+
+

Map to first record in cursor

Returns
mixed
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::insert ()
+
+abstract
+
+

Insert new record

Returns
array
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::last ()
+
+

Map to last record in cursor

Returns
mixed
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::load ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Map to first record that matches criteria

Returns
array|FALSE
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::loaded ()
+
+

Return the count of records loaded

Returns
int
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::next ()
+
+

Map next record

Returns
mixed
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onerase ( $func)
+
+

Define onerase trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::oninsert ( $func)
+
+

Define oninsert trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onload ( $func)
+
+

Define onload trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::onupdate ( $func)
+
+

Define onupdate trigger

Returns
callback
+
Parameters
+ + +
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\Cursor::paginate ( $pos = 0,
 $size = 10,
 $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return array containing subset of records matching criteria, total number of records in superset, specified limit, number of subsets available, and actual subset position

Returns
array
+
Parameters
+ + + + + + +
$posint
$sizeint
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::prev ()
+
+

Map previous record

Returns
mixed
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::reset ()
+
+

Reset cursor

Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
DB\Cursor::save ()
+
+

Save mapped record

Returns
mixed
+ +
+
+ +
+
+ + + + + + + + +
DB\Cursor::skip ( $ofs = 1)
+
+

Map to nth record relative to current cursor position

Returns
mixed
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + +
DB\Cursor::update ()
+
+abstract
+
+

Update current record

Returns
array
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Cursor.png b/fatfree/lib/api/classDB_1_1Cursor.png new file mode 100644 index 0000000000000000000000000000000000000000..858faba1c7e4e205ba65360e06c820c1c6720cc5 Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Cursor.png differ diff --git a/fatfree/lib/api/classDB_1_1Jig-members.html b/fatfree/lib/api/classDB_1_1Jig-members.html new file mode 100644 index 0000000000000000000000000000000000000000..a31de791a6f624851e1d89cf5f66f754838f576a --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig-members.html @@ -0,0 +1,59 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Jig Member List
+
+
+ +

This is the complete list of members for DB\Jig, including all inherited members.

+ + + + + + + + + + + + + + + +
$dirDB\Jig
$formatDB\Jig
$logDB\Jig
$uuidDB\Jigprotected
__construct($dir, $format=self::FORMAT_JSON)DB\Jig
dir()DB\Jig
drop()DB\Jig
FORMAT_JSON (defined in DB\Jig)DB\Jig
FORMAT_Serialized (defined in DB\Jig)DB\Jig
jot($frame)DB\Jig
log()DB\Jig
read($file)DB\Jig
uuid()DB\Jig
write($file, array $data=NULL)DB\Jig
diff --git a/fatfree/lib/api/classDB_1_1Jig.html b/fatfree/lib/api/classDB_1_1Jig.html new file mode 100644 index 0000000000000000000000000000000000000000..2fed64986d0ebed6b38f18334e4c6f8562744c44 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig.html @@ -0,0 +1,283 @@ + + + + + + + +Fat-Free Framework: DB\Jig Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
DB\Jig Class Reference
+
+
+ +

Flat-file DB wrapper. + More...

+ + + + + + + + + + + + + + + + + + +

+Public Member Functions

 read ($file)
 
 write ($file, array $data=NULL)
 
 dir ()
 
 uuid ()
 
 log ()
 
 jot ($frame)
 
 drop ()
 
 __construct ($dir, $format=self::FORMAT_JSON)
 
+ + + + + + + + + + + + + + + +

+Public Attributes

$dir
 Storage location.
 
$format
 Current storage format.
 
$log
 Jig log.
 
+const FORMAT_JSON =0
 
+const FORMAT_Serialized =1
 
+ + + + +

+Protected Attributes

$uuid
 UUID.
 
+

Detailed Description

+

Flat-file DB wrapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig::__construct ( $dir,
 $format = self::FORMAT_JSON 
)
+
+

Instantiate class

Parameters
+ + + +
$dirstring
$formatint
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
DB\Jig::dir ()
+
+

Return directory

Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\Jig::drop ()
+
+

Clean storage

Returns
NULL
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig::jot ( $frame)
+
+

Jot down log entry

Returns
NULL
+
Parameters
+ + +
$framestring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig::log ()
+
+

Return SQL profiler results

Returns
string
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig::read ( $file)
+
+

Read data from file

Returns
array
+
Parameters
+ + +
$filestring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig::uuid ()
+
+

Return UUID

Returns
string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig::write ( $file,
array $data = NULL 
)
+
+

Write data to file

Returns
int
+
Parameters
+ + + +
$filestring
$dataarray
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Mapper-members.html b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper-members.html new file mode 100644 index 0000000000000000000000000000000000000000..fb6820e472e423543af5b9e59785c50e8cd48e49 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper-members.html @@ -0,0 +1,102 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Jig\Mapper Member List
+
+
+ +

This is the complete list of members for DB\Jig\Mapper, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$dbDB\Jig\Mapperprotected
$documentDB\Jig\Mapper
$fileDB\Jig\Mapper
$idDB\Jig\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$triggerDB\Cursor
__construct(\DB\Jig $db, $file)DB\Jig\Mapper
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\Jig\Mapper
clear($key)DB\Jig\Mapper
copyfrom($key, $func=NULL)DB\Jig\Mapper
copyto($key)DB\Jig\Mapper
count($filter=NULL, $ttl=0)DB\Jig\Mapper
dbtype()DB\Jig\Mapper
dry()DB\Cursor
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\Jig\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\Jig\Mapper
factory($id, $row)DB\Jig\Mapperprotected
fields()DB\Jig\Mapper
find($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE)DB\Jig\Mapper
DB::Cursor::find($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\Jig\Mapper
insert()DB\Jig\Mapper
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
reset()DB\Jig\Mapper
save()DB\Cursor
set($key, $val)DB\Jig\Mapper
skip($ofs=1)DB\Jig\Mapper
token($str)DB\Jig\Mapper
update()DB\Jig\Mapper
diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.html b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.html new file mode 100644 index 0000000000000000000000000000000000000000..e497bba4a2f754275e4a97f3ef47a4cdbd97dfe5 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.html @@ -0,0 +1,733 @@ + + + + + + + +Fat-Free Framework: DB\Jig\Mapper Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
DB\Jig\Mapper Class Reference
+
+
+ +

Flat-file DB mapper. + More...

+
+ + Inheritance diagram for DB\Jig\Mapper:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 cast ($obj=NULL)
 
 token ($str)
 
 find ($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 fields ()
 
 __construct (\DB\Jig $db, $file)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

$file
 Data file.
 
$id
 Document identifier.
 
$document =array()
 Document contents.
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + +

+Protected Member Functions

 factory ($id, $row)
 
+ + + + + + + + +

+Protected Attributes

$db
 Flat-file DB wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+

Detailed Description

+

Flat-file DB mapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::__construct (\DB\Jig $db,
 $file 
)
+
+

Instantiate class

Returns
void
+
Parameters
+ + + +
$dbobject
$filestring
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\Jig\Mapper::cast ( $obj = NULL)
+
+

Return fields of mapper object as an associative array

Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::clear ( $key)
+
+

Delete field

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::copyfrom ( $key,
 $func = NULL 
)
+
+

Hydrate mapper object using hive array variable

Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::copyto ( $key)
+
+

Populate hive array variable with mapper fields

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::count ( $filter = NULL,
 $ttl = 0 
)
+
+

Count records that match criteria

Returns
int
+
Parameters
+ + + +
$filterarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Mapper::dbtype ()
+
+

Return database type

Returns
string
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::erase ( $filter = NULL)
+
+

Delete current record

Returns
bool
+
Parameters
+ + +
$filterarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::exists ( $key)
+
+

Return TRUE if field is defined

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::factory ( $id,
 $row 
)
+
+protected
+
+

Convert array to mapper object

Returns
object
+
Parameters
+ + + +
$idstring
$rowarray
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Mapper::fields ()
+
+

Return field names

Returns
array
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0,
 $log = TRUE 
)
+
+

Return records that match criteria

Returns
array|FALSE
+
Parameters
+ + + + + +
$filterarray
$optionsarray
$ttlint
$logbool
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::get ( $key)
+
+

Retrieve value of field

Returns
scalar|FALSE
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Mapper::insert ()
+
+

Insert new record

Returns
array
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Mapper::reset ()
+
+

Reset cursor

Returns
NULL
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Mapper::set ( $key,
 $val 
)
+
+

Assign value to field

Returns
scalar|FALSE
+
Parameters
+ + + +
$keystring
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::skip ( $ofs = 1)
+
+

Return record at specified offset using criteria of previous load() call and make it active

Returns
array
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Mapper::token ( $str)
+
+

Convert tokens in string expression to variable names

Returns
string
+
Parameters
+ + +
$strstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Mapper::update ()
+
+

Update current record

Returns
array
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.png b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.png new file mode 100644 index 0000000000000000000000000000000000000000..b428aa13de96992aeeda9a8c79dee1d1ae1daafc Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Jig_1_1Mapper.png differ diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Session-members.html b/fatfree/lib/api/classDB_1_1Jig_1_1Session-members.html new file mode 100644 index 0000000000000000000000000000000000000000..6d89d2b749639f5a3ecc5e69295f01189a3928de --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig_1_1Session-members.html @@ -0,0 +1,113 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Jig\Session Member List
+
+
+ +

This is the complete list of members for DB\Jig\Session, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$dbDB\Jig\Mapperprotected
$documentDB\Jig\Mapper
$fileDB\Jig\Mapper
$idDB\Jig\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$sidDB\Jig\Sessionprotected
$triggerDB\Cursor
__construct(\DB\Jig $db, $table='sessions')DB\Jig\Session
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
agent()DB\Jig\Session
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\Jig\Mapper
cleanup($max)DB\Jig\Session
clear($key)DB\Jig\Mapper
close()DB\Jig\Session
copyfrom($key, $func=NULL)DB\Jig\Mapper
copyto($key)DB\Jig\Mapper
count($filter=NULL, $ttl=0)DB\Jig\Mapper
csrf()DB\Jig\Session
dbtype()DB\Jig\Mapper
destroy($id)DB\Jig\Session
dry()DB\Cursor
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\Jig\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\Jig\Mapper
factory($id, $row)DB\Jig\Mapperprotected
fields()DB\Jig\Mapper
find($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE)DB\Jig\Mapper
DB::Cursor::find($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\Jig\Mapper
insert()DB\Jig\Mapper
ip()DB\Jig\Session
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
open($path, $name)DB\Jig\Session
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
read($id)DB\Jig\Session
reset()DB\Jig\Mapper
save()DB\Cursor
set($key, $val)DB\Jig\Mapper
skip($ofs=1)DB\Jig\Mapper
stamp()DB\Jig\Session
token($str)DB\Jig\Mapper
update()DB\Jig\Mapper
write($id, $data)DB\Jig\Session
diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Session.html b/fatfree/lib/api/classDB_1_1Jig_1_1Session.html new file mode 100644 index 0000000000000000000000000000000000000000..3869ae4f3c7325097a83838524888dbff01370f5 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Jig_1_1Session.html @@ -0,0 +1,518 @@ + + + + + + + +Fat-Free Framework: DB\Jig\Session Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
DB\Jig\Session Class Reference
+
+
+ +

Jig-managed session handler. + More...

+
+ + Inheritance diagram for DB\Jig\Session:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 open ($path, $name)
 
 close ()
 
 read ($id)
 
 write ($id, $data)
 
 destroy ($id)
 
 cleanup ($max)
 
 csrf ()
 
 ip ()
 
 stamp ()
 
 agent ()
 
 __construct (\DB\Jig $db, $table='sessions')
 
- Public Member Functions inherited from DB\Jig\Mapper
 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 cast ($obj=NULL)
 
 token ($str)
 
 find ($filter=NULL, array $options=NULL, $ttl=0, $log=TRUE)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 fields ()
 
 __construct (\DB\Jig $db, $file)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + +

+Protected Attributes

$sid
 Session ID.
 
- Protected Attributes inherited from DB\Jig\Mapper
$db
 Flat-file DB wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Attributes inherited from DB\Jig\Mapper
$file
 Data file.
 
$id
 Document identifier.
 
$document =array()
 Document contents.
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
- Protected Member Functions inherited from DB\Jig\Mapper
 factory ($id, $row)
 
+

Detailed Description

+

Jig-managed session handler.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Session::__construct (\DB\Jig $db,
 $table = 'sessions' 
)
+
+

Instantiate class

Parameters
+ + + +
$dbobject
$tablestring
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
DB\Jig\Session::agent ()
+
+

Return HTTP user agent

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Session::cleanup ( $max)
+
+

Garbage collector

Returns
TRUE
+
Parameters
+ + +
$maxint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Session::close ()
+
+

Close session

Returns
TRUE
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Session::csrf ()
+
+

Return anti-CSRF token

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Session::destroy ( $id)
+
+

Destroy session

Returns
TRUE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Session::ip ()
+
+

Return IP address

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Session::open ( $path,
 $name 
)
+
+

Open session

Returns
TRUE
+
Parameters
+ + + +
$pathstring
$namestring
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Jig\Session::read ( $id)
+
+

Return session data in serialized format

Returns
string|FALSE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Jig\Session::stamp ()
+
+

Return Unix timestamp

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Jig\Session::write ( $id,
 $data 
)
+
+

Write session data

Returns
TRUE
+
Parameters
+ + + +
$idstring
$datastring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Jig_1_1Session.png b/fatfree/lib/api/classDB_1_1Jig_1_1Session.png new file mode 100644 index 0000000000000000000000000000000000000000..47ea9513447dfd4255fc70a73829ac0c91a67a6d Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Jig_1_1Session.png differ diff --git a/fatfree/lib/api/classDB_1_1Mongo-members.html b/fatfree/lib/api/classDB_1_1Mongo-members.html new file mode 100644 index 0000000000000000000000000000000000000000..e3e9075820944fe54a13dd911ce8f6f31840f453 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo-members.html @@ -0,0 +1,56 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Mongo Member List
+
+
+ +

This is the complete list of members for DB\Mongo, including all inherited members.

+ + + + + + + + + + + + +
$dbDB\Mongo
$dsnDB\Mongo
$logDB\Mongo
$uuidDB\Mongoprotected
__call($func, array $args)DB\Mongo
__construct($dsn, $dbname, array $options=NULL)DB\Mongo
drop()DB\Mongo
dsn()DB\Mongo
E_Profiler (defined in DB\Mongo)DB\Mongo
log()DB\Mongo
uuid()DB\Mongo
diff --git a/fatfree/lib/api/classDB_1_1Mongo.html b/fatfree/lib/api/classDB_1_1Mongo.html new file mode 100644 index 0000000000000000000000000000000000000000..c1dd931240e56e2b6f3a3eae55e2c2ed2e29352a --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo.html @@ -0,0 +1,237 @@ + + + + + + + +Fat-Free Framework: DB\Mongo Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
DB\Mongo Class Reference
+
+
+ +

MongoDB wrapper. + More...

+ + + + + + + + + + + + + + +

+Public Member Functions

 dsn ()
 
 uuid ()
 
 log ()
 
 drop ()
 
 __call ($func, array $args)
 
 __construct ($dsn, $dbname, array $options=NULL)
 
+ + + + + + + + + + + + + +

+Public Attributes

$dsn
 Data source name.
 
$db
 MongoDB object.
 
$log
 MongoDB log.
 
+const E_Profiler ='MongoDB profiler is disabled'
 
+ + + + +

+Protected Attributes

$uuid
 UUID.
 
+

Detailed Description

+

MongoDB wrapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Mongo::__construct ( $dsn,
 $dbname,
array $options = NULL 
)
+
+

Instantiate class

Parameters
+ + + + +
$dsnstring
$dbnamestring
$optionsarray
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo::__call ( $func,
array $args 
)
+
+

Redirect call to MongoDB object

Returns
mixed
+
Parameters
+ + + +
$funcstring
$argsarray
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo::drop ()
+
+

Intercept native call to re-enable profiler

Returns
int
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo::dsn ()
+
+

Return data source name

Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo::log ()
+
+

Return MongoDB profiler results

Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo::uuid ()
+
+

Return UUID

Returns
string
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Mongo.png b/fatfree/lib/api/classDB_1_1Mongo.png new file mode 100644 index 0000000000000000000000000000000000000000..f16e7b6e94fb1f76721779190373f5603715073f Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Mongo.png differ diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper-members.html b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper-members.html new file mode 100644 index 0000000000000000000000000000000000000000..4696f6d42ae86de9d64e0887b84f4c0a8310059d --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper-members.html @@ -0,0 +1,102 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Mongo\Mapper Member List
+
+
+ +

This is the complete list of members for DB\Mongo\Mapper, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$collectionDB\Mongo\Mapper
$cursorDB\Mongo\Mapper
$dbDB\Mongo\Mapperprotected
$documentDB\Mongo\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$triggerDB\Cursor
__construct(\DB\Mongo $db, $collection)DB\Mongo\Mapper
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\Mongo\Mapper
clear($key)DB\Mongo\Mapper
copyfrom($key, $func=NULL)DB\Mongo\Mapper
copyto($key)DB\Mongo\Mapper
count($filter=NULL, $ttl=0)DB\Mongo\Mapper
cursor()DB\Mongo\Mapper
dbtype()DB\Mongo\Mapper
dry()DB\Cursor
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\Mongo\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\Mongo\Mapper
factory($row)DB\Mongo\Mapperprotected
fields()DB\Mongo\Mapper
find($filter=NULL, array $options=NULL, $ttl=0)DB\Mongo\Mapper
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\Mongo\Mapper
insert()DB\Mongo\Mapper
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
reset()DB\Mongo\Mapper
save()DB\Cursor
select($fields=NULL, $filter=NULL, array $options=NULL, $ttl=0)DB\Mongo\Mapper
set($key, $val)DB\Mongo\Mapper
skip($ofs=1)DB\Mongo\Mapper
update()DB\Mongo\Mapper
diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.html b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.html new file mode 100644 index 0000000000000000000000000000000000000000..bf7e0c921ad8e9ea12fb34052a1feefc7a26f084 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.html @@ -0,0 +1,758 @@ + + + + + + + +Fat-Free Framework: DB\Mongo\Mapper Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
DB\Mongo\Mapper Class Reference
+
+
+ +

MongoDB mapper. + More...

+
+ + Inheritance diagram for DB\Mongo\Mapper:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 cast ($obj=NULL)
 
 select ($fields=NULL, $filter=NULL, array $options=NULL, $ttl=0)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 fields ()
 
 cursor ()
 
 __construct (\DB\Mongo $db, $collection)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

$collection
 Mongo collection.
 
$document =array()
 Mongo document.
 
$cursor
 Mongo cursor.
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + +

+Protected Member Functions

 factory ($row)
 
+ + + + + + + + +

+Protected Attributes

$db
 MongoDB wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+

Detailed Description

+

MongoDB mapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::__construct (\DB\Mongo $db,
 $collection 
)
+
+

Instantiate class

Returns
void
+
Parameters
+ + + +
$dbobject
$collectionstring
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::cast ( $obj = NULL)
+
+

Return fields of mapper object as an associative array

Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::clear ( $key)
+
+

Delete field

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::copyfrom ( $key,
 $func = NULL 
)
+
+

Hydrate mapper object using hive array variable

Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::copyto ( $key)
+
+

Populate hive array variable with mapper fields

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::count ( $filter = NULL,
 $ttl = 0 
)
+
+

Count records that match criteria

Returns
int
+
Parameters
+ + + +
$filterarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::cursor ()
+
+

Return the cursor from last query

Returns
object|NULL
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::dbtype ()
+
+

Return database type

Returns
string
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::erase ( $filter = NULL)
+
+

Delete current record

Returns
bool
+
Parameters
+ + +
$filterarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::exists ( $key)
+
+

Return TRUE if field is defined

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\Mongo\Mapper::factory ( $row)
+
+protected
+
+

Convert array to mapper object

Returns
object
+
Parameters
+ + +
$rowarray
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::fields ()
+
+

Return field names

Returns
array
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return records that match criteria

Returns
array
+
Parameters
+ + + + +
$filterarray
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::get ( $key)
+
+

Retrieve value of field

Returns
scalar|FALSE
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::insert ()
+
+

Insert new record

Returns
array
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::reset ()
+
+

Reset cursor

Returns
NULL
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::select ( $fields = NULL,
 $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Build query and execute

Returns
array
+
Parameters
+ + + + + +
$fieldsstring
$filterarray
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Mapper::set ( $key,
 $val 
)
+
+

Assign value to field

Returns
scalar|FALSE
+
Parameters
+ + + +
$keystring
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Mapper::skip ( $ofs = 1)
+
+

Return record at specified offset using criteria of previous load() call and make it active

Returns
array
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Mapper::update ()
+
+

Update current record

Returns
array
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.png b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.png new file mode 100644 index 0000000000000000000000000000000000000000..6282b76c205f09a5245e8dc15049fb8e3317e303 Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Mongo_1_1Mapper.png differ diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Session-members.html b/fatfree/lib/api/classDB_1_1Mongo_1_1Session-members.html new file mode 100644 index 0000000000000000000000000000000000000000..bff086076b187ee70d32eb4c0db3ae125495f40e --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo_1_1Session-members.html @@ -0,0 +1,113 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\Mongo\Session Member List
+
+
+ +

This is the complete list of members for DB\Mongo\Session, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$collectionDB\Mongo\Mapper
$cursorDB\Mongo\Mapper
$dbDB\Mongo\Mapperprotected
$documentDB\Mongo\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$sidDB\Mongo\Sessionprotected
$triggerDB\Cursor
__construct(\DB\Mongo $db, $table='sessions')DB\Mongo\Session
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
agent()DB\Mongo\Session
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\Mongo\Mapper
cleanup($max)DB\Mongo\Session
clear($key)DB\Mongo\Mapper
close()DB\Mongo\Session
copyfrom($key, $func=NULL)DB\Mongo\Mapper
copyto($key)DB\Mongo\Mapper
count($filter=NULL, $ttl=0)DB\Mongo\Mapper
csrf()DB\Mongo\Session
cursor()DB\Mongo\Mapper
dbtype()DB\Mongo\Mapper
destroy($id)DB\Mongo\Session
dry()DB\Cursor
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\Mongo\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\Mongo\Mapper
factory($row)DB\Mongo\Mapperprotected
fields()DB\Mongo\Mapper
find($filter=NULL, array $options=NULL, $ttl=0)DB\Mongo\Mapper
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\Mongo\Mapper
insert()DB\Mongo\Mapper
ip()DB\Mongo\Session
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
open($path, $name)DB\Mongo\Session
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
read($id)DB\Mongo\Session
reset()DB\Mongo\Mapper
save()DB\Cursor
select($fields=NULL, $filter=NULL, array $options=NULL, $ttl=0)DB\Mongo\Mapper
set($key, $val)DB\Mongo\Mapper
skip($ofs=1)DB\Mongo\Mapper
stamp()DB\Mongo\Session
update()DB\Mongo\Mapper
write($id, $data)DB\Mongo\Session
diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Session.html b/fatfree/lib/api/classDB_1_1Mongo_1_1Session.html new file mode 100644 index 0000000000000000000000000000000000000000..2c29e948a97576569384b68c5f287ebae1182981 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1Mongo_1_1Session.html @@ -0,0 +1,520 @@ + + + + + + + +Fat-Free Framework: DB\Mongo\Session Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
DB\Mongo\Session Class Reference
+
+
+ +

MongoDB-managed session handler. + More...

+
+ + Inheritance diagram for DB\Mongo\Session:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 open ($path, $name)
 
 close ()
 
 read ($id)
 
 write ($id, $data)
 
 destroy ($id)
 
 cleanup ($max)
 
 csrf ()
 
 ip ()
 
 stamp ()
 
 agent ()
 
 __construct (\DB\Mongo $db, $table='sessions')
 
- Public Member Functions inherited from DB\Mongo\Mapper
 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 cast ($obj=NULL)
 
 select ($fields=NULL, $filter=NULL, array $options=NULL, $ttl=0)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 fields ()
 
 cursor ()
 
 __construct (\DB\Mongo $db, $collection)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + +

+Protected Attributes

$sid
 Session ID.
 
- Protected Attributes inherited from DB\Mongo\Mapper
$db
 MongoDB wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+ + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Attributes inherited from DB\Mongo\Mapper
$collection
 Mongo collection.
 
$document =array()
 Mongo document.
 
$cursor
 Mongo cursor.
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
- Protected Member Functions inherited from DB\Mongo\Mapper
 factory ($row)
 
+

Detailed Description

+

MongoDB-managed session handler.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Session::__construct (\DB\Mongo $db,
 $table = 'sessions' 
)
+
+

Instantiate class

Parameters
+ + + +
$dbobject
$tablestring
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
DB\Mongo\Session::agent ()
+
+

Return HTTP user agent

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Session::cleanup ( $max)
+
+

Garbage collector

Returns
TRUE
+
Parameters
+ + +
$maxint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Session::close ()
+
+

Close session

Returns
TRUE
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Session::csrf ()
+
+

Return anti-CSRF token

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Session::destroy ( $id)
+
+

Destroy session

Returns
TRUE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Session::ip ()
+
+

Return IP address

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Session::open ( $path,
 $name 
)
+
+

Open session

Returns
TRUE
+
Parameters
+ + + +
$pathstring
$namestring
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\Mongo\Session::read ( $id)
+
+

Return session data in serialized format

Returns
string|FALSE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\Mongo\Session::stamp ()
+
+

Return Unix timestamp

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\Mongo\Session::write ( $id,
 $data 
)
+
+

Write session data

Returns
TRUE
+
Parameters
+ + + +
$idstring
$datastring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1Mongo_1_1Session.png b/fatfree/lib/api/classDB_1_1Mongo_1_1Session.png new file mode 100644 index 0000000000000000000000000000000000000000..0f5e194bfac7f63ee072804b193b877be7dd900a Binary files /dev/null and b/fatfree/lib/api/classDB_1_1Mongo_1_1Session.png differ diff --git a/fatfree/lib/api/classDB_1_1SQL-members.html b/fatfree/lib/api/classDB_1_1SQL-members.html new file mode 100644 index 0000000000000000000000000000000000000000..987ec7c24057c796dc9c0b03f369079aac2d9c4b --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL-members.html @@ -0,0 +1,68 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\SQL Member List
+
+
+ +

This is the complete list of members for DB\SQL, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + +
$dbnameDB\SQL
$dsnDB\SQL
$engineDB\SQL
$logDB\SQL
$rowsDB\SQL
$transDB\SQL
$uuidDB\SQLprotected
__construct($dsn, $user=NULL, $pw=NULL, array $options=NULL)DB\SQL
begin()DB\SQL
commit()DB\SQL
count()DB\SQL
driver()DB\SQL
exec($cmds, $args=NULL, $ttl=0, $log=TRUE)DB\SQL
log()DB\SQL
name()DB\SQL
quote($val, $type=\PDO::PARAM_STR)DB\SQL
quotekey($key)DB\SQL
rollback()DB\SQL
schema($table, $fields=NULL, $ttl=0)DB\SQL
type($val)DB\SQL
uuid()DB\SQL
value($type, $val)DB\SQL
version()DB\SQL
diff --git a/fatfree/lib/api/classDB_1_1SQL.html b/fatfree/lib/api/classDB_1_1SQL.html new file mode 100644 index 0000000000000000000000000000000000000000..ccdfda6eac0310fa1fcde8db9d8b7ede255f80ae --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL.html @@ -0,0 +1,531 @@ + + + + + + + +Fat-Free Framework: DB\SQL Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Attributes | +List of all members
+
+
DB\SQL Class Reference
+
+
+ +

PDO wrapper. + More...

+
+ + Inheritance diagram for DB\SQL:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 begin ()
 
 rollback ()
 
 commit ()
 
 type ($val)
 
 value ($type, $val)
 
 exec ($cmds, $args=NULL, $ttl=0, $log=TRUE)
 
 count ()
 
 log ()
 
 schema ($table, $fields=NULL, $ttl=0)
 
 quote ($val, $type=\PDO::PARAM_STR)
 
 uuid ()
 
 driver ()
 
 version ()
 
 name ()
 
 quotekey ($key)
 
 __construct ($dsn, $user=NULL, $pw=NULL, array $options=NULL)
 
+ + + + + + + + + + + + + + + + + + + +

+Public Attributes

$dsn
 Data source name.
 
$engine
 Database engine.
 
$dbname
 Database name.
 
$trans =FALSE
 Transaction flag.
 
$rows =0
 Number of rows affected by query.
 
$log
 SQL log.
 
+ + + + +

+Protected Attributes

$uuid
 UUID.
 
+

Detailed Description

+

PDO wrapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL::__construct ( $dsn,
 $user = NULL,
 $pw = NULL,
array $options = NULL 
)
+
+

Instantiate class

Parameters
+ + + + + +
$dsnstring
$userstring
$pwstring
$optionsarray
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
DB\SQL::begin ()
+
+

Begin SQL transaction

Returns
bool
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::commit ()
+
+

Commit SQL transaction

Returns
bool
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::count ()
+
+

Return number of rows affected by last query

Returns
int
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::driver ()
+
+

Return database engine

Returns
string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL::exec ( $cmds,
 $args = NULL,
 $ttl = 0,
 $log = TRUE 
)
+
+

Execute SQL statement(s)

Returns
array|int|FALSE
+
Parameters
+ + + + + +
$cmdsstring|array
$argsstring|array
$ttlint
$logbool
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::log ()
+
+

Return SQL profiler results

Returns
string
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::name ()
+
+

Return database name

Returns
string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL::quote ( $val,
 $type = \PDO::PARAM_STR 
)
+
+

Quote string

Returns
string
+
Parameters
+ + + +
$valmixed
$typeint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL::quotekey ( $key)
+
+

Return quoted identifier name

Returns
string
+
Parameters
+ + +
$key
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::rollback ()
+
+

Rollback SQL transaction

Returns
bool
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL::schema ( $table,
 $fields = NULL,
 $ttl = 0 
)
+
+

Retrieve schema of SQL table

Returns
array|FALSE
+
Parameters
+ + + + +
$tablestring
$fieldsarray|string
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL::type ( $val)
+
+

Map data type of argument to a PDO constant

Returns
int
+
Parameters
+ + +
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::uuid ()
+
+

Return UUID

Returns
string
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL::value ( $type,
 $val 
)
+
+

Cast value to PHP type

Returns
scalar
+
Parameters
+ + + +
$typestring
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL::version ()
+
+

Return server version

Returns
string
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1SQL.png b/fatfree/lib/api/classDB_1_1SQL.png new file mode 100644 index 0000000000000000000000000000000000000000..6e2c0ce76720bed05e342bbad50a9b4d3618a08e Binary files /dev/null and b/fatfree/lib/api/classDB_1_1SQL.png differ diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Mapper-members.html b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper-members.html new file mode 100644 index 0000000000000000000000000000000000000000..c45bf953c548221433c887b1ac81e4f8fbb5508c --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper-members.html @@ -0,0 +1,107 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\SQL\Mapper Member List
+
+
+ +

This is the complete list of members for DB\SQL\Mapper, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$_idDB\SQL\Mapper
$adhocDB\SQL\Mapper
$dbDB\SQL\Mapperprotected
$engineDB\SQL\Mapper
$fieldsDB\SQL\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$sourceDB\SQL\Mapper
$tableDB\SQL\Mapper
$triggerDB\Cursor
__construct(\DB\SQL $db, $table, $fields=NULL, $ttl=60)DB\SQL\Mapper
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\SQL\Mapper
clear($key)DB\SQL\Mapper
copyfrom($key, $func=NULL)DB\SQL\Mapper
copyto($key)DB\SQL\Mapper
count($filter=NULL, $ttl=0)DB\SQL\Mapper
dbtype()DB\SQL\Mapper
dry()DB\Cursor
E_Adhoc (defined in DB\SQL\Mapper)DB\SQL\Mapper
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\SQL\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\SQL\Mapper
factory($row)DB\SQL\Mapperprotected
fields($adhoc=TRUE)DB\SQL\Mapper
find($filter=NULL, array $options=NULL, $ttl=0)DB\SQL\Mapper
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\SQL\Mapper
insert()DB\SQL\Mapper
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
reset()DB\SQL\Mapper
save()DB\Cursor
schema()DB\SQL\Mapper
select($fields, $filter=NULL, array $options=NULL, $ttl=0)DB\SQL\Mapper
set($key, $val)DB\SQL\Mapper
skip($ofs=1)DB\SQL\Mapper
type($pdo)DB\SQL\Mapper
update()DB\SQL\Mapper
diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.html b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.html new file mode 100644 index 0000000000000000000000000000000000000000..604592f2ff7c58d8517d6564b1d88c3832b30509 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.html @@ -0,0 +1,819 @@ + + + + + + + +Fat-Free Framework: DB\SQL\Mapper Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Public Attributes | +Protected Member Functions | +Protected Attributes | +List of all members
+
+
DB\SQL\Mapper Class Reference
+
+
+ +

SQL data mapper. + More...

+
+ + Inheritance diagram for DB\SQL\Mapper:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 type ($pdo)
 
 cast ($obj=NULL)
 
 select ($fields, $filter=NULL, array $options=NULL, $ttl=0)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 schema ()
 
 fields ($adhoc=TRUE)
 
 __construct (\DB\SQL $db, $table, $fields=NULL, $ttl=60)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

$engine
 Database engine.
 
$source
 SQL table.
 
$table
 SQL table (quoted)
 
$_id
 Last insert ID.
 
$fields
 Defined fields.
 
$adhoc =array()
 Adhoc fields.
 
+const E_Adhoc ='Unable to process ad hoc field %s'
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
+ + + +

+Protected Member Functions

 factory ($row)
 
+ + + + + + + + +

+Protected Attributes

$db
 PDO wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+

Detailed Description

+

SQL data mapper.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::__construct (\DB\SQL $db,
 $table,
 $fields = NULL,
 $ttl = 60 
)
+
+

Instantiate class

Parameters
+ + + + + +
$dbobject
$tablestring
$fieldsarray|string
$ttlint
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + + +
DB\SQL\Mapper::cast ( $obj = NULL)
+
+

Return fields of mapper object as an associative array

Returns
array
+
Parameters
+ + +
$objobject
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::clear ( $key)
+
+

Clear value of field

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::copyfrom ( $key,
 $func = NULL 
)
+
+

Hydrate mapper object using hive array variable

Returns
NULL
+
Parameters
+ + + +
$keystring
$funccallback
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::copyto ( $key)
+
+

Populate hive array variable with mapper fields

Returns
NULL
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::count ( $filter = NULL,
 $ttl = 0 
)
+
+

Count records that match criteria

Returns
int
+
Parameters
+ + + +
$filterstring|array
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::dbtype ()
+
+

Return database type

Returns
string
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::erase ( $filter = NULL)
+
+

Delete current record

Returns
int
+
Parameters
+ + +
$filterstring|array
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::exists ( $key)
+
+

Return TRUE if field is defined

Returns
bool
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + +
+ + + + + + + + +
DB\SQL\Mapper::factory ( $row)
+
+protected
+
+

Convert array to mapper object

Returns
object
+
Parameters
+ + +
$rowarray
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::fields ( $adhoc = TRUE)
+
+

Return field names

Returns
array
+
Parameters
+ + +
$adhocbool
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::find ( $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Return records that match criteria

Returns
array
+
Parameters
+ + + + +
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::get ( $key)
+
+

Retrieve value of field

Returns
scalar
+
Parameters
+ + +
$keystring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::insert ()
+
+

Insert new record

Returns
object
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::reset ()
+
+

Reset cursor

Returns
NULL
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::schema ()
+
+

Return schema

Returns
array
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::select ( $fields,
 $filter = NULL,
array $options = NULL,
 $ttl = 0 
)
+
+

Build query string and execute

Returns
array
+
Parameters
+ + + + + +
$fieldsstring
$filterstring|array
$optionsarray
$ttlint
+
+
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Mapper::set ( $key,
 $val 
)
+
+

Assign value to field

Returns
scalar
+
Parameters
+ + + +
$keystring
$valscalar
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::skip ( $ofs = 1)
+
+

Return record at specified offset using same criteria as previous load() call and make it active

Returns
array
+
Parameters
+ + +
$ofsint
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Mapper::type ( $pdo)
+
+

Get PHP type equivalent of PDO constant

Returns
string
+
Parameters
+ + +
$pdostring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Mapper::update ()
+
+

Update current record

Returns
object
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.png b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.png new file mode 100644 index 0000000000000000000000000000000000000000..d14e2de5286c4b481392889c174b3cce7da69a2e Binary files /dev/null and b/fatfree/lib/api/classDB_1_1SQL_1_1Mapper.png differ diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Session-members.html b/fatfree/lib/api/classDB_1_1SQL_1_1Session-members.html new file mode 100644 index 0000000000000000000000000000000000000000..588023875d76f0a7942b6f8f3a0c6b6fe2b65489 --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL_1_1Session-members.html @@ -0,0 +1,119 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+
DB\SQL\Session Member List
+
+
+ +

This is the complete list of members for DB\SQL\Session, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
$_idDB\SQL\Mapper
$adhocDB\SQL\Mapper
$dbDB\SQL\Mapperprotected
$engineDB\SQL\Mapper
$fieldsDB\SQL\Mapper
$ptrDB\Cursor
$queryDB\Cursorprotected
$sidDB\SQL\Sessionprotected
$sourceDB\SQL\Mapper
$tableDB\SQL\Mapper
$triggerDB\Cursor
__construct(\DB\SQL $db, $table='sessions', $force=TRUE)DB\SQL\Session
DB::SQL::Mapper::__construct(\DB\SQL $db, $table, $fields=NULL, $ttl=60)DB\SQL\Mapper
__get($key)Magic
__isset($key)Magic
__set($key, $val)Magic
__unset($key)Magic
aftererase($func)DB\Cursor
afterinsert($func)DB\Cursor
afterupdate($func)DB\Cursor
agent()DB\SQL\Session
beforeerase($func)DB\Cursor
beforeinsert($func)DB\Cursor
beforeupdate($func)DB\Cursor
cast($obj=NULL)DB\SQL\Mapper
cleanup($max)DB\SQL\Session
clear($key)DB\SQL\Mapper
close()DB\SQL\Session
copyfrom($key, $func=NULL)DB\SQL\Mapper
copyto($key)DB\SQL\Mapper
count($filter=NULL, $ttl=0)DB\SQL\Mapper
csrf()DB\SQL\Session
dbtype()DB\SQL\Mapper
destroy($id)DB\SQL\Session
dry()DB\Cursor
E_Adhoc (defined in DB\SQL\Mapper)DB\SQL\Mapper
E_Field (defined in DB\Cursor)DB\Cursor
erase($filter=NULL)DB\SQL\Mapper
DB::Cursor::erase()DB\Cursor
exists($key)DB\SQL\Mapper
factory($row)DB\SQL\Mapperprotected
fields($adhoc=TRUE)DB\SQL\Mapper
find($filter=NULL, array $options=NULL, $ttl=0)DB\SQL\Mapper
findone($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
first()DB\Cursor
get($key)DB\SQL\Mapper
insert()DB\SQL\Mapper
ip()DB\SQL\Session
last()DB\Cursor
load($filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
loaded()DB\Cursor
next()DB\Cursor
offsetexists($key)Magic
offsetget($key)Magic
offsetset($key, $val)Magic
offsetunset($key)Magic
onerase($func)DB\Cursor
oninsert($func)DB\Cursor
onload($func)DB\Cursor
onupdate($func)DB\Cursor
open($path, $name)DB\SQL\Session
paginate($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)DB\Cursor
prev()DB\Cursor
read($id)DB\SQL\Session
reset()DB\SQL\Mapper
save()DB\Cursor
schema()DB\SQL\Mapper
select($fields, $filter=NULL, array $options=NULL, $ttl=0)DB\SQL\Mapper
set($key, $val)DB\SQL\Mapper
skip($ofs=1)DB\SQL\Mapper
stamp()DB\SQL\Session
type($pdo)DB\SQL\Mapper
update()DB\SQL\Mapper
write($id, $data)DB\SQL\Session
diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Session.html b/fatfree/lib/api/classDB_1_1SQL_1_1Session.html new file mode 100644 index 0000000000000000000000000000000000000000..99dceb49fd8554779b3673cfec559f10e94ae21e --- /dev/null +++ b/fatfree/lib/api/classDB_1_1SQL_1_1Session.html @@ -0,0 +1,544 @@ + + + + + + + +Fat-Free Framework: DB\SQL\Session Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + + +
+
+
+Public Member Functions | +Protected Attributes | +List of all members
+
+
DB\SQL\Session Class Reference
+
+
+ +

SQL-managed session handler. + More...

+
+ + Inheritance diagram for DB\SQL\Session:
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Member Functions

 open ($path, $name)
 
 close ()
 
 read ($id)
 
 write ($id, $data)
 
 destroy ($id)
 
 cleanup ($max)
 
 csrf ()
 
 ip ()
 
 stamp ()
 
 agent ()
 
 __construct (\DB\SQL $db, $table='sessions', $force=TRUE)
 
- Public Member Functions inherited from DB\SQL\Mapper
 dbtype ()
 
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 type ($pdo)
 
 cast ($obj=NULL)
 
 select ($fields, $filter=NULL, array $options=NULL, $ttl=0)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 skip ($ofs=1)
 
 insert ()
 
 update ()
 
 erase ($filter=NULL)
 
 reset ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 schema ()
 
 fields ($adhoc=TRUE)
 
 __construct (\DB\SQL $db, $table, $fields=NULL, $ttl=60)
 
- Public Member Functions inherited from DB\Cursor
 dbtype ()
 
 cast ($obj=NULL)
 
 find ($filter=NULL, array $options=NULL, $ttl=0)
 
 count ($filter=NULL, $ttl=0)
 
 insert ()
 
 update ()
 
 copyfrom ($key, $func=NULL)
 
 copyto ($key)
 
 dry ()
 
 findone ($filter=NULL, array $options=NULL, $ttl=0)
 
 paginate ($pos=0, $size=10, $filter=NULL, array $options=NULL, $ttl=0)
 
 load ($filter=NULL, array $options=NULL, $ttl=0)
 
 loaded ()
 
 first ()
 
 last ()
 
 skip ($ofs=1)
 
 next ()
 
 prev ()
 
 save ()
 
 erase ()
 
 onload ($func)
 
 beforeinsert ($func)
 
 afterinsert ($func)
 
 oninsert ($func)
 
 beforeupdate ($func)
 
 afterupdate ($func)
 
 onupdate ($func)
 
 beforeerase ($func)
 
 aftererase ($func)
 
 onerase ($func)
 
 reset ()
 
- Public Member Functions inherited from Magic
 exists ($key)
 
 set ($key, $val)
 
 get ($key)
 
 clear ($key)
 
 offsetexists ($key)
 
 __isset ($key)
 
 offsetset ($key, $val)
 
 __set ($key, $val)
 
 offsetget ($key)
 
 __get ($key)
 
 offsetunset ($key)
 
 __unset ($key)
 
+ + + + + + + + + + + + +

+Protected Attributes

$sid
 Session ID.
 
- Protected Attributes inherited from DB\SQL\Mapper
$db
 PDO wrapper.
 
- Protected Attributes inherited from DB\Cursor
$query =array()
 Query results.
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Additional Inherited Members

- Public Attributes inherited from DB\SQL\Mapper
$engine
 Database engine.
 
$source
 SQL table.
 
$table
 SQL table (quoted)
 
$_id
 Last insert ID.
 
$fields
 Defined fields.
 
$adhoc =array()
 Adhoc fields.
 
+const E_Adhoc ='Unable to process ad hoc field %s'
 
- Public Attributes inherited from DB\Cursor
$ptr =0
 Current position.
 
$trigger =array()
 Event listeners.
 
+const E_Field ='Undefined field %s'
 
- Protected Member Functions inherited from DB\SQL\Mapper
 factory ($row)
 
+

Detailed Description

+

SQL-managed session handler.

+

Constructor & Destructor Documentation

+ +
+
+ + + + + + + + + + + + + + + + + + + + + + + + +
DB\SQL\Session::__construct (\DB\SQL $db,
 $table = 'sessions',
 $force = TRUE 
)
+
+

Instantiate class

Parameters
+ + + + +
$dbobject
$tablestring
$forcebool
+
+
+ +
+
+

Member Function Documentation

+ +
+
+ + + + + + + +
DB\SQL\Session::agent ()
+
+

Return HTTP user agent

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Session::cleanup ( $max)
+
+

Garbage collector

Returns
TRUE
+
Parameters
+ + +
$maxint
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Session::close ()
+
+

Close session

Returns
TRUE
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Session::csrf ()
+
+

Return anti-CSRF token

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Session::destroy ( $id)
+
+

Destroy session

Returns
TRUE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Session::ip ()
+
+

Return IP address

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Session::open ( $path,
 $name 
)
+
+

Open session

Returns
TRUE
+
Parameters
+ + + +
$pathstring
$namestring
+
+
+ +
+
+ +
+
+ + + + + + + + +
DB\SQL\Session::read ( $id)
+
+

Return session data in serialized format

Returns
string|FALSE
+
Parameters
+ + +
$idstring
+
+
+ +
+
+ +
+
+ + + + + + + +
DB\SQL\Session::stamp ()
+
+

Return Unix timestamp

Returns
string|FALSE
+ +
+
+ +
+
+ + + + + + + + + + + + + + + + + + +
DB\SQL\Session::write ( $id,
 $data 
)
+
+

Write session data

Returns
TRUE
+
Parameters
+ + + +
$idstring
$datastring
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classDB_1_1SQL_1_1Session.png b/fatfree/lib/api/classDB_1_1SQL_1_1Session.png new file mode 100644 index 0000000000000000000000000000000000000000..e9d15add6d00d1f79cc042e56d7571b2afef12a8 Binary files /dev/null and b/fatfree/lib/api/classDB_1_1SQL_1_1Session.png differ diff --git a/fatfree/lib/api/classF3-members.html b/fatfree/lib/api/classF3-members.html new file mode 100644 index 0000000000000000000000000000000000000000..988d67c5f40867159393af59357598c757201357 --- /dev/null +++ b/fatfree/lib/api/classF3-members.html @@ -0,0 +1,43 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
F3 Member List
+
+
+ +

This is the complete list of members for F3, including all inherited members.

+ + + +
$fwF3static
__callstatic($func, array $args)F3static
diff --git a/fatfree/lib/api/classF3.html b/fatfree/lib/api/classF3.html new file mode 100644 index 0000000000000000000000000000000000000000..cd5935702a8f235b607509a8fa8519abf6beb44c --- /dev/null +++ b/fatfree/lib/api/classF3.html @@ -0,0 +1,106 @@ + + + + + + + +Fat-Free Framework: F3 Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Static Public Member Functions | +Static Public Attributes | +List of all members
+
+
F3 Class Reference
+
+
+ +

Legacy mode enabler. + More...

+ + + + +

+Static Public Member Functions

static __callstatic ($func, array $args)
 
+ + + + +

+Static Public Attributes

+static $fw
 Framework instance.
 
+

Detailed Description

+

Legacy mode enabler.

+

Member Function Documentation

+ +
+
+ + + + + +
+ + + + + + + + + + + + + + + + + + +
static F3::__callstatic ( $func,
array $args 
)
+
+static
+
+

Forward function calls to framework

Returns
mixed
+
Parameters
+ + + +
$funccallback
$argsarray
+
+
+ +
+
+
The documentation for this class was generated from the following file: +
diff --git a/fatfree/lib/api/classISO-members.html b/fatfree/lib/api/classISO-members.html new file mode 100644 index 0000000000000000000000000000000000000000..16269e06da7fb6dbdd9c3d107b39e1bf1c825d63 --- /dev/null +++ b/fatfree/lib/api/classISO-members.html @@ -0,0 +1,377 @@ + + + + + + + +Fat-Free Framework: Member List + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+
ISO Member List
+
+
+ +

This is the complete list of members for ISO, including all inherited members.

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
CC_ad (defined in ISO)ISO
CC_ae (defined in ISO)ISO
CC_af (defined in ISO)ISO
CC_ag (defined in ISO)ISO
CC_ai (defined in ISO)ISO
CC_al (defined in ISO)ISO
CC_am (defined in ISO)ISO
CC_ao (defined in ISO)ISO
CC_aq (defined in ISO)ISO
CC_ar (defined in ISO)ISO
CC_as (defined in ISO)ISO
CC_at (defined in ISO)ISO
CC_au (defined in ISO)ISO
CC_aw (defined in ISO)ISO
CC_ax (defined in ISO)ISO
CC_az (defined in ISO)ISO
CC_ba (defined in ISO)ISO
CC_bb (defined in ISO)ISO
CC_bd (defined in ISO)ISO
CC_be (defined in ISO)ISO
CC_bf (defined in ISO)ISO
CC_bg (defined in ISO)ISO
CC_bh (defined in ISO)ISO
CC_bi (defined in ISO)ISO
CC_bj (defined in ISO)ISO
CC_bl (defined in ISO)ISO
CC_bm (defined in ISO)ISO
CC_bn (defined in ISO)ISO
CC_bo (defined in ISO)ISO
CC_bq (defined in ISO)ISO
CC_br (defined in ISO)ISO
CC_bs (defined in ISO)ISO
CC_bt (defined in ISO)ISO
CC_bv (defined in ISO)ISO
CC_bw (defined in ISO)ISO
CC_by (defined in ISO)ISO
CC_bz (defined in ISO)ISO
CC_ca (defined in ISO)ISO
CC_cc (defined in ISO)ISO
CC_cd (defined in ISO)ISO
CC_cf (defined in ISO)ISO
CC_cg (defined in ISO)ISO
CC_ch (defined in ISO)ISO
CC_ci (defined in ISO)ISO
CC_ck (defined in ISO)ISO
CC_cl (defined in ISO)ISO
CC_cm (defined in ISO)ISO
CC_cn (defined in ISO)ISO
CC_co (defined in ISO)ISO
CC_cr (defined in ISO)ISO
CC_cu (defined in ISO)ISO
CC_cv (defined in ISO)ISO
CC_cw (defined in ISO)ISO
CC_cx (defined in ISO)ISO
CC_cy (defined in ISO)ISO
CC_cz (defined in ISO)ISO
CC_de (defined in ISO)ISO
CC_dj (defined in ISO)ISO
CC_dk (defined in ISO)ISO
CC_dm (defined in ISO)ISO
CC_do (defined in ISO)ISO
CC_dz (defined in ISO)ISO
CC_ec (defined in ISO)ISO
CC_ee (defined in ISO)ISO
CC_eg (defined in ISO)ISO
CC_eh (defined in ISO)ISO
CC_er (defined in ISO)ISO
CC_es (defined in ISO)ISO
CC_et (defined in ISO)ISO
CC_fi (defined in ISO)ISO
CC_fj (defined in ISO)ISO
CC_fk (defined in ISO)ISO
CC_fm (defined in ISO)ISO
CC_fo (defined in ISO)ISO
CC_fr (defined in ISO)ISO
CC_ga (defined in ISO)ISO
CC_gb (defined in ISO)ISO
CC_gd (defined in ISO)ISO
CC_ge (defined in ISO)ISO
CC_gf (defined in ISO)ISO
CC_gg (defined in ISO)ISO
CC_gh (defined in ISO)ISO
CC_gi (defined in ISO)ISO
CC_gl (defined in ISO)ISO
CC_gm (defined in ISO)ISO
CC_gn (defined in ISO)ISO
CC_gp (defined in ISO)ISO
CC_gq (defined in ISO)ISO
CC_gr (defined in ISO)ISO
CC_gs (defined in ISO)ISO
CC_gt (defined in ISO)ISO
CC_gu (defined in ISO)ISO
CC_gw (defined in ISO)ISO
CC_gy (defined in ISO)ISO
CC_hk (defined in ISO)ISO
CC_hm (defined in ISO)ISO
CC_hn (defined in ISO)ISO
CC_hr (defined in ISO)ISO
CC_ht (defined in ISO)ISO
CC_hu (defined in ISO)ISO
CC_id (defined in ISO)ISO
CC_ie (defined in ISO)ISO
CC_il (defined in ISO)ISO
CC_im (defined in ISO)ISO
CC_in (defined in ISO)ISO
CC_io (defined in ISO)ISO
CC_iq (defined in ISO)ISO
CC_ir (defined in ISO)ISO
CC_is (defined in ISO)ISO
CC_it (defined in ISO)ISO
CC_je (defined in ISO)ISO
CC_jm (defined in ISO)ISO
CC_jo (defined in ISO)ISO
CC_jp (defined in ISO)ISO
CC_ke (defined in ISO)ISO
CC_kg (defined in ISO)ISO
CC_kh (defined in ISO)ISO
CC_ki (defined in ISO)ISO
CC_km (defined in ISO)ISO
CC_kn (defined in ISO)ISO
CC_kp (defined in ISO)ISO
CC_kr (defined in ISO)ISO
CC_kw (defined in ISO)ISO
CC_ky (defined in ISO)ISO
CC_kz (defined in ISO)ISO
CC_la (defined in ISO)ISO
CC_lb (defined in ISO)ISO
CC_lc (defined in ISO)ISO
CC_li (defined in ISO)ISO
CC_lk (defined in ISO)ISO
CC_lr (defined in ISO)ISO
CC_ls (defined in ISO)ISO
CC_lt (defined in ISO)ISO
CC_lu (defined in ISO)ISO
CC_lv (defined in ISO)ISO
CC_ly (defined in ISO)ISO
CC_ma (defined in ISO)ISO
CC_mc (defined in ISO)ISO
CC_md (defined in ISO)ISO
CC_me (defined in ISO)ISO
CC_mf (defined in ISO)ISO
CC_mg (defined in ISO)ISO
CC_mh (defined in ISO)ISO
CC_mk (defined in ISO)ISO
CC_ml (defined in ISO)ISO
CC_mm (defined in ISO)ISO
CC_mn (defined in ISO)ISO
CC_mo (defined in ISO)ISO
CC_mp (defined in ISO)ISO
CC_mq (defined in ISO)ISO
CC_mr (defined in ISO)ISO
CC_ms (defined in ISO)ISO
CC_mt (defined in ISO)ISO
CC_mu (defined in ISO)ISO
CC_mv (defined in ISO)ISO
CC_mw (defined in ISO)ISO
CC_mx (defined in ISO)ISO
CC_my (defined in ISO)ISO
CC_mz (defined in ISO)ISO
CC_na (defined in ISO)ISO
CC_nc (defined in ISO)ISO
CC_ne (defined in ISO)ISO
CC_nf (defined in ISO)ISO
CC_ng (defined in ISO)ISO
CC_ni (defined in ISO)ISO
CC_nl (defined in ISO)ISO
CC_no (defined in ISO)ISO
CC_np (defined in ISO)ISO
CC_nr (defined in ISO)ISO
CC_nu (defined in ISO)ISO
CC_nz (defined in ISO)ISO
CC_om (defined in ISO)ISO
CC_pa (defined in ISO)ISO
CC_pe (defined in ISO)ISO
CC_pf (defined in ISO)ISO
CC_pg (defined in ISO)ISO
CC_ph (defined in ISO)ISO
CC_pk (defined in ISO)ISO
CC_pl (defined in ISO)ISO
CC_pm (defined in ISO)ISO
CC_pn (defined in ISO)ISO
CC_pr (defined in ISO)ISO
CC_ps (defined in ISO)ISO
CC_pt (defined in ISO)ISO
CC_pw (defined in ISO)ISO
CC_py (defined in ISO)ISO
CC_qa (defined in ISO)ISO
CC_re (defined in ISO)ISO
CC_ro (defined in ISO)ISO
CC_rs (defined in ISO)ISO
CC_ru (defined in ISO)ISO
CC_rw (defined in ISO)ISO
CC_sa (defined in ISO)ISO
CC_sb (defined in ISO)ISO
CC_sc (defined in ISO)ISO
CC_sd (defined in ISO)ISO
CC_se (defined in ISO)ISO
CC_sg (defined in ISO)ISO
CC_sh (defined in ISO)ISO
CC_si (defined in ISO)ISO
CC_sj (defined in ISO)ISO
CC_sk (defined in ISO)ISO
CC_sl (defined in ISO)ISO
CC_sm (defined in ISO)ISO
CC_sn (defined in ISO)ISO
CC_so (defined in ISO)ISO
CC_sr (defined in ISO)ISO
CC_ss (defined in ISO)ISO
CC_st (defined in ISO)ISO
CC_sv (defined in ISO)ISO
CC_sx (defined in ISO)ISO
CC_sy (defined in ISO)ISO
CC_sz (defined in ISO)ISO
CC_tc (defined in ISO)ISO
CC_td (defined in ISO)ISO
CC_tf (defined in ISO)ISO
CC_tg (defined in ISO)ISO
CC_th (defined in ISO)ISO
CC_tj (defined in ISO)ISO
CC_tk (defined in ISO)ISO
CC_tl (defined in ISO)ISO
CC_tm (defined in ISO)ISO
CC_tn (defined in ISO)ISO
CC_to (defined in ISO)ISO
CC_tr (defined in ISO)ISO
CC_tt (defined in ISO)ISO
CC_tv (defined in ISO)ISO
CC_tw (defined in ISO)ISO
CC_tz (defined in ISO)ISO
CC_ua (defined in ISO)ISO
CC_ug (defined in ISO)ISO
CC_um (defined in ISO)ISO
CC_us (defined in ISO)ISO
CC_uy (defined in ISO)ISO
CC_uz (defined in ISO)ISO
CC_va (defined in ISO)ISO
CC_vc (defined in ISO)ISO
CC_ve (defined in ISO)ISO
CC_vg (defined in ISO)ISO
CC_vi (defined in ISO)ISO
CC_vn (defined in ISO)ISO
CC_vu (defined in ISO)ISO
CC_wf (defined in ISO)ISO
CC_ws (defined in ISO)ISO
CC_ye (defined in ISO)ISO
CC_yt (defined in ISO)ISO
CC_za (defined in ISO)ISO
CC_zm (defined in ISO)ISO
CC_zw (defined in ISO)ISO
constants($prefix)ISOprotected
countries()ISO
instance()Prefabstatic
languages()ISO
LC_af (defined in ISO)ISO
LC_am (defined in ISO)ISO
LC_ar (defined in ISO)ISO
LC_as (defined in ISO)ISO
LC_ba (defined in ISO)ISO
LC_be (defined in ISO)ISO
LC_bg (defined in ISO)ISO
LC_bn (defined in ISO)ISO
LC_bo (defined in ISO)ISO
LC_br (defined in ISO)ISO
LC_ca (defined in ISO)ISO
LC_co (defined in ISO)ISO
LC_cs (defined in ISO)ISO
LC_cy (defined in ISO)ISO
LC_da (defined in ISO)ISO
LC_de (defined in ISO)ISO
LC_dv (defined in ISO)ISO
LC_el (defined in ISO)ISO
LC_en (defined in ISO)ISO
LC_es (defined in ISO)ISO
LC_et (defined in ISO)ISO
LC_eu (defined in ISO)ISO
LC_fa (defined in ISO)ISO
LC_fi (defined in ISO)ISO
LC_fo (defined in ISO)ISO
LC_fr (defined in ISO)ISO
LC_gd (defined in ISO)ISO
LC_gl (defined in ISO)ISO
LC_gu (defined in ISO)ISO
LC_he (defined in ISO)ISO
LC_hi (defined in ISO)ISO
LC_hr (defined in ISO)ISO
LC_hu (defined in ISO)ISO
LC_hy (defined in ISO)ISO
LC_id (defined in ISO)ISO
LC_ig (defined in ISO)ISO
LC_is (defined in ISO)ISO
LC_it (defined in ISO)ISO
LC_ja (defined in ISO)ISO
LC_ka (defined in ISO)ISO
LC_kk (defined in ISO)ISO
LC_km (defined in ISO)ISO
LC_kn (defined in ISO)ISO
LC_ko (defined in ISO)ISO
LC_lb (defined in ISO)ISO
LC_lo (defined in ISO)ISO
LC_lt (defined in ISO)ISO
LC_lv (defined in ISO)ISO
LC_mi (defined in ISO)ISO
LC_ml (defined in ISO)ISO
LC_mr (defined in ISO)ISO
LC_ms (defined in ISO)ISO
LC_mt (defined in ISO)ISO
LC_ne (defined in ISO)ISO
LC_nl (defined in ISO)ISO
LC_no (defined in ISO)ISO
LC_oc (defined in ISO)ISO
LC_or (defined in ISO)ISO
LC_pl (defined in ISO)ISO
LC_ps (defined in ISO)ISO
LC_pt (defined in ISO)ISO
LC_qu (defined in ISO)ISO
LC_ro (defined in ISO)ISO
LC_ru (defined in ISO)ISO
LC_rw (defined in ISO)ISO
LC_sa (defined in ISO)ISO
LC_si (defined in ISO)ISO
LC_sk (defined in ISO)ISO
LC_sl (defined in ISO)ISO
LC_sq (defined in ISO)ISO
LC_sv (defined in ISO)ISO
LC_ta (defined in ISO)ISO
LC_te (defined in ISO)ISO
LC_th (defined in ISO)ISO
LC_tk (defined in ISO)ISO
LC_tr (defined in ISO)ISO
LC_tt (defined in ISO)ISO
LC_uk (defined in ISO)ISO
LC_ur (defined in ISO)ISO
LC_vi (defined in ISO)ISO
LC_wo (defined in ISO)ISO
LC_yo (defined in ISO)ISO
LC_zh (defined in ISO)ISO
diff --git a/fatfree/lib/api/classISO.html b/fatfree/lib/api/classISO.html new file mode 100644 index 0000000000000000000000000000000000000000..5fb0dbc37e3e2bcdfe3c0e66d103c33b219c1fa7 --- /dev/null +++ b/fatfree/lib/api/classISO.html @@ -0,0 +1,1145 @@ + + + + + + + +Fat-Free Framework: ISO Class Reference + + + + + + +
+
+ + + + + + +
+
Fat-Free Framework +  3.3.0 +  Overview Class List Hierarchy +
+
+
+ + +
+
+
+Public Member Functions | +Protected Member Functions | +List of all members
+
+
ISO Class Reference
+
+
+ +

ISO language/country codes. + More...

+
+ + Inheritance diagram for ISO:
+
+
+ + + + + + + +

+Public Member Functions

 languages ()
 
 countries ()
 
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

+Public Attributes

+const CC_af ='Afghanistan'
 
+const CC_ax ='Åland Islands'
 
+const CC_al ='Albania'
 
+const CC_dz ='Algeria'
 
+const CC_as ='American Samoa'
 
+const CC_ad ='Andorra'
 
+const CC_ao ='Angola'
 
+const CC_ai ='Anguilla'
 
+const CC_aq ='Antarctica'
 
+const CC_ag ='Antigua and Barbuda'
 
+const CC_ar ='Argentina'
 
+const CC_am ='Armenia'
 
+const CC_aw ='Aruba'
 
+const CC_au ='Australia'
 
+const CC_at ='Austria'
 
+const CC_az ='Azerbaijan'
 
+const CC_bs ='Bahamas'
 
+const CC_bh ='Bahrain'
 
+const CC_bd ='Bangladesh'
 
+const CC_bb ='Barbados'
 
+const CC_by ='Belarus'
 
+const CC_be ='Belgium'
 
+const CC_bz ='Belize'
 
+const CC_bj ='Benin'
 
+const CC_bm ='Bermuda'
 
+const CC_bt ='Bhutan'
 
+const CC_bo ='Bolivia'
 
+const CC_bq ='Bonaire, Sint Eustatius and Saba'
 
+const CC_ba ='Bosnia and Herzegovina'
 
+const CC_bw ='Botswana'
 
+const CC_bv ='Bouvet Island'
 
+const CC_br ='Brazil'
 
+const CC_io ='British Indian Ocean Territory'
 
+const CC_bn ='Brunei Darussalam'
 
+const CC_bg ='Bulgaria'
 
+const CC_bf ='Burkina Faso'
 
+const CC_bi ='Burundi'
 
+const CC_kh ='Cambodia'
 
+const CC_cm ='Cameroon'
 
+const CC_ca ='Canada'
 
+const CC_cv ='Cape Verde'
 
+const CC_ky ='Cayman Islands'
 
+const CC_cf ='Central African Republic'
 
+const CC_td ='Chad'
 
+const CC_cl ='Chile'
 
+const CC_cn ='China'
 
+const CC_cx ='Christmas Island'
 
+const CC_cc ='Cocos (Keeling) Islands'
 
+const CC_co ='Colombia'
 
+const CC_km ='Comoros'
 
+const CC_cg ='Congo'
 
+const CC_cd ='Congo, The Democratic Republic of'
 
+const CC_ck ='Cook Islands'
 
+const CC_cr ='Costa Rica'
 
+const CC_ci ='Côte d\'ivoire'
 
+const CC_hr ='Croatia'
 
+const CC_cu ='Cuba'
 
+const CC_cw ='Curaçao'
 
+const CC_cy ='Cyprus'
 
+const CC_cz ='Czech Republic'
 
+const CC_dk ='Denmark'
 
+const CC_dj ='Djibouti'
 
+const CC_dm ='Dominica'
 
+const CC_do ='Dominican Republic'
 
+const CC_ec ='Ecuador'
 
+const CC_eg ='Egypt'
 
+const CC_sv ='El Salvador'
 
+const CC_gq ='Equatorial Guinea'
 
+const CC_er ='Eritrea'
 
+const CC_ee ='Estonia'
 
+const CC_et ='Ethiopia'
 
+const CC_fk ='Falkland Islands (Malvinas)'
 
+const CC_fo ='Faroe Islands'
 
+const CC_fj ='Fiji'
 
+const CC_fi ='Finland'
 
+const CC_fr ='France'
 
+const CC_gf ='French Guiana'
 
+const CC_pf ='French Polynesia'
 
+const CC_tf ='French Southern Territories'
 
+const CC_ga ='Gabon'
 
+const CC_gm ='Gambia'
 
+const CC_ge ='Georgia'
 
+const CC_de ='Germany'
 
+const CC_gh ='Ghana'
 
+const CC_gi ='Gibraltar'
 
+const CC_gr ='Greece'
 
+const CC_gl ='Greenland'
 
+const CC_gd ='Grenada'
 
+const CC_gp ='Guadeloupe'
 
+const CC_gu ='Guam'
 
+const CC_gt ='Guatemala'
 
+const CC_gg ='Guernsey'
 
+const CC_gn ='Guinea'
 
+const CC_gw ='Guinea-Bissau'
 
+const CC_gy ='Guyana'
 
+const CC_ht ='Haiti'
 
+const CC_hm ='Heard Island and McDonald Islands'
 
+const CC_va ='Holy See (Vatican City State)'
 
+const CC_hn ='Honduras'
 
+const CC_hk ='Hong Kong'
 
+const CC_hu ='Hungary'
 
+const CC_is ='Iceland'
 
+const CC_in ='India'
 
+const CC_id ='Indonesia'
 
+const CC_ir ='Iran, Islamic Republic of'
 
+const CC_iq ='Iraq'
 
+const CC_ie ='Ireland'
 
+const CC_im ='Isle of Man'
 
+const CC_il ='Israel'
 
+const CC_it ='Italy'
 
+const CC_jm ='Jamaica'
 
+const CC_jp ='Japan'
 
+const CC_je ='Jersey'
 
+const CC_jo ='Jordan'
 
+const CC_kz ='Kazakhstan'
 
+const CC_ke ='Kenya'
 
+const CC_ki ='Kiribati'
 
+const CC_kp ='Korea, Democratic People\'s Republic of'
 
+const CC_kr ='Korea, Republic of'
 
+const CC_kw ='Kuwait'
 
+const CC_kg ='Kyrgyzstan'
 
+const CC_la ='Lao People\'s Democratic Republic'
 
+const CC_lv ='Latvia'
 
+const CC_lb ='Lebanon'
 
+const CC_ls ='Lesotho'
 
+const CC_lr ='Liberia'
 
+const CC_ly ='Libya'
 
+const CC_li ='Liechtenstein'
 
+const CC_lt ='Lithuania'
 
+const CC_lu ='Luxembourg'
 
+const CC_mo ='Macao'
 
+const CC_mk ='Macedonia, The Former Yugoslav Republic of'
 
+const CC_mg ='Madagascar'
 
+const CC_mw ='Malawi'
 
+const CC_my ='Malaysia'
 
+const CC_mv ='Maldives'
 
+const CC_ml ='Mali'
 
+const CC_mt ='Malta'
 
+const CC_mh ='Marshall Islands'
 
+const CC_mq ='Martinique'
 
+const CC_mr ='Mauritania'
 
+const CC_mu ='Mauritius'
 
+const CC_yt ='Mayotte'
 
+const CC_mx ='Mexico'
 
+const CC_fm ='Micronesia, Federated States of'
 
+const CC_md ='Moldova, Republic of'
 
+const CC_mc ='Monaco'
 
+const CC_mn ='Mongolia'
 
+const CC_me ='Montenegro'
 
+const CC_ms ='Montserrat'
 
+const CC_ma ='Morocco'
 
+const CC_mz ='Mozambique'
 
+const CC_mm ='Myanmar'
 
+const CC_na ='Namibia'
 
+const CC_nr ='Nauru'
 
+const CC_np ='Nepal'
 
+const CC_nl ='Netherlands'
 
+const CC_nc ='New Caledonia'
 
+const CC_nz ='New Zealand'
 
+const CC_ni ='Nicaragua'
 
+const CC_ne ='Niger'
 
+const CC_ng ='Nigeria'
 
+const CC_nu ='Niue'
 
+const CC_nf ='Norfolk Island'
 
+const CC_mp ='Northern Mariana Islands'
 
+const CC_no ='Norway'
 
+const CC_om ='Oman'
 
+const CC_pk ='Pakistan'
 
+const CC_pw ='Palau'
 
+const CC_ps ='Palestinian Territory, Occupied'
 
+const CC_pa ='Panama'
 
+const CC_pg ='Papua New Guinea'
 
+const CC_py ='Paraguay'
 
+const CC_pe ='Peru'
 
+const CC_ph ='Philippines'
 
+const CC_pn ='Pitcairn'
 
+const CC_pl ='Poland'
 
+const CC_pt ='Portugal'
 
+const CC_pr ='Puerto Rico'
 
+const CC_qa ='Qatar'
 
+const CC_re ='Réunion'
 
+const CC_ro ='Romania'
 
+const CC_ru ='Russian Federation'
 
+const CC_rw ='Rwanda'
 
+const CC_bl ='Saint Barthélemy'
 
+const CC_sh ='Saint Helena, Ascension and Tristan da Cunha'
 
+const CC_kn ='Saint Kitts and Nevis'
 
+const CC_lc ='Saint Lucia'
 
+const CC_mf ='Saint Martin (French Part)'
 
+const CC_pm ='Saint Pierre and Miquelon'
 
+const CC_vc ='Saint Vincent and The Grenadines'
 
+const CC_ws ='Samoa'
 
+const CC_sm ='San Marino'
 
+const CC_st ='Sao Tome and Principe'
 
+const CC_sa ='Saudi Arabia'
 
+const CC_sn ='Senegal'
 
+const CC_rs ='Serbia'
 
+const CC_sc ='Seychelles'
 
+const CC_sl ='Sierra Leone'
 
+const CC_sg ='Singapore'
 
+const CC_sk ='Slovakia'
 
+const CC_sx ='Sint Maarten (Dutch Part)'
 
+const CC_si ='Slovenia'
 
+const CC_sb ='Solomon Islands'
 
+const CC_so ='Somalia'
 
+const CC_za ='South Africa'
 
+const CC_gs ='South Georgia and The South Sandwich Islands'
 
+const CC_ss ='South Sudan'
 
+const CC_es ='Spain'
 
+const CC_lk ='Sri Lanka'
 
+const CC_sd ='Sudan'
 
+const CC_sr ='Suriname'
 
+const CC_sj ='Svalbard and Jan Mayen'
 
+const CC_sz ='Swaziland'
 
+const CC_se ='Sweden'
 
+const CC_ch ='Switzerland'
 
+const CC_sy ='Syrian Arab Republic'
 
+const CC_tw ='Taiwan, Province of China'
 
+const CC_tj ='Tajikistan'
 
+const CC_tz ='Tanzania, United Republic of'
 
+const CC_th ='Thailand'
 
+const CC_tl ='Timor-Leste'
 
+const CC_tg ='Togo'
 
+const CC_tk ='Tokelau'
 
+const CC_to ='Tonga'
 
+const CC_tt ='Trinidad and Tobago'
 
+const CC_tn ='Tunisia'
 
+const CC_tr ='Turkey'
 
+const CC_tm ='Turkmenistan'
 
+const CC_tc ='Turks and Caicos Islands'
 
+const CC_tv ='Tuvalu'
 
+const CC_ug ='Uganda'
 
+const CC_ua ='Ukraine'
 
+const CC_ae ='United Arab Emirates'
 
+const CC_gb ='United Kingdom'
 
+const CC_us ='United States'
 
+const CC_um ='United States Minor Outlying Islands'
 
+const CC_uy ='Uruguay'
 
+const CC_uz ='Uzbekistan'
 
+const CC_vu ='Vanuatu'
 
+const CC_ve ='Venezuela'
 
+const CC_vn ='Viet Nam'
 
+const CC_vg ='Virgin Islands, British'
 
+const CC_vi ='Virgin Islands, U.S.'
 
+const CC_wf ='Wallis and Futuna'
 
+const CC_eh ='Western Sahara'
 
+const CC_ye ='Yemen'
 
+const CC_zm ='Zambia'
 
+const CC_zw ='Zimbabwe'
 
+const LC_af ='Afrikaans'
 
+const LC_am ='Amharic'
 
+const LC_ar ='Arabic'
 
+const LC_as ='Assamese'
 
+const LC_ba ='Bashkir'
 
+const LC_be ='Belarusian'
 
+const LC_bg ='Bulgarian'
 
+const LC_bn ='Bengali'
 
+const LC_bo ='Tibetan'
 
+const LC_br ='Breton'
 
+const LC_ca ='Catalan'
 
+const LC_co ='Corsican'
 
+const LC_cs ='Czech'
 
+const LC_cy ='Welsh'
 
+const LC_da ='Danish'
 
+const LC_de ='German'
 
+const LC_dv ='Divehi'
 
+const LC_el ='Greek'
 
+const LC_en ='English'
 
+const LC_es ='Spanish'
 
+const LC_et ='Estonian'
 
+const LC_eu ='Basque'
 
+const LC_fa ='Persian'
 
+const LC_fi ='Finnish'
 
+const LC_fo ='Faroese'
 
+const LC_fr ='French'
 
+const LC_gd ='Scottish Gaelic'
 
+const LC_gl ='Galician'
 
+const LC_gu ='Gujarati'
 
+const LC_he ='Hebrew'
 
+const LC_hi ='Hindi'
 
+const LC_hr ='Croatian'
 
+const LC_hu ='Hungarian'
 
+const LC_hy ='Armenian'
 
+const LC_id ='Indonesian'
 
+const LC_ig ='Igbo'
 
+const LC_is ='Icelandic'
 
+const LC_it ='Italian'
 
+const LC_ja ='Japanese'
 
+const LC_ka ='Georgian'
 
+const LC_kk ='Kazakh'
 
+const LC_km ='Khmer'
 
+const LC_kn ='Kannada'
 
+const LC_ko ='Korean'
 
+const LC_lb ='Luxembourgish'
 
+const LC_lo ='Lao'
 
+const LC_lt ='Lithuanian'
 
+const LC_lv ='Latvian'
 
+const LC_mi ='Maori'
 
+const LC_ml ='Malayalam'
 
+const LC_mr ='Marathi'
 
+const LC_ms ='Malay'
 
+const LC_mt ='Maltese'
 
+const LC_ne ='Nepali'
 
+const LC_nl ='Dutch'
 
+const LC_no ='Norwegian'
 
+const LC_oc ='Occitan'
 
+const LC_or ='Oriya'
 
+const LC_pl ='Polish'
 
+const LC_ps ='Pashto'
 
+const LC_pt ='Portuguese'
 
+const LC_qu ='Quechua'
 
+const LC_ro ='Romanian'
 
+const LC_ru ='Russian'
 
+const LC_rw ='Kinyarwanda'
 
+const LC_sa ='Sanskrit'
 
+const LC_si ='Sinhala'
 
+const LC_sk ='Slovak'
 
+const LC_sl ='Slovenian'
 
+const LC_sq ='Albanian'
 
+const LC_sv ='Swedish'