cookie.name
The name of the cookie as it is stored on the user’s machine.
Date Type: String
Default: ipinga
Example
1 2 |
$cookieName = $iPinga->config('cookie.name'); echo $cookieName; // outputs 'ipinga' |
cookie.expiration_time
The number of seconds before the cookie expires on the user’s machine
Date Type: Integer
Default: 2592000 (30 days from now)
Example
1 2 |
$cookieTime = $iPinga->config('cookie.expiration_time'); echo $cookieTime; // outputs 2592000 |
encryption.algorithm
The encryption algorithm used by the \ipinga\crypto class as well as for encrypting cookies. It is beyond the scope of this documentation to explain the mcrypt
extension for PHP. I suggest you visit http://php.net/manual/en/book.mcrypt.php for more information about encryption and the mcrypt
extension.
Date Type: Integer
Default: MCRYPT_RIJNDAEL_128
Example
1 |
$iPinga->config('encryption.algorithm',MCRYPT_RIJNDAEL_256); |
encryption.iv
The IV used by the \ipinga\crypto class as well as for encrypting cookies. It is beyond the scope of this documentation to explain the mcrypt
extension for PHP. I suggest you visit http://php.net/manual/en/book.mcrypt.php for more information about encryption and the mcrypt
extension.
Date Type: String
Default: md5(‘iPinga’)
Example
1 |
$iPinga->config('encryption.iv',md5('whatever you like here')); |
encryption.key
The encryption key used by the \ipinga\crypto class as well as for encrypting cookies. It is beyond the scope of this documentation to explain the mcrypt
extension for PHP. I suggest you visit http://php.net/manual/en/book.mcrypt.php for more information about encryption and the mcrypt
extension.
Date Type: string
Default: ‘you should change this’
Example
1 |
$iPinga->config('encryption.key','your secret code goes here'); |
encryption.mode
The MODE used by the \ipinga\crypto class as well as for encrypting cookies. It is beyond the scope of this documentation to explain the mcrypt
extension for PHP. I suggest you visit http://php.net/manual/en/book.mcrypt.php for more information about encryption and the mcrypt
extension.
Date Type: Integer
Default: MCRYPT_MODE_CBC
Example
1 |
$iPinga->config('encryption.mode',MCRYPT_MODE_CBC); |
logfile
Specifies where the filename for the system logfile. I suggest you name it with a file extension of .php to prevent the webserver from serving it to a curious user.
Date Type: String
Default: \logfile.php
Example
1 |
$iPinga->config('logfile','myapp.log'); |
manager.expired_url
The relative or absolute URL to redirect the user to if his session has expired due to inactivity.
Date Type: String
Default: /index/expired
Example
1 |
$iPinga->config('manager.expired_url','http://wherever.com/'); |
manager.ip_changed_url
The relative or absolute URL to redirect the user to if his IP ADDRESS has changed since his last interaction with the site
Date Type: String
Default: /index/ip_changed
Example
1 |
$iPinga->config('manager.ip_changed_url','http://wherever.com/something_is_wrong'); |
manager.login_url
The relative or absolute URL to redirect the user to if he is not successfully logged into your application
Date Type: String
Default: /index/login
Example
1 |
$iPinga->config('manager.login_url','http://wherever.com/login_here'); |
manager.max_minutes
The number of minutes before a user has timed out and must login again
Date Type: Integer
Default: 10
Example
1 |
$iPinga->config('manager.max_minutes', 15 ); |
mysql.database
Name of the MySQL database you want to connect to
Date Type: String
Default: ‘your_db_name’
Example
1 |
$iPinga->config('mysql.database', 'production_something' ); |
mysql.host
Name of the MySQL host you want to connect to
Date Type: String
Default: ‘localhost’
Example
1 |
$iPinga->config('mysql.host', 'localhost' ); |
mysql.password
Your MySQL password
Date Type: String
Default: ‘your_db_password’
Example
1 |
$iPinga->config('mysql.password', 'SDGefgFDSG^sdgsdg43#' ); |
mysql.user
Your MySQL user name
Date Type: String
Default: ‘your_db_user’
Example
1 |
$iPinga->config('mysql.user', 'your_user_name_here'); |
path.classes
The absolute path to the filesystem directory that contains all your classes
source files. Typically this is a folder immediately below where your public_html
folder.
Date Type: String
Default: the return value from a call to the PHP function getcwd() concatenated with ‘/classes’
Example
1 2 |
$path = $iPinga->config('path.classes'); echo $path; // outputs /home/user/example.com/public_html/classes |
path.controllers
The absolute path to the filesystem directory that contains all your controller
source files. Typically this is a folder immediately below where your public_html
folder.
Date Type: String
Default: the return value from a call to the PHP function getcwd() concatenated with ‘/controllers’
Example
1 2 |
$path = $iPinga->config('path.controllers'); echo $path; // outputs /home/user/example.com/public_html/controllers |
path.cwd
The absolute path to the filesystem directory that contains your index.php
file. This path is used internally to build paths to other files in your application and defaults to the return value of the getcwd()
function. Presumably this would be the path to your public_html
folder. Notice: no trailing slash is permitted.
Date Type: String
Default: the return value from a call to the PHP function getcwd()
Example
1 2 |
$path = $iPinga->config('path.cwd'); echo $path; // outputs /home/user/example.com/public_html |
path.framework
The absolute path to the filesystem directory that contains the iPinga library code. If you are using composer
, this is typically in a folder called vendors/vernsix/ipinga/src
beneath your public_html
folder.
Date Type: String
Example
1 2 |
$path = $iPinga->config('path.framework'); echo $path; // outputs /home/user/example.com/public_html/vendors/vernsix/ipinga/src |
path.middleware
The absolute path to the filesystem directory that contains all your middleware
source files. Typically this is a folder immediately below where your public_html
folder.
Date Type: String
Default: the return value from a call to the PHP function getcwd() concatenated with ‘/middleware’
Example
1 2 |
$path = $iPinga->config('path.middleware'); echo $path; // outputs /home/user/example.com/public_html/middleware |
path.models
The absolute path to the filesystem directory that contains all your model
source files. Typically this is a folder immediately below where your public_html
folder.
Date Type: String
Default: the return value from a call to the PHP function getcwd() concatenated with ‘/models’
Example
1 2 |
$path = $iPinga->config('path.models'); echo $path; // outputs /home/user/example.com/public_html/models |
path.views
The absolute path to the filesystem directory that contains all your view
source files. Typically this is a folder immediately below where your public_html
folder.
Date Type: String
Default: the return value from a call to the PHP function getcwd() concatenated with ‘/views’
Example
1 2 |
$path = $iPinga->config('path.views'); echo $path; // outputs /home/user/example.com/public_html/views |
time.timezone
The timezone where your server will be running. For a complete list of acceptable timezones, please visit http://php.net/manual/en/timezones.php
Date Type: String
Default: ‘America/Chicago
Example
1 2 |
$timezone = $iPinga->config('time.timezone'); echo $timezone; // outputs America/Chicago |