• API
  • -
  • Redaxscript

Auth

  • Namespace: Redaxscript
  • Description: parent class to authenticate the user
  • Package: Redaxscript
  • Category: Auth
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_request\Redaxscript\Requestprotectedinstance of the request class
$_userArrayarrayprotectedarray of the user
$_permissionArrayarrayprotectedarray of the permission
$_typeArrayarrayprotectedarray of the type
$_callArrayarrayprotectedarray of the call
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
__constructpublicconstructor of the class
__callpubliccall method as needed
initpublicinit the class
loginpubliclogin the user
logoutpubliclogout the user
getUserpublicget the user
setUserpublicset the user
getPermissionpublicget the permission
setPermissionpublicset the permission
getStatuspublicget the auth status
savepublicsave user and permission
_getAuthprotectedget auth from session
_setAuthprotectedset auth to session
getPermissionNewpublic
getPermissionInstallpublic
getPermissionEditpublic
getPermissionDeletepublic
getPermissionUninstallpublic
getFilterpublic
MethodVisibilityDescription

Autoloader

  • Namespace: Redaxscript
  • Description: parent class to load required class files
  • Package: Redaxscript
  • Category: Autoloader
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_autoloadArrayarrayprotectedarray of the autoload
$_fileExtensionstringprotectedfile extension
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
initpublicinit the class
_loadprotectedload the class file
_getFileprotectedget the file
MethodVisibilityDescription

Breadcrumb

  • Namespace: Redaxscript
  • Description: parent class to create a breadcrumb navigation
  • Package: Redaxscript
  • Category: Breadcrumb
  • Author: Henry Ruhs
  • Author: Gary Aylward

Properties

PropertyTypeVisibilityDescription
$_registry\Redaxscript\Registryprotectedinstance of the registry class
$_language\Redaxscript\Languageprotectedinstance of the language class
$_breadcrumbArrayarrayprotectedarray of the breadcrumb
$_optionArrayarrayprotectedoptions of the breadcrumb
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
__constructpublicconstructor of the class
__toStringpublicstringify the breadcrumb
initpublicinit the class
getArraypublicget the breadcrumb array
renderpublicrender the breadcrumb trail as an unordered list
_createprotectedcreate the breadcrumb array
_createAdminprotectedcreate the breadcrumb array for the administration
_createContentprotectedcreate the breadcrumb array for the content
MethodVisibilityDescription

Cache

  • Namespace: Redaxscript
  • Description: parent class to handle cached files
  • Package: Redaxscript
  • Category: Cache
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_directorystringprotecteddirectory of the cache
$_extensionstringprotectedextension of the cached files
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
initpublicinit the class
getDirectorypublicget the directory
getPathpublicget the path
storepublicstore to cache
retrievepublicretrieve from cache
validatepublicvalidate the cache
clearpublicclear the cache
clearInvalidpublicclear the invalid cache
_getFileprotectedget the file
_validateFileprotectedvalidate the file
MethodVisibilityDescription

Captcha

  • Namespace: Redaxscript
  • Description: parent class to provide a mathematical task
  • Package: Redaxscript
  • Category: Captcha
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_language\Redaxscript\Languageprotectedinstance of the language class
$_modeintegerprotectedcaptcha operator mode
$_taskstringprotectedtask to be solved
$_solutionintegerprotectedsolution to the task
$_rangeArrayarrayprotectedallowed range for the task
$_operatorArrayarrayprotectedarray of mathematical operators used for the task
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
__constructpublicconstructor of the class
initpublicinit the class
getTaskpublicget the task
getSolutionpublicget the solution
getMinpublicget the minimum range
getMaxpublicget the maximum range
_getOperatorprotectedget the mathematical operator used for the task
_createprotectedcreate a task of two numbers between allowable range
MethodVisibilityDescription

