diff --git a/.gitignore b/.gitignore
index 22626c9b7a0bf607fc3bc624b6563384fc1f97a8..eb2a1c189d7b9f6268d92a6624c4fbaead330f25 100644
--- a/.gitignore
+++ b/.gitignore
@@ -1,4 +1,5 @@
-/tmp
app/config.php
tests/tmp
*~
+vendor
+composer.lock
diff --git a/README b/README
index de1153ede569d50dee6785f46d3e39d9d7beca93..4cbed1e87e2225387cfe02d5c1097b1102474fa5 100644
--- a/README
+++ b/README
@@ -1,5 +1,8 @@
piphone module
==============
-See : https://git.leloop.org/laquadraturedunet/piphone
+Installation
+++++++++++++
+
+You need to have composer installed and run `composer install` in main directory.
diff --git a/composer.json b/composer.json
new file mode 100644
index 0000000000000000000000000000000000000000..a21db9d88d965ffe2eb4c7b513dcbc8a587c55b8
--- /dev/null
+++ b/composer.json
@@ -0,0 +1,5 @@
+{
+ "require": {
+ "bcosca/fatfree": "^3.5"
+ }
+}
diff --git a/index.php b/index.php
index 671e38984c86201504f41fc62a3c151046a28df3..f9dba3d967b71fa6cc56457519a43be0b92ed47b 100644
--- a/index.php
+++ b/index.php
@@ -1,6 +1,8 @@
config('app/config.ini');
diff --git a/lib/api/annotated.html b/lib/api/annotated.html
deleted file mode 100644
index 9fd19f6ec8c42d9cc7f00015e7496a639305b77f..0000000000000000000000000000000000000000
--- a/lib/api/annotated.html
+++ /dev/null
@@ -1,85 +0,0 @@
-
-
-
-
-Fat-Free Framework: Class List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
Here are the classes, structs, unions and interfaces with brief descriptions:
-
[detail level 1 2 3 ]
- ▼ N DB ▼ N Jig C Mapper Flat-file DB mapper C Session Jig-managed session handler ▼ N Mongo C Mapper MongoDB mapper C Session MongoDB-managed session handler ▼ N SQL C Mapper SQL data mapper C Session SQL-managed session handler C Cursor Simple cursor implementation C Jig Flat-file DB wrapper C Mongo MongoDB wrapper C SQL PDO wrapper ▼ N Web ▼ N Google C StaticMap Google Static Maps API v2 plug-in C Geo Geo plug-in C OpenID OpenID consumer C Pingback Pingback 1.0 protocol (client and server) implementation C Audit Data validator C Auth Authorization/authentication plug-in C Base Base structure C Basket Session-based pseudo-mapper C Bcrypt Lightweight password hashing library C Cache Cache engine C F3 Legacy mode enabler C Image Image manipulation tools C ISO ISO language/country codes C Log Custom logger C Magic PHP magic wrapper C Markdown Markdown-to-HTML converter C Matrix Generic array utilities C Prefab Factory class for single-instance objects C Preview Lightweight template engine C Registry Container for singular object instances C Session Cache-based session handler C SMTP SMTP plug-in C Template XML-style template engine C Test Unit test kit C UTF Unicode string manager C View View handler C Web Wrapper for various HTTP utilities
-
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Audit , including all inherited members.
-
Fat-Free Framework: Audit Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Data validator.
- More...
-
-
-
-
-
-
-
-
-
-
-UA_Mobile ='android|blackberry|iphone|ipod|palm|windows\s+ce' UA_Desktop ='bsd|linux|os\s+[x9]|solaris|windows' UA_Bot ='bot|crawl|slurp|spider'
-
-
-
-
-
-
-
- Audit::card
- (
-
- $id )
-
-
-
-
Return credit card type if number is valid
Returns string|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::email
- (
-
- $str ,
-
-
- $mx = TRUE
-
- )
-
-
-
-
Return TRUE if string is a valid e-mail address; Check DNS MX records if specified
Returns bool
-
Parameters
-
- $str string $mx boolean
-
-
-
-
-
-
-
-
-
-
- Audit::entropy
- (
-
- $str )
-
-
-
-
Return entropy estimate of a password (NIST 800-63)
Returns int|float
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::ipv4
- (
-
- $addr )
-
-
-
-
Return TRUE if string is a valid IPV4 address
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::ipv6
- (
-
- $addr )
-
-
-
-
Return TRUE if string is a valid IPV6 address
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- Audit::ispublic
- (
-
- $addr )
-
-
-
-
Return TRUE if IP address is neither private nor reserved
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::isreserved
- (
-
- $addr )
-
-
-
-
Return TRUE if IP address is within reserved range
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::mod10
- (
-
- $id )
-
-
-
-
Return TRUE if specified ID has a valid (Luhn) Mod-10 check digit
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Audit::url
- (
-
- $str )
-
-
-
-
Return TRUE if string is a valid URL
Returns bool
-
Parameters
-
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Auth , including all inherited members.
-
- $args Auth $mapper Auth $storage Auth protected __construct ($storage, array $args=NULL)Auth _jig ($id, $pw, $realm)Auth protected _ldap ($id, $pw)Auth protected _mongo ($id, $pw, $realm)Auth protected _smtp ($id, $pw)Auth protected _sql ($id, $pw, $realm)Auth protected basic ($func=NULL)Auth E_LDAP (defined in Auth )Auth E_SMTP (defined in Auth )Auth login ($id, $pw, $realm=NULL)Auth
Fat-Free Framework: Auth Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Authorization/authentication plug-in.
- More...
-
- login ($id, $pw, $realm=NULL) basic ($func=NULL) __construct ($storage, array $args=NULL)
-$mapper Mapper object. $args Storage options. E_LDAP ='LDAP connection failure' E_SMTP ='SMTP connection failure'
- _jig ($id, $pw, $realm) _mongo ($id, $pw, $realm) _sql ($id, $pw, $realm) _ldap ($id, $pw) _smtp ($id, $pw)
-
-
Authorization/authentication plug-in.
-
-
-
-
-
-
- Auth::__construct
- (
-
- $storage ,
-
- array
- $args = NULL
-
- )
-
-
-
-
Instantiate class
Returns object
-
Parameters
-
- $storage string|object $args array
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- Auth::_jig
- (
-
- $id ,
-
-
- $pw ,
-
-
- $realm
-
- )
-
-
-
-
-protected
-
-
-
-
Jig storage handler
Returns bool
-
Parameters
-
- $id string $pw string $realm string
-
-
-
-
-
-
-
-
-
-
-
-
-
- Auth::_ldap
- (
-
- $id ,
-
-
- $pw
-
- )
-
-
-
-
-protected
-
-
-
-
LDAP storage handler
Returns bool
-
Parameters
-
- $id string $pw string
-
-
-
-
-
-
-
-
-
-
-
-
-
- Auth::_mongo
- (
-
- $id ,
-
-
- $pw ,
-
-
- $realm
-
- )
-
-
-
-
-protected
-
-
-
-
MongoDB storage handler
Returns bool
-
Parameters
-
- $id string $pw string $realm string
-
-
-
-
-
-
-
-
-
-
-
-
-
- Auth::_smtp
- (
-
- $id ,
-
-
- $pw
-
- )
-
-
-
-
-protected
-
-
-
-
SMTP storage handler
Returns bool
-
Parameters
-
- $id string $pw string
-
-
-
-
-
-
-
-
-
-
-
-
-
- Auth::_sql
- (
-
- $id ,
-
-
- $pw ,
-
-
- $realm
-
- )
-
-
-
-
-protected
-
-
-
-
SQL storage handler
Returns bool
-
Parameters
-
- $id string $pw string $realm string
-
-
-
-
-
-
-
-
-
-
- Auth::basic
- (
-
- $func = NULL)
-
-
-
-
HTTP basic auth mechanism
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Auth::login
- (
-
- $id ,
-
-
- $pw ,
-
-
- $realm = NULL
-
- )
-
-
-
-
Login auth mechanism
Returns bool
-
Parameters
-
- $id string $pw string $realm string
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Base , including all inherited members.
-
- $fallback Base $init Base $languages Base __construct ()Base autoload ($class)Base protected 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 CSS Base 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 GLOBALS Base 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 ()Prefab static 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 MODE Base 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 VERBS Base VERSION (defined in Base )Base write ($file, $data, $append=FALSE)Base
Fat-Free Framework: Base Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Base structure.
- More...
-
-
-
-
-
-
-
-
-
-
- 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.
-GLOBALS ='GET|POST|COOKIE|REQUEST|SESSION|FILES|SERVER|ENV' Mapped PHP globals. VERBS ='GET|HEAD|POST|PUT|PATCH|DELETE|CONNECT' HTTP verbs. MODE =0755 Default directory permissions. CSS ='code.css' Syntax highlighting stylesheet. $init Initial settings. $languages Language lookup sequence. $fallback ='en' Default fallback language. PACKAGE ='Fat-Free Framework' VERSION ='3.3.0-Release' HTTP_100 ='Continue' HTTP_101 ='Switching Protocols' HTTP_200 ='OK' HTTP_201 ='Created' HTTP_202 ='Accepted' HTTP_203 ='Non-Authorative Information' HTTP_204 ='No Content' HTTP_205 ='Reset Content' HTTP_206 ='Partial Content' HTTP_300 ='Multiple Choices' HTTP_301 ='Moved Permanently' HTTP_302 ='Found' HTTP_303 ='See Other' HTTP_304 ='Not Modified' HTTP_305 ='Use Proxy' HTTP_307 ='Temporary Redirect' HTTP_400 ='Bad Request' HTTP_401 ='Unauthorized' HTTP_402 ='Payment Required' HTTP_403 ='Forbidden' HTTP_404 ='Not Found' HTTP_405 ='Method Not Allowed' HTTP_406 ='Not Acceptable' HTTP_407 ='Proxy Authentication Required' HTTP_408 ='Request Timeout' HTTP_409 ='Conflict' HTTP_410 ='Gone' HTTP_411 ='Length Required' HTTP_412 ='Precondition Failed' HTTP_413 ='Request Entity Too Large' HTTP_414 ='Request-URI Too Long' HTTP_415 ='Unsupported Media Type' HTTP_416 ='Requested Range Not Satisfiable' HTTP_417 ='Expectation Failed' HTTP_500 ='Internal Server Error' HTTP_501 ='Not Implemented' HTTP_502 ='Bad Gateway' HTTP_503 ='Service Unavailable' HTTP_504 ='Gateway Timeout' HTTP_505 ='HTTP Version Not Supported' REQ_SYNC =1 REQ_AJAX =2 E_Pattern ='Invalid routing pattern: %s' E_Named ='Named route does not exist: %s' E_Fatal ='Fatal error: %s' E_Open ='Unable to open %s' E_Routes ='No routes specified' E_Class ='Invalid class %s' E_Method ='Invalid method %s' E_Hive ='Invalid hive key %s'
-
-
-
-
-
-
-
-
-
-
- Base::autoload
- (
-
- $class )
-
-
-
-
-protected
-
-
-
-
Namespace-aware class autoloader
Returns mixed
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::base64
- (
-
- $data ,
-
-
- $mime
-
- )
-
-
-
-
Return Base64-encoded equivalent
Returns string
-
Parameters
-
- $data string $mime string
-
-
-
-
-
-
-
-
-
-
- Base::blacklisted
- (
-
- $ip )
-
-
-
-
Return TRUE if IPv4 address exists in DNSBL
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::build
- (
-
- $url )
-
-
-
-
Replace tokenized URL with current route's token values
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::call
- (
-
- $func ,
-
-
- $args = NULL,
-
-
- $hooks = ''
-
- )
-
-
-
-
Execute callback/hooks (supports 'class->method' format)
Returns mixed|FALSE
-
Parameters
-
- $func callback $args mixed $hooks string
-
-
-
-
-
-
-
-
-
-
- Base::camelcase
- (
-
- $str )
-
-
-
-
Convert snakecase string to camelcase
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::chain
- (
-
- $funcs ,
-
-
- $args = NULL
-
- )
-
-
-
-
Execute specified callbacks in succession; Apply same arguments to all callbacks
Returns array
-
Parameters
-
- $funcs array|string $args mixed
-
-
-
-
-
-
-
-
-
-
- Base::clean
- (
-
- $arg ,
-
-
- $tags = NULL
-
- )
-
-
-
-
Remove HTML tags (except those enumerated) and non-printable characters to mitigate XSS/code injection attacks
Returns mixed
-
Parameters
-
- $arg mixed $tags string
-
-
-
-
-
-
-
-
-
-
- Base::clear
- (
-
- $key )
-
-
-
-
Unset hive key
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::compile
- (
-
- $str )
-
-
-
-
Convert JS-style token to PHP expression
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::concat
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Concatenate string to hive string variable
Returns string
-
Parameters
-
- $key string $val string
-
-
-
-
-
-
-
-
-
-
- Base::config
- (
-
- $file )
-
-
-
-
Configure framework according to .ini-style file settings
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::copy
- (
-
- $src ,
-
-
- $dst
-
- )
-
-
-
-
Copy contents of hive variable to another
Returns mixed
-
Parameters
-
- $src string $dst string
-
-
-
-
-
-
-
-
-
-
- Base::csv
- (
- array
- $args )
-
-
-
-
Flatten array values and return as CSV string
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::decode
- (
-
- $str )
-
-
-
-
Convert HTML entities back to characters
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::devoid
- (
-
- $key )
-
-
-
-
Return TRUE if hive key is empty and not cached
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::dump
- (
-
- $expr )
-
-
-
-
Dump expression with syntax highlighting
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::encode
- (
-
- $str )
-
-
-
-
Convert special characters to HTML entities
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $code int $text string $trace array
-
-
-
-
-
-
-
-
-
-
- Base::exists
- (
-
- $key ,
-
- &
- $val = NULL
-
- )
-
-
-
-
Return TRUE if hive key is set (or return timestamp and TTL if cached)
Returns bool
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Base::expire
- (
-
- $secs = 0)
-
-
-
-
Send cache metadata to HTTP client
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::fixslashes
- (
-
- $str )
-
-
-
-
Convert backslashes to slashes
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::flip
- (
-
- $key )
-
-
-
-
Swap keys and values of hive array variable
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::format
- (
- )
-
-
-
-
Return locale-aware formatted string
Returns string
-
-
-
-
-
-
-
-
- Base::get
- (
-
- $key ,
-
-
- $args = NULL
-
- )
-
-
-
-
Retrieve contents of hive key
Returns mixed
-
Parameters
-
- $key string $args string|array
-
-
-
-
-
-
-
-
-
-
- Base::hash
- (
-
- $str )
-
-
-
-
Generate 64bit/base36 hash
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::highlight
- (
-
- $text )
-
-
-
-
Apply syntax highlighting
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::hive
- (
- )
-
-
-
-
Publish hive contents
Returns array
-
-
-
-
-
-
-
-
- Base::language
- (
-
- $code )
-
-
-
-
Assign/auto-detect language
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::lexicon
- (
-
- $path )
-
-
-
-
Transfer lexicon entries to hive
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::map
- (
-
- $url ,
-
-
- $class ,
-
-
- $ttl = 0,
-
-
- $kbps = 0
-
- )
-
-
-
-
Provide ReST interface by mapping HTTP verb to class method
Returns NULL
-
Parameters
-
- $url string $class string $ttl int $kbps int
-
-
-
-
-
-
-
-
-
-
- Base::merge
- (
-
- $key ,
-
-
- $src
-
- )
-
-
-
-
Merge array with hive array variable
Returns array
-
Parameters
-
- $key string $src string|array
-
-
-
-
-
-
-
-
-
-
- Base::mock
- (
-
- $pattern ,
-
- array
- $args = NULL,
-
- array
- $headers = NULL,
-
-
- $body = NULL
-
- )
-
-
-
-
Mock HTTP request
Returns NULL
-
Parameters
-
- $pattern string $args array $headers array $body string
-
-
-
-
-
-
-
-
-
-
- Base::mset
- (
- array
- $vars ,
-
-
- $prefix = '',
-
-
- $ttl = 0
-
- )
-
-
-
-
Multi-variable assignment using associative array
Returns NULL
-
Parameters
-
- $vars array $prefix string $ttl int
-
-
-
-
-
-
-
-
-
-
- Base::mutex
- (
-
- $id ,
-
-
- $func ,
-
-
- $args = NULL
-
- )
-
-
-
-
Create mutex, invoke callback then drop ownership when done
Returns mixed
-
Parameters
-
- $id string $func callback $args mixed
-
-
-
-
-
-
-
-
-
-
- Base::parse
- (
-
- $str )
-
-
-
-
Parse string containing key-value pairs and use as routing tokens
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::pop
- (
-
- $key )
-
-
-
-
Remove last element of hive array variable
Returns mixed
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::push
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Add element to the end of hive array variable
Returns mixed
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Base::read
- (
-
- $file ,
-
-
- $lf = FALSE
-
- )
-
-
-
-
Read file (with option to apply Unix LF as standard line ending)
Returns string
-
Parameters
-
- $file string $lf bool
-
-
-
-
-
-
-
-
-
-
- Base::recursive
- (
-
- $arg ,
-
-
- $func ,
-
-
- $stack = NULL
-
- )
-
-
-
-
Invoke callback recursively for all data types
Returns mixed
-
Parameters
-
- $arg mixed $func callback $stack array
-
-
-
-
-
-
-
-
-
-
- Base::redirect
- (
-
- $pattern ,
-
-
- $url
-
- )
-
-
-
-
Redirect a route to another URL
Returns NULL
-
Parameters
-
- $pattern string|array $url string
-
-
-
-
-
-
-
-
-
-
- & 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
-
- $key string $add bool
-
-
-
-
-
-
-
-
-
-
- Base::rel
- (
-
- $url )
-
-
-
-
Return path relative to the base directory
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::relay
- (
-
- $funcs ,
-
-
- $args = NULL
-
- )
-
-
-
-
Execute specified callbacks in succession; Relay result of previous callback as argument to the next callback
Returns array
-
Parameters
-
- $funcs array|string $args mixed
-
-
-
-
-
-
-
-
-
-
- Base::reroute
- (
-
- $url ,
-
-
- $permanent = FALSE
-
- )
-
-
-
-
Reroute to specified URI
Returns NULL
-
Parameters
-
- $url string $permanent bool
-
-
-
-
-
-
-
-
-
-
- Base::route
- (
-
- $pattern ,
-
-
- $handler ,
-
-
- $ttl = 0,
-
-
- $kbps = 0
-
- )
-
-
-
-
Bind handler to route pattern
Returns NULL
-
Parameters
-
- $pattern string|array $handler callback $ttl int $kbps int
-
-
-
-
-
-
-
-
-
-
- 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
-
- $var mixed $tags string
-
-
-
-
-
-
-
-
-
-
- Base::serialize
- (
-
- $arg )
-
-
-
-
Return string representation of PHP value
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::set
- (
-
- $key ,
-
-
- $val ,
-
-
- $ttl = 0
-
- )
-
-
-
-
Bind value to hive key
Returns mixed
-
Parameters
-
- $key string $val mixed $ttl int
-
-
-
-
-
-
-
-
-
-
- Base::shift
- (
-
- $key )
-
-
-
-
Remove first element of hive array variable
Returns mixed
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::sign
- (
-
- $num )
-
-
-
-
Return -1 if specified number is negative, 0 if zero, or 1 if the number is positive
Returns int
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::snakecase
- (
-
- $str )
-
-
-
-
Convert camelcase string to snakecase
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::split
- (
-
- $str )
-
-
-
-
Split comma-, semi-colon, or pipe-separated string
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::status
- (
-
- $code )
-
-
-
-
Send HTTP/1.1 status header; Return text equivalent of status code
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::stringify
- (
-
- $arg ,
-
- array
- $stack = NULL
-
- )
-
-
-
-
Convert PHP expression/value to compressed exportable string
Returns string
-
Parameters
-
- $arg mixed $stack array
-
-
-
-
-
-
-
-
-
-
- Base::sync
- (
-
- $key )
-
-
-
-
Sync PHP global with corresponding hive key
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::unload
- (
-
- $cwd )
-
-
-
-
Execute framework/application shutdown sequence
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::unserialize
- (
-
- $arg )
-
-
-
-
Return PHP value derived from string
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Base::unshift
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Add element to the beginning of hive array variable
Returns mixed
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Base::write
- (
-
- $file ,
-
-
- $data ,
-
-
- $append = FALSE
-
- )
-
-
-
-
Exclusive file write
Returns int|FALSE
-
Parameters
-
- $file string $data mixed $append bool
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Basket , including all inherited members.
-
Fat-Free Framework: Basket Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Session-based pseudo-mapper.
- More...
-
-$id Current item identifier. $item =array() Current item contents. E_Field ='Undefined field %s'
-$key Session key.
-
-
Session-based pseudo-mapper.
-
-
-
-
-
-
- Basket::__construct
- (
-
- $key = 'basket')
-
-
-
-
Instantiate class
Returns void
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- Basket::checkout
- (
- )
-
-
-
-
Check out basket contents
Returns array
-
-
-
-
-
-
-
-
- Basket::clear
- (
-
- $key )
-
-
-
-
Delete field
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Basket::copyfrom
- (
-
- $key )
-
-
-
-
Hydrate item using hive array variable
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Basket::copyto
- (
-
- $key )
-
-
-
-
Populate hive array variable with item contents
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Basket::exists
- (
-
- $key )
-
-
-
-
Return TRUE if field is defined
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Basket::findone
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Return first item that matches key/value pair
Returns object|FALSE
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Basket::get
- (
-
- $key )
-
-
-
-
Retrieve value of field
Returns scalar|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Basket::load
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Map current item to matching key/value pair
Returns array
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- 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
-
- $key string $val scalar
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Bcrypt , including all inherited members.
-
Fat-Free Framework: Bcrypt Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Lightweight password hashing library.
- More...
-
-
-
-
-
-
-
-
-
-
-COST =10 Default cost. E_CostArg ='Invalid cost parameter' E_SaltArg ='Salt must be at least 22 alphanumeric characters'
-
-
Lightweight password hashing library.
-
-
-
-
-
-
- Bcrypt::hash
- (
-
- $pw ,
-
-
- $salt = NULL,
-
-
- $cost = self::COST
-
- )
-
-
-
-
Generate bcrypt hash of string
Returns string|FALSE
-
Parameters
-
- $pw string $salt string $cost int
-
-
-
-
-
-
-
-
-
-
- Bcrypt::needs_rehash
- (
-
- $hash ,
-
-
- $cost = self::COST
-
- )
-
-
-
-
Check if password is still strong enough
Returns bool
-
Parameters
-
- $hash string $cost int
-
-
-
-
-
-
-
-
-
-
- Bcrypt::verify
- (
-
- $pw ,
-
-
- $hash
-
- )
-
-
-
-
Verify password against hash using timing attack resistant approach
Returns bool
-
Parameters
-
- $pw string $hash string
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for Cache , including all inherited members.
-
Fat-Free Framework: Cache Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Cache engine.
- More...
-
-
-
-
-
-
-
-
-
-
-$prefix Prefix for cache entries. $ref MemCache or Redis object.
-$dsn Cache DSN.
-
-
-
-
-
-
-
- Cache::__construct
- (
-
- $dsn = FALSE)
-
-
-
-
Class constructor
Returns object
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
- Cache::clear
- (
-
- $key )
-
-
-
-
Delete cache entry
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Cache::exists
- (
-
- $key ,
-
- &
- $val = NULL
-
- )
-
-
-
-
Return timestamp and TTL of cache entry or FALSE if not found
Returns array|FALSE
-
Parameters
-
- $key string $val mixed
-
-
-
-
-
-
-
-
-
-
- Cache::get
- (
-
- $key )
-
-
-
-
Retrieve value of cache entry
Returns mixed|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Cache::load
- (
-
- $dsn )
-
-
-
-
Load/auto-detect cache backend
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- Cache::reset
- (
-
- $suffix = NULL,
-
-
- $lifetime = 0
-
- )
-
-
-
-
Clear contents of cache backend
Returns bool
-
Parameters
-
- $suffix string $lifetime int
-
-
-
-
-
-
-
-
-
-
- Cache::set
- (
-
- $key ,
-
-
- $val ,
-
-
- $ttl = 0
-
- )
-
-
-
-
Store value in cache
Returns mixed|FALSE
-
Parameters
-
- $key string $val mixed $ttl int
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Cursor , including all inherited members.
-
- $ptr DB\Cursor $query DB\Cursor protected $trigger DB\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
Fat-Free Framework: DB\Cursor Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
Simple cursor implementation.
- More...
-
-
-
-
-
-
-
-
-
-
- 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 () 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)
-$ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s'
-$query =array() Query results.
-
-
Simple cursor implementation.
-
-
-
-
-
-
- DB\Cursor::aftererase
- (
-
- $func )
-
-
-
-
Define aftererase trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::afterinsert
- (
-
- $func )
-
-
-
-
Define afterinsert trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::afterupdate
- (
-
- $func )
-
-
-
-
Define afterupdate trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::beforeerase
- (
-
- $func )
-
-
-
-
Define beforeerase trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::beforeinsert
- (
-
- $func )
-
-
-
-
Define beforeinsert trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::beforeupdate
- (
-
- $func )
-
-
-
-
Define beforeupdate trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::cast
- (
-
- $obj = NULL)
-
-
-
-
-abstract
-
-
-
-
Return fields of mapper object as an associative array
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::copyfrom
- (
-
- $key ,
-
-
- $func = NULL
-
- )
-
-
-
-
-abstract
-
-
-
-
Hydrate mapper object using hive array variable
Returns NULL
-
Parameters
-
- $key string $func callback
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::copyto
- (
-
- $key )
-
-
-
-
-abstract
-
-
-
-
Populate hive array variable with mapper fields
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::count
- (
-
- $filter = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
-abstract
-
-
-
-
Count records that match criteria
Returns int
-
Parameters
-
- $filter array $ttl int
-
-
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::findone
- (
-
- $filter = NULL,
-
- array
- $options = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
Return first record (mapper object) that matches criteria
Returns object|FALSE
-
Parameters
-
- $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- 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
-
- $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::oninsert
- (
-
- $func )
-
-
-
-
Define oninsert trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::onload
- (
-
- $func )
-
-
-
-
Define onload trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::onupdate
- (
-
- $func )
-
-
-
-
Define onupdate trigger
Returns callback
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $pos int $size int $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Cursor::update
- (
- )
-
-
-
-
-abstract
-
-
-
-
Update current record
Returns array
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Jig , including all inherited members.
-
Fat-Free Framework: DB\Jig Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
Flat-file DB wrapper.
- More...
-
-$dir Storage location. $format Current storage format. $log Jig log. FORMAT_JSON =0 FORMAT_Serialized =1
-
-
-
-
-
-
-
- DB\Jig::__construct
- (
-
- $dir ,
-
-
- $format = self::FORMAT_JSON
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $dir string $format int
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig::log
- (
- )
-
-
-
-
Return SQL profiler results
Returns string
-
-
-
-
-
-
-
-
- DB\Jig::read
- (
-
- $file )
-
-
-
-
Read data from file
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig::uuid
- (
- )
-
-
-
-
Return UUID
Returns string
-
-
-
-
-
-
-
-
- DB\Jig::write
- (
-
- $file ,
-
- array
- $data = NULL
-
- )
-
-
-
-
Write data to file
Returns int
-
Parameters
-
- $file string $data array
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Jig\Mapper , including all inherited members.
-
- $db DB\Jig\Mapper protected $document DB\Jig\Mapper $file DB\Jig\Mapper $id DB\Jig\Mapper $ptr DB\Cursor $query DB\Cursor protected $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\Jig\Mapper Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
Flat-file DB mapper.
- More...
-
-
-
-
-
-
-
-
-
-
- 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) 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 () 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)
-$file Data file. $id Document identifier. $document =array() Document contents. $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s'
-$db Flat-file DB wrapper. $query =array() Query results.
-
-
-
-
-
-
-
- DB\Jig\Mapper::__construct
- (
- \DB\Jig
- $db ,
-
-
- $file
-
- )
-
-
-
-
Instantiate class
Returns void
-
Parameters
-
- $db object $file string
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::cast
- (
-
- $obj = NULL)
-
-
-
-
Return fields of mapper object as an associative array
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::clear
- (
-
- $key )
-
-
-
-
Delete field
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::copyfrom
- (
-
- $key ,
-
-
- $func = NULL
-
- )
-
-
-
-
Hydrate mapper object using hive array variable
Returns NULL
-
Parameters
-
- $key string $func callback
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::copyto
- (
-
- $key )
-
-
-
-
Populate hive array variable with mapper fields
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::count
- (
-
- $filter = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
Count records that match criteria
Returns int
-
Parameters
-
- $filter array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::dbtype
- (
- )
-
-
-
-
Return database type
Returns string
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::erase
- (
-
- $filter = NULL)
-
-
-
-
Delete current record
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::exists
- (
-
- $key )
-
-
-
-
Return TRUE if field is defined
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::factory
- (
-
- $id ,
-
-
- $row
-
- )
-
-
-
-
-protected
-
-
-
-
Convert array to mapper object
Returns object
-
Parameters
-
- $id string $row array
-
-
-
-
-
-
-
-
-
-
- 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
-
- $filter array $options array $ttl int $log bool
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::get
- (
-
- $key )
-
-
-
-
Retrieve value of field
Returns scalar|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $key string $val scalar
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::skip
- (
-
- $ofs = 1)
-
-
-
-
Return record at specified offset using criteria of previous load() call and make it active
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::token
- (
-
- $str )
-
-
-
-
Convert tokens in string expression to variable names
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Mapper::update
- (
- )
-
-
-
-
Update current record
Returns array
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Jig\Session , including all inherited members.
-
- $db DB\Jig\Mapper protected $document DB\Jig\Mapper $file DB\Jig\Mapper $id DB\Jig\Mapper $ptr DB\Cursor $query DB\Cursor protected $sid DB\Jig\Session protected $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\Jig\Session Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
Jig-managed session handler.
- More...
-
-
-
-
-
-
-
-
-
-
- open ($path, $name) close () read ($id) write ($id, $data) destroy ($id) cleanup ($max) csrf () ip () stamp () agent () __construct (\DB\Jig $db, $table='sessions') 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) 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 () 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)
-$sid Session ID. $db Flat-file DB wrapper. $query =array() Query results.
-$file Data file. $id Document identifier. $document =array() Document contents. $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s' factory ($id, $row)
-
-
Jig-managed session handler.
-
-
-
-
-
-
- DB\Jig\Session::__construct
- (
- \DB\Jig
- $db ,
-
-
- $table = 'sessions'
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $db object $table string
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Session::agent
- (
- )
-
-
-
-
Return HTTP user agent
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Jig\Session::cleanup
- (
-
- $max )
-
-
-
-
Garbage collector
Returns TRUE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Session::ip
- (
- )
-
-
-
-
Return IP address
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Jig\Session::open
- (
-
- $path ,
-
-
- $name
-
- )
-
-
-
-
Open session
Returns TRUE
-
Parameters
-
- $path string $name string
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Session::read
- (
-
- $id )
-
-
-
-
Return session data in serialized format
Returns string|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Jig\Session::stamp
- (
- )
-
-
-
-
Return Unix timestamp
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Jig\Session::write
- (
-
- $id ,
-
-
- $data
-
- )
-
-
-
-
Write session data
Returns TRUE
-
Parameters
-
- $id string $data string
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Mongo , including all inherited members.
-
Fat-Free Framework: DB\Mongo Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
MongoDB wrapper.
- More...
-
-$dsn Data source name. $db MongoDB object. $log MongoDB log. E_Profiler ='MongoDB profiler is disabled'
-
-
-
-
-
-
-
- DB\Mongo::__construct
- (
-
- $dsn ,
-
-
- $dbname ,
-
- array
- $options = NULL
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $dsn string $dbname string $options array
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo::__call
- (
-
- $func ,
-
- array
- $args
-
- )
-
-
-
-
Redirect call to MongoDB object
Returns mixed
-
Parameters
-
- $func string $args array
-
-
-
-
-
-
-
-
-
-
- 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:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Mongo\Mapper , including all inherited members.
-
- $collection DB\Mongo\Mapper $cursor DB\Mongo\Mapper $db DB\Mongo\Mapper protected $document DB\Mongo\Mapper $ptr DB\Cursor $query DB\Cursor protected $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\Mongo\Mapper Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
MongoDB mapper.
- More...
-
-
-
-
-
-
-
-
-
-
- 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) 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 () 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)
-$collection Mongo collection. $document =array() Mongo document. $cursor Mongo cursor. $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s'
-$db MongoDB wrapper. $query =array() Query results.
-
-
-
-
-
-
-
- DB\Mongo\Mapper::__construct
- (
- \DB\Mongo
- $db ,
-
-
- $collection
-
- )
-
-
-
-
Instantiate class
Returns void
-
Parameters
-
- $db object $collection string
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::cast
- (
-
- $obj = NULL)
-
-
-
-
Return fields of mapper object as an associative array
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::clear
- (
-
- $key )
-
-
-
-
Delete field
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::copyfrom
- (
-
- $key ,
-
-
- $func = NULL
-
- )
-
-
-
-
Hydrate mapper object using hive array variable
Returns NULL
-
Parameters
-
- $key string $func callback
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::copyto
- (
-
- $key )
-
-
-
-
Populate hive array variable with mapper fields
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::count
- (
-
- $filter = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
Count records that match criteria
Returns int
-
Parameters
-
- $filter array $ttl int
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::exists
- (
-
- $key )
-
-
-
-
Return TRUE if field is defined
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::factory
- (
-
- $row )
-
-
-
-
-protected
-
-
-
-
Convert array to mapper object
Returns object
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $filter array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::get
- (
-
- $key )
-
-
-
-
Retrieve value of field
Returns scalar|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $fields string $filter array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::set
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Assign value to field
Returns scalar|FALSE
-
Parameters
-
- $key string $val scalar
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::skip
- (
-
- $ofs = 1)
-
-
-
-
Return record at specified offset using criteria of previous load() call and make it active
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Mapper::update
- (
- )
-
-
-
-
Update current record
Returns array
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\Mongo\Session , including all inherited members.
-
- $collection DB\Mongo\Mapper $cursor DB\Mongo\Mapper $db DB\Mongo\Mapper protected $document DB\Mongo\Mapper $ptr DB\Cursor $query DB\Cursor protected $sid DB\Mongo\Session protected $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\Mongo\Session Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
MongoDB-managed session handler.
- More...
-
-
-
-
-
-
-
-
-
-
- open ($path, $name) close () read ($id) write ($id, $data) destroy ($id) cleanup ($max) csrf () ip () stamp () agent () __construct (\DB\Mongo $db, $table='sessions') 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) 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 () 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)
-$sid Session ID. $db MongoDB wrapper. $query =array() Query results.
-$collection Mongo collection. $document =array() Mongo document. $cursor Mongo cursor. $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s' factory ($row)
-
-
MongoDB-managed session handler.
-
-
-
-
-
-
- DB\Mongo\Session::__construct
- (
- \DB\Mongo
- $db ,
-
-
- $table = 'sessions'
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $db object $table string
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Session::agent
- (
- )
-
-
-
-
Return HTTP user agent
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Mongo\Session::cleanup
- (
-
- $max )
-
-
-
-
Garbage collector
Returns TRUE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Session::ip
- (
- )
-
-
-
-
Return IP address
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Mongo\Session::open
- (
-
- $path ,
-
-
- $name
-
- )
-
-
-
-
Open session
Returns TRUE
-
Parameters
-
- $path string $name string
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Session::read
- (
-
- $id )
-
-
-
-
Return session data in serialized format
Returns string|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\Mongo\Session::stamp
- (
- )
-
-
-
-
Return Unix timestamp
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\Mongo\Session::write
- (
-
- $id ,
-
-
- $data
-
- )
-
-
-
-
Write session data
Returns TRUE
-
Parameters
-
- $id string $data string
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\SQL , including all inherited members.
-
- $dbname DB\SQL $dsn DB\SQL $engine DB\SQL $log DB\SQL $rows DB\SQL $trans DB\SQL $uuid DB\SQL protected __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
Fat-Free Framework: DB\SQL Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
PDO wrapper.
- More...
-
-
-
-
-
-
-
-
-
-
- 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)
-$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.
-
-
-
-
-
-
-
- DB\SQL::__construct
- (
-
- $dsn ,
-
-
- $user = NULL,
-
-
- $pw = NULL,
-
- array
- $options = NULL
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $dsn string $user string $pw string $options array
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $cmds string|array $args string|array $ttl int $log bool
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL::quotekey
- (
-
- $key )
-
-
-
-
Return quoted identifier name
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $table string $fields array|string $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\SQL::type
- (
-
- $val )
-
-
-
-
Map data type of argument to a PDO constant
Returns int
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL::uuid
- (
- )
-
-
-
-
Return UUID
Returns string
-
-
-
-
-
-
-
-
- DB\SQL::value
- (
-
- $type ,
-
-
- $val
-
- )
-
-
-
-
Cast value to PHP type
Returns scalar
-
Parameters
-
- $type string $val scalar
-
-
-
-
-
-
-
-
-
-
- DB\SQL::version
- (
- )
-
-
-
-
Return server version
Returns string
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\SQL\Mapper , including all inherited members.
-
- $_id DB\SQL\Mapper $adhoc DB\SQL\Mapper $db DB\SQL\Mapper protected $engine DB\SQL\Mapper $fields DB\SQL\Mapper $ptr DB\Cursor $query DB\Cursor protected $source DB\SQL\Mapper $table DB\SQL\Mapper $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\SQL\Mapper Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
SQL data mapper.
- More...
-
-
-
-
-
-
-
-
-
-
- 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) 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 () 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)
-$engine Database engine. $source SQL table. $table SQL table (quoted) $_id Last insert ID. $fields Defined fields. $adhoc =array() Adhoc fields. E_Adhoc ='Unable to process ad hoc field %s' $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s'
-$db PDO wrapper. $query =array() Query results.
-
-
-
-
-
-
-
- DB\SQL\Mapper::__construct
- (
- \DB\SQL
- $db ,
-
-
- $table ,
-
-
- $fields = NULL,
-
-
- $ttl = 60
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $db object $table string $fields array|string $ttl int
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::cast
- (
-
- $obj = NULL)
-
-
-
-
Return fields of mapper object as an associative array
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::clear
- (
-
- $key )
-
-
-
-
Clear value of field
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::copyfrom
- (
-
- $key ,
-
-
- $func = NULL
-
- )
-
-
-
-
Hydrate mapper object using hive array variable
Returns NULL
-
Parameters
-
- $key string $func callback
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::copyto
- (
-
- $key )
-
-
-
-
Populate hive array variable with mapper fields
Returns NULL
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::count
- (
-
- $filter = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
Count records that match criteria
Returns int
-
Parameters
-
- $filter string|array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::dbtype
- (
- )
-
-
-
-
Return database type
Returns string
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::erase
- (
-
- $filter = NULL)
-
-
-
-
Delete current record
Returns int
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::exists
- (
-
- $key )
-
-
-
-
Return TRUE if field is defined
Returns bool
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::factory
- (
-
- $row )
-
-
-
-
-protected
-
-
-
-
Convert array to mapper object
Returns object
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::fields
- (
-
- $adhoc = TRUE)
-
-
-
-
Return field names
Returns array
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::find
- (
-
- $filter = NULL,
-
- array
- $options = NULL,
-
-
- $ttl = 0
-
- )
-
-
-
-
Return records that match criteria
Returns array
-
Parameters
-
- $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::get
- (
-
- $key )
-
-
-
-
Retrieve value of field
Returns scalar
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
- $fields string $filter string|array $options array $ttl int
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::set
- (
-
- $key ,
-
-
- $val
-
- )
-
-
-
-
Assign value to field
Returns scalar
-
Parameters
-
- $key string $val scalar
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::type
- (
-
- $pdo )
-
-
-
-
Get PHP type equivalent of PDO constant
Returns string
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Mapper::update
- (
- )
-
-
-
-
Update current record
Returns object
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for DB\SQL\Session , including all inherited members.
-
- $_id DB\SQL\Mapper $adhoc DB\SQL\Mapper $db DB\SQL\Mapper protected $engine DB\SQL\Mapper $fields DB\SQL\Mapper $ptr DB\Cursor $query DB\Cursor protected $sid DB\SQL\Session protected $source DB\SQL\Mapper $table DB\SQL\Mapper $trigger DB\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\Mapper protected 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
Fat-Free Framework: DB\SQL\Session Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
-
SQL-managed session handler.
- More...
-
-
-
-
-
-
-
-
-
-
- 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) 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) 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 () 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)
-$sid Session ID. $db PDO wrapper. $query =array() Query results.
-$engine Database engine. $source SQL table. $table SQL table (quoted) $_id Last insert ID. $fields Defined fields. $adhoc =array() Adhoc fields. E_Adhoc ='Unable to process ad hoc field %s' $ptr =0 Current position. $trigger =array() Event listeners. E_Field ='Undefined field %s' factory ($row)
-
-
SQL-managed session handler.
-
-
-
-
-
-
- DB\SQL\Session::__construct
- (
- \DB\SQL
- $db ,
-
-
- $table = 'sessions',
-
-
- $force = TRUE
-
- )
-
-
-
-
Instantiate class
Parameters
-
- $db object $table string $force bool
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Session::agent
- (
- )
-
-
-
-
Return HTTP user agent
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\SQL\Session::cleanup
- (
-
- $max )
-
-
-
-
Garbage collector
Returns TRUE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- 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
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Session::ip
- (
- )
-
-
-
-
Return IP address
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\SQL\Session::open
- (
-
- $path ,
-
-
- $name
-
- )
-
-
-
-
Open session
Returns TRUE
-
Parameters
-
- $path string $name string
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Session::read
- (
-
- $id )
-
-
-
-
Return session data in serialized format
Returns string|FALSE
-
Parameters
-
-
-
-
-
-
-
-
-
-
-
- DB\SQL\Session::stamp
- (
- )
-
-
-
-
Return Unix timestamp
Returns string|FALSE
-
-
-
-
-
-
-
-
- DB\SQL\Session::write
- (
-
- $id ,
-
-
- $data
-
- )
-
-
-
-
Write session data
Returns TRUE
-
Parameters
-
- $id string $data string
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for F3 , including all inherited members.
-
Fat-Free Framework: F3 Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
Legacy mode enabler.
- More...
-
-$fw Framework instance.
-
-
-
-
-
-
-
-
-
-
- static F3::__callstatic
- (
-
- $func ,
-
- array
- $args
-
- )
-
-
-
-
-static
-
-
-
-
Forward function calls to framework
Returns mixed
-
Parameters
-
- $func callback $args array
-
-
-
-
-
-
The documentation for this class was generated from the following file:
-
Fat-Free Framework: Member List
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
This is the complete list of members for ISO , including all inherited members.
-
Fat-Free Framework: ISO Class Reference
-
-
-
-
-
-
- Fat-Free Framework
- 3.3.0
-
-
-
-
-
-
-
-
-
-
-
-
ISO language/country codes.
- More...
-
-
-
-
-
-
-
-
-
-
-CC_af ='Afghanistan' CC_ax ='Åland Islands' CC_al ='Albania' CC_dz ='Algeria' CC_as ='American Samoa' CC_ad ='Andorra' CC_ao ='Angola' CC_ai ='Anguilla' CC_aq ='Antarctica' CC_ag ='Antigua and Barbuda' CC_ar ='Argentina' CC_am ='Armenia' CC_aw ='Aruba' CC_au ='Australia' CC_at ='Austria' CC_az ='Azerbaijan' CC_bs ='Bahamas' CC_bh ='Bahrain' CC_bd ='Bangladesh' CC_bb ='Barbados' CC_by ='Belarus' CC_be ='Belgium' CC_bz ='Belize' CC_bj ='Benin' CC_bm ='Bermuda' CC_bt ='Bhutan' CC_bo ='Bolivia' CC_bq ='Bonaire, Sint Eustatius and Saba' CC_ba ='Bosnia and Herzegovina' CC_bw ='Botswana' CC_bv ='Bouvet Island' CC_br ='Brazil' CC_io ='British Indian Ocean Territory' CC_bn ='Brunei Darussalam' CC_bg ='Bulgaria' CC_bf ='Burkina Faso' CC_bi ='Burundi' CC_kh ='Cambodia' CC_cm ='Cameroon' CC_ca ='Canada' CC_cv ='Cape Verde' CC_ky ='Cayman Islands' CC_cf ='Central African Republic' CC_td ='Chad' CC_cl ='Chile' CC_cn ='China' CC_cx ='Christmas Island' CC_cc ='Cocos (Keeling) Islands' CC_co ='Colombia' CC_km ='Comoros' CC_cg ='Congo' CC_cd ='Congo, The Democratic Republic of' CC_ck ='Cook Islands' CC_cr ='Costa Rica' CC_ci ='Côte d\'ivoire' CC_hr ='Croatia' CC_cu ='Cuba' CC_cw ='Curaçao' CC_cy ='Cyprus' CC_cz ='Czech Republic' CC_dk ='Denmark' CC_dj ='Djibouti' CC_dm ='Dominica' CC_do ='Dominican Republic' CC_ec ='Ecuador' CC_eg ='Egypt' CC_sv ='El Salvador' CC_gq ='Equatorial Guinea' CC_er ='Eritrea' CC_ee ='Estonia' CC_et ='Ethiopia' CC_fk ='Falkland Islands (Malvinas)' CC_fo ='Faroe Islands' CC_fj ='Fiji' CC_fi ='Finland' CC_fr ='France' CC_gf ='French Guiana' CC_pf ='French Polynesia' CC_tf ='French Southern Territories' CC_ga ='Gabon' CC_gm ='Gambia' CC_ge ='Georgia' CC_de ='Germany' CC_gh ='Ghana' CC_gi ='Gibraltar' CC_gr ='Greece' CC_gl ='Greenland' CC_gd ='Grenada' CC_gp ='Guadeloupe' CC_gu ='Guam' CC_gt ='Guatemala' CC_gg ='Guernsey' CC_gn ='Guinea' CC_gw ='Guinea-Bissau' CC_gy ='Guyana' CC_ht ='Haiti' CC_hm ='Heard Island and McDonald Islands' CC_va ='Holy See (Vatican City State)' CC_hn ='Honduras' CC_hk ='Hong Kong' CC_hu ='Hungary' CC_is ='Iceland' CC_in ='India' CC_id ='Indonesia' CC_ir ='Iran, Islamic Republic of' CC_iq ='Iraq' CC_ie ='Ireland' CC_im ='Isle of Man' CC_il ='Israel' CC_it ='Italy' CC_jm ='Jamaica' CC_jp ='Japan' CC_je ='Jersey' CC_jo ='Jordan' CC_kz ='Kazakhstan' CC_ke ='Kenya' CC_ki ='Kiribati' CC_kp ='Korea, Democratic People\'s Republic of' CC_kr ='Korea, Republic of' CC_kw ='Kuwait' CC_kg ='Kyrgyzstan' CC_la ='Lao People\'s Democratic Republic' CC_lv ='Latvia' CC_lb ='Lebanon' CC_ls ='Lesotho' CC_lr ='Liberia' CC_ly ='Libya' CC_li ='Liechtenstein' CC_lt ='Lithuania' CC_lu ='Luxembourg' CC_mo ='Macao' CC_mk ='Macedonia, The Former Yugoslav Republic of' CC_mg ='Madagascar' CC_mw ='Malawi' CC_my ='Malaysia' CC_mv ='Maldives' CC_ml ='Mali' CC_mt ='Malta' CC_mh ='Marshall Islands' CC_mq ='Martinique' CC_mr ='Mauritania' CC_mu ='Mauritius' CC_yt ='Mayotte' CC_mx ='Mexico' CC_fm ='Micronesia, Federated States of' CC_md ='Moldova, Republic of' CC_mc ='Monaco' CC_mn ='Mongolia' CC_me ='Montenegro' CC_ms ='Montserrat' CC_ma ='Morocco' CC_mz ='Mozambique' CC_mm ='Myanmar' CC_na ='Namibia' CC_nr ='Nauru' CC_np ='Nepal' CC_nl ='Netherlands' CC_nc ='New Caledonia' CC_nz ='New Zealand' CC_ni ='Nicaragua' CC_ne ='Niger' CC_ng ='Nigeria' CC_nu ='Niue' CC_nf ='Norfolk Island' CC_mp ='Northern Mariana Islands' CC_no ='Norway' CC_om ='Oman' CC_pk ='Pakistan' CC_pw ='Palau' CC_ps ='Palestinian Territory, Occupied' CC_pa ='Panama' CC_pg ='Papua New Guinea' CC_py ='Paraguay' CC_pe ='Peru' CC_ph ='Philippines' CC_pn ='Pitcairn' CC_pl ='Poland' CC_pt ='Portugal' CC_pr ='Puerto Rico' CC_qa ='Qatar' CC_re ='Réunion' CC_ro ='Romania' CC_ru ='Russian Federation' CC_rw ='Rwanda' CC_bl ='Saint Barthélemy' CC_sh ='Saint Helena, Ascension and Tristan da Cunha' CC_kn ='Saint Kitts and Nevis' CC_lc ='Saint Lucia' CC_mf ='Saint Martin (French Part)' CC_pm ='Saint Pierre and Miquelon' CC_vc ='Saint Vincent and The Grenadines' CC_ws ='Samoa' CC_sm ='San Marino' CC_st ='Sao Tome and Principe' CC_sa ='Saudi Arabia' CC_sn ='Senegal' CC_rs ='Serbia' CC_sc ='Seychelles' CC_sl ='Sierra Leone' CC_sg ='Singapore' CC_sk ='Slovakia' CC_sx ='Sint Maarten (Dutch Part)' CC_si ='Slovenia' CC_sb ='Solomon Islands' CC_so ='Somalia' CC_za ='South Africa' CC_gs ='South Georgia and The South Sandwich Islands' CC_ss ='South Sudan' CC_es ='Spain' CC_lk ='Sri Lanka' CC_sd ='Sudan' CC_sr ='Suriname' CC_sj ='Svalbard and Jan Mayen' CC_sz ='Swaziland' CC_se ='Sweden' CC_ch ='Switzerland' CC_sy ='Syrian Arab Republic' CC_tw ='Taiwan, Province of China' CC_tj ='Tajikistan' CC_tz ='Tanzania, United Republic of' CC_th ='Thailand' CC_tl ='Timor-Leste' CC_tg ='Togo' CC_tk ='Tokelau' CC_to ='Tonga' CC_tt ='Trinidad and Tobago' CC_tn ='Tunisia' CC_tr ='Turkey' CC_tm ='Turkmenistan' CC_tc ='Turks and Caicos Islands' CC_tv ='Tuvalu' CC_ug ='Uganda' CC_ua ='Ukraine' CC_ae ='United Arab Emirates' CC_gb ='United Kingdom' CC_us ='United States' CC_um ='United States Minor Outlying Islands' CC_uy ='Uruguay' CC_uz ='Uzbekistan' CC_vu ='Vanuatu' CC_ve ='Venezuela' CC_vn ='Viet Nam' CC_vg ='Virgin Islands, British' CC_vi ='Virgin Islands, U.S.' CC_wf ='Wallis and Futuna' CC_eh ='Western Sahara' CC_ye ='Yemen' CC_zm ='Zambia' CC_zw ='Zimbabwe' LC_af ='Afrikaans' LC_am ='Amharic' LC_ar ='Arabic' LC_as ='Assamese' LC_ba ='Bashkir' LC_be ='Belarusian' LC_bg ='Bulgarian' LC_bn ='Bengali' LC_bo ='Tibetan' LC_br ='Breton' LC_ca ='Catalan' LC_co ='Corsican' LC_cs ='Czech' LC_cy ='Welsh' LC_da ='Danish' LC_de ='German' LC_dv ='Divehi' LC_el ='Greek' LC_en ='English' LC_es ='Spanish' LC_et ='Estonian' LC_eu ='Basque' LC_fa ='Persian' LC_fi ='Finnish' LC_fo ='Faroese' LC_fr ='French' LC_gd ='Scottish Gaelic' LC_gl ='Galician' LC_gu ='Gujarati' LC_he ='Hebrew' LC_hi ='Hindi' LC_hr ='Croatian' LC_hu ='Hungarian' LC_hy ='Armenian' LC_id ='Indonesian' LC_ig ='Igbo' LC_is ='Icelandic' LC_it ='Italian' LC_ja ='Japanese' LC_ka ='Georgian' LC_kk ='Kazakh' LC_km ='Khmer' LC_kn ='Kannada' LC_ko ='Korean' LC_lb ='Luxembourgish' LC_lo ='Lao' LC_lt ='Lithuanian' LC_lv ='Latvian' LC_mi ='Maori' LC_ml ='Malayalam' LC_mr ='Marathi' LC_ms ='Malay' LC_mt ='Maltese' LC_ne ='Nepali' LC_nl ='Dutch' LC_no ='Norwegian' LC_oc ='Occitan' LC_or ='Oriya' LC_pl ='Polish' LC_ps ='Pashto' LC_pt ='Portuguese' LC_qu ='Quechua' LC_ro ='Romanian' LC_ru ='Russian' LC_rw ='Kinyarwanda' LC_sa ='Sanskrit' LC_si ='Sinhala' LC_sk ='Slovak' LC_sl ='Slovenian' LC_sq ='Albanian' LC_sv ='Swedish' LC_ta ='Tamil' LC_te ='Telugu' LC_th ='Thai' LC_tk ='Turkmen' LC_tr ='Turkish' LC_tt ='Tatar' LC_uk ='Ukrainian' LC_ur ='Urdu'
Inheritance diagram for Audit:
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
- 
-
-