Documentation

API Documentation

Namespaces

DressApi
Composer
Firebase
Predis

Interfaces, Classes and Traits

ComposerAutoloaderInit043a9a21d7b8820c54a6a9bc7e5b3fd9
NaiveDistributor
SimpleDebuggableConnection
Standard connection to Redis servers implemented on top of PHP's streams.
EventsListener
IncrementExistingKeysBy
Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.
HashMultipleGetAll
Base class used to implement an higher level abstraction for commands based on Lua scripting with EVAL and EVALSHA.

Table of Contents

CACHE_MAX_SIZE_PER_ELEMENT  = 64 * 1024
DressAPI
CACHE_PATH  = '/dev/shm/'
CREATION_DATE  = 'creation_date'
DB_HOST  = 'localhost'
DB_HOST  = 'localhost'
DB_NAME  = 'cardcomics'
DB_NAME  = 'dressapi-test'
DB_PASSWORD  = ''
DB_PASSWORD  = ''
DB_PORT  = 3306
DB_PORT  = 3306
DB_USERNAME  = 'root'
DB_USERNAME  = 'root'
DBMS_TYPE  = 'MySql'
DEFAULT_FORMAT_OUTPUT  = 'json'
DEFAULT_ITEMS_PER_PAGE  = 2
DEFAULT_ORDER  = 'DESC'
DOMAIN_NAME  = 'dressapi.com'
DOMAIN_NAME  = 'dressapi.com'
DOMAIN_NAME  = 'DressApi.com'
ITEM_ID  = 'id'
LOG_LEVEL_MIN  = 'info'
MAX_ITEMS_PER_PAGE  = 200
PASSWORD_ENC_ALGORITHM  = 'tiger192,4'
PWD_CRYPT  = '@AShHK#Dfjdx45'
REDIS_HOST  = '127.0.0.1'
REDIS_PASSWORD  = "change me"
REDIS_PORT  = 6379
REDIS_SCHEME  = 'tcp'
REDIS_SELECTION  = 0
DressAPI
REDIS_USERNAME  = "change me"
RELATED_FIELD_NAMES  = [ 'page' => ['title', 'creation_date'], // the value can be an array of strings 'contact' => ['email', 'city'], '*' => 'name', ]
RELATED_TABLE_ID  = 'id_[related_table]'
REQUIRED_ITEMS  = ['student' => [ // item=>rules ['periodicy' => '/[daily|weekly|monthly]/'], ['name' => 'age', 'min' => 17], ['name' => 'vote', 'min' => 18, 'max' => 30], ]]
SAME_TABLE_ID  = 'parent'
SECRET_KEY  = 'bGS6lzFqvvSQ8ALbOxatm7/Vk7mLQyzqaS34Q4oR1ew='
TOKEN_DURATION  = '2 months'
TOKEN_ENC_ALGORITHM  = 'HS512'
UPLOAD_EXT_ACCEPTED  = ['doc', 'docx', 'pdf', 'odf', 'pptx']
UPLOAD_FILE_PATH  = '/var/www/upload/'
USER_ITEM_ID  = 'id'
USER_ITEM_PASSWORD  = 'pwd'
USER_ITEM_USERNAME  = 'username'
USER_TABLE  = 'user'
redis_version()  : mixed
zpop()  : mixed

Constants

CACHE_MAX_SIZE_PER_ELEMENT

DressAPI

public mixed CACHE_MAX_SIZE_PER_ELEMENT = 64 * 1024
Tags
version
1.0
license

This file is under Apache 2.0 license

author

Tufano Pasquale

copyright

Tufano Pasquale

url

https://dressapi.com

Config definitions for Generic Cache

CACHE_PATH

public mixed CACHE_PATH = '/dev/shm/'

CREATION_DATE

public mixed CREATION_DATE = 'creation_date'

DB_HOST

public mixed DB_HOST = 'localhost'

DB_HOST

public mixed DB_HOST = 'localhost'

DB_NAME

public mixed DB_NAME = 'cardcomics'

DB_NAME

public mixed DB_NAME = 'dressapi-test'

DB_PASSWORD

public mixed DB_PASSWORD = ''

DB_PASSWORD

public mixed DB_PASSWORD = ''

DB_PORT

public mixed DB_PORT = 3306

DB_PORT

public mixed DB_PORT = 3306

DB_USERNAME

public mixed DB_USERNAME = 'root'

DB_USERNAME

public mixed DB_USERNAME = 'root'

DBMS_TYPE

public mixed DBMS_TYPE = 'MySql'

DEFAULT_FORMAT_OUTPUT

public mixed DEFAULT_FORMAT_OUTPUT = 'json'

DEFAULT_ITEMS_PER_PAGE

public mixed DEFAULT_ITEMS_PER_PAGE = 2

DEFAULT_ORDER

public mixed DEFAULT_ORDER = 'DESC'

DOMAIN_NAME

public mixed DOMAIN_NAME = 'dressapi.com'

DOMAIN_NAME

public mixed DOMAIN_NAME = 'DressApi.com'

ITEM_ID

public mixed ITEM_ID = 'id'

LOG_LEVEL_MIN

public mixed LOG_LEVEL_MIN = 'info'

MAX_ITEMS_PER_PAGE

public mixed MAX_ITEMS_PER_PAGE = 200

PASSWORD_ENC_ALGORITHM

public mixed PASSWORD_ENC_ALGORITHM = 'tiger192,4'

PWD_CRYPT

public mixed PWD_CRYPT = '@AShHK#Dfjdx45'

REDIS_PASSWORD

public mixed REDIS_PASSWORD = "change me"

REDIS_SELECTION

DressAPI

public mixed REDIS_SELECTION = 0
Tags
version
1.0
license

This file is under Apache 2.0 license

author

Tufano Pasquale

copyright

Tufano Pasquale

url

https://dressapi.com

Config definitions for Redis Cache

REDIS_USERNAME

public mixed REDIS_USERNAME = "change me"
public mixed RELATED_FIELD_NAMES = [ 'page' => ['title', 'creation_date'], // the value can be an array of strings 'contact' => ['email', 'city'], '*' => 'name', ]
public mixed RELATED_TABLE_ID = 'id_[related_table]'

REQUIRED_ITEMS

public mixed REQUIRED_ITEMS = ['student' => [ // item=>rules ['periodicy' => '/[daily|weekly|monthly]/'], ['name' => 'age', 'min' => 17], ['name' => 'vote', 'min' => 18, 'max' => 30], ]]

SAME_TABLE_ID

public mixed SAME_TABLE_ID = 'parent'

SECRET_KEY

public mixed SECRET_KEY = 'bGS6lzFqvvSQ8ALbOxatm7/Vk7mLQyzqaS34Q4oR1ew='

TOKEN_DURATION

public mixed TOKEN_DURATION = '2 months'

TOKEN_ENC_ALGORITHM

public mixed TOKEN_ENC_ALGORITHM = 'HS512'

UPLOAD_EXT_ACCEPTED

public mixed UPLOAD_EXT_ACCEPTED = ['doc', 'docx', 'pdf', 'odf', 'pptx']

UPLOAD_FILE_PATH

public mixed UPLOAD_FILE_PATH = '/var/www/upload/'

USER_ITEM_ID

public mixed USER_ITEM_ID = 'id'

USER_ITEM_PASSWORD

public mixed USER_ITEM_PASSWORD = 'pwd'

USER_ITEM_USERNAME

public mixed USER_ITEM_USERNAME = 'username'

USER_TABLE

public mixed USER_TABLE = 'user'

Functions

redis_version()

redis_version(mixed $info) : mixed
Parameters
$info : mixed
Return values
mixed

zpop()

zpop(mixed $client, mixed $key) : mixed
Parameters
$client : mixed
$key : mixed
Return values
mixed

Search results