Config

  • Namespace: Redaxscript
  • Description: children class to store database config
  • Package: Redaxscript
  • Category: Config
  • Author: Henry Ruhs
  • Inherited from: \Redaxscript\Singleton

Properties

PropertyTypeVisibilityDescription
$_configFilestringprotectedpath to config file
$_configArrayarrayprotectedarray of the config
$_instance\Redaxscript\Singletonprotectedinstance of the class
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
initpublicinit the class
getpublicget item from config
setpublicset item to config
parsepublicparse from database url
writepublicwrite config to file
clearpublicclear the config
__constructprivateconstructor of the class
getInstancepublicget the instance
clearInstancepublicclear the instance
MethodVisibilityDescription

Db

  • Namespace: Redaxscript
  • Description: children class to handle the database
  • Package: Redaxscript
  • Category: Db
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_config\Redaxscript\Configprotectedinstance of the config class
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
constructpublicconstructor of the class
initpublicinit the class
getStatuspublicget the database status
rawInstancepublicraw instance helper
countTablePrefixpubliccount table with prefix
forTablePrefixpublicfor table with prefix
leftJoinPrefixpublicleft join with prefix
whereLikeManypublicwhere like with many
whereLanguageIspublicwhere language is
findFlatArraypublicfind a flat array
getSettingpublicget the setting
setSettingpublicset the setting
orderGlobalpublicorder according to global setting
limitGlobalpubliclimit according to global setting
_addJoinSourcepublic
_addOrderBypublic
_addWherepublic
_setupDbpublic
MethodVisibilityDescription

Directory

  • Namespace: Redaxscript
  • Description: parent class to handle a directory in the filesystem
  • Category: Directory
  • Package: Redaxscript
  • Author: Henry Ruhs
  • Author: Gary Aylward

Properties

PropertyTypeVisibilityDescription
$_directorystringprotectedname of the directory
$_directoryArrayarrayprotectedarray of the directory
$_directoryCachearrayprotectedstatic directory cache
$_excludeArrayarrayprotectedfiles to be excluded
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
initpublicinit the class
getArraypublicget the directory array
createpubliccreate the directory
putpublicput content to file
removepublicremove the path
clearpublicclear the directory
_removeprotectedremove the path
_scanprotectedscan the directory
MethodVisibilityDescription

Hash

  • Namespace: Redaxscript
  • Description: parent class to create a salted hash
  • Package: Redaxscript
  • Category: Hash
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_config\Redaxscript\Configprotectedinstance of the config class
$_rawstringprotectedplain raw
$_hashstringprotectedsalted hash
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
__constructpublicconstructor of the class
initpublicinit the class
getRawpublicget the raw
getHashpublicget the hash
validatepublicvalidate raw again hash
_createprotectedcreate a salted hash
MethodVisibilityDescription

Installer

  • Namespace: Redaxscript
  • Description: parent class to install the database
  • Category: Installer
  • Package: Redaxscript
  • Author: Henry Ruhs

Properties

PropertyTypeVisibilityDescription
$_registry\Redaxscript\Registryprotectedinstance of the registry class
$_request\Redaxscript\Requestprotectedinstance of the request class
$_language\Redaxscript\Languageprotectedinstance of the language class
$_config\Redaxscript\Configprotectedinstance of the config class
$_directorystringprotectedname of the directory
$_prefixPlaceholderstringprotectedplaceholder for the prefix
PropertyTypeVisibilityDescription

Methods

MethodVisibilityDescription
__constructpublicconstructor of the class
initpublicinit the class
rawCreatepubliccreate from sql
rawDroppublicdrop from sql
insertDatapublicinsert the data
insertCategoriespublicinsert the categories
insertArticlespublicinsert the articles
insertExtraspublicinsert the extras
insertCommentspublicinsert the comments
insertGroupspublicinsert the groups
insertUserspublicinsert the users
insertModulespublicinsert the modules
insertSettingspublicinsert the settings
_rawExecuteprotectedexecute from sql
MethodVisibilityDescription