Scriptlog Docs

Scriptlog Documentation

Code reference for the Scriptlog codebase

User Tools

Site Tools


scriptlog:lib:dao:configurationdao

Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision
Previous revision
scriptlog:lib:dao:configurationdao [2026/09/26 09:09] – admin adminscriptlog:lib:dao:configurationdao [2026/09/26 09:34] (current) – admin admin
Line 10: Line 10:
 ======= Docblock Metadata ======= ======= Docblock Metadata =======
  
-  ^ Tag ^ Value ^ +^ Tag ^ Value ^ 
-  | ''@category'' | Dao Class | +| ''@category'' | Dao Class | 
-  | ''@author'' | M.Noermoehammad | +| ''@author'' | M.Noermoehammad | 
-  | ''@license'' | MIT | +| ''@license'' | MIT | 
-  | ''@version'' | 1.0 | +| ''@version'' | 1.0 | 
-  | ''@since'' | Since Release 1.0 |+| ''@since'' | Since Release 1.0 |
  
 ======= Inheritance ======= ======= Inheritance =======
  
-  ^ Relation ^ Type ^ Meaning ^ +^ Relation ^ Type ^ Meaning ^ 
-  | extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface |+| extends | [[scriptlog:lib:core:dao|''Dao'']] | parent class/interface |
  
 ======= Constants (0) ======= ======= Constants (0) =======
Line 26: Line 26:
 //None.// //None.//
  
-======= Properties (0) =======+======= Properties (1) =======
  
-//None declared.//+^ Visibility ^ Type ^ Name ^ Default ^ Line ^ 
 +| ''private'' | ''(untyped)'' | ''$selected'' |  | 22 |
  
 ======= Methods (14) ======= ======= Methods (14) =======
  
-  ^ Visibility ^ Method ^ Summary ^ Line ^ +^ Visibility ^ Method ^ Summary ^ Line ^ 
-  | public | ''__construct()'' | (undocumented) | 27 | +| public | ''__construct()'' | (undocumented) | 27 | 
-  | public | ''updateConfig()'' | Update configuration | 42 | +| public | ''updateConfig()'' | Update configuration | 42 | 
-  | public | ''deleteConfig()'' | Delete config | 63 | +| public | ''deleteConfig()'' | Delete config | 63 | 
-  | public | ''findConfigs()'' | Find configurations | 77 | +| public | ''findConfigs()'' | Find configurations | 77 | 
-  | public | ''findGeneralConfigs()'' | Find general configurations | 97 | +| public | ''findGeneralConfigs()'' | Find general configurations | 97 | 
-  | public | ''findReadingConfigs()'' | findReadingConfigs | 115 | +| public | ''findReadingConfigs()'' | findReadingConfigs | 115 | 
-  | public | ''findConfig()'' | Find Configuration | 135 | +| public | ''findConfig()'' | Find Configuration | 135 | 
-  | public | ''findConfigByName()'' | findConfigByName | 157 | +| public | ''findConfigByName()'' | findConfigByName | 157 | 
-  | public | ''checkConfigId()'' | Check configuration Id | 179 | +| public | ''checkConfigId()'' | Check configuration Id | 179 | 
-  | public | ''checkToSetup()'' | Checking to setup | 192 | +| public | ''checkToSetup()'' | Checking to setup | 192 | 
-  | public | ''dropDownTimezone()'' | dropDownTimezone | 206 | +| public | ''dropDownTimezone()'' | dropDownTimezone | 206 | 
-  | public | ''totalConfigRecords()'' | Total Config records | 242 | +| public | ''totalConfigRecords()'' | Total Config records | 242 | 
-  | public | ''createConfig()'' | Create a new configuration entry | 255 | +| public | ''createConfig()'' | Create a new configuration entry | 255 | 
-  | public | ''updateConfigByName()'' | Update configuration by name | 276 |+| public | ''updateConfigByName()'' | Update configuration by name | 276 |
  
  
Line 70: Line 71:
 Update configuration Update configuration
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// | +|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$bind'' | ''(untyped)'' | //required// | //none// | +|  ''$bind'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$configId'' | ''(untyped)'' | //required// | //none// |+|  ''$configId'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 88: Line 89:
 Delete config Delete config
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$configId'' | ''(untyped)'' | //required// | //none// | +|  ''$configId'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 105: Line 106:
 Find configurations Find configurations
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$orderBy'' | ''(untyped)'' | '''ID''' | -- default order by ID |+|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  -- default order by ID |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 121: Line 122:
 Find general configurations Find general configurations
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// | +|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// | 
-  | ''$limit'' | ''(untyped)'' | ''7'' | //none// |+|  ''$limit'' |  ''(untyped)'' |  ''7'' |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 138: Line 139:
 findReadingConfigs findReadingConfigs
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$orderBy'' | ''(untyped)'' | '''ID''' | //none// |+|  ''$orderBy'' |  ''(untyped)'' |  '''ID''' |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 154: Line 155:
 Find Configuration Find Configuration
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$id'' | ''(untyped)'' | //required// | //none// | +|  ''$id'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 171: Line 172:
 findConfigByName findConfigByName
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$setting_name'' | ''(untyped)'' | //required// | //none// | +|  ''$setting_name'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — array **Returns:** ''(none declared)'' — array
Line 188: Line 189:
 Check configuration Id Check configuration Id
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$id'' | ''(untyped)'' | //required// | //none// | +|  ''$id'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 220: Line 221:
 dropDownTimezone dropDownTimezone
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$selected'' | ''(untyped)'' | ''null'' | //none// |+|  ''$selected'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' **Returns:** ''(none declared)''
Line 236: Line 237:
 Total Config records Total Config records
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$data'' | ''(untyped)'' | ''null'' | //none// |+|  ''$data'' |  ''(untyped)'' |  ''null'' |  //none// |
  
 **Returns:** ''(none declared)'' — integer|numeric **Returns:** ''(none declared)'' — integer|numeric
Line 252: Line 253:
 Create a new configuration entry Create a new configuration entry
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$settingName'' | ''(untyped)'' | //required// | //none// | +|  ''$settingName'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$settingValue'' | ''(untyped)'' | //required// | //none// | +|  ''$settingValue'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 270: Line 271:
 Update configuration by name Update configuration by name
  
-  ^ Parameter ^ Type ^ Default ^ Description ^ +^  Parameter ^  Type ^  Default ^  Description ^ 
-  | ''$settingName'' | ''(untyped)'' | //required// | //none// | +|  ''$settingName'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$settingValue'' | ''(untyped)'' | //required// | //none// | +|  ''$settingValue'' |  ''(untyped)'' |  //required// |  //none// | 
-  | ''$sanitize'' | ''(untyped)'' | //required// | //none// |+|  ''$sanitize'' |  ''(untyped)'' |  //required// |  //none// |
  
 **Returns:** ''(none declared)'' — bool **Returns:** ''(none declared)'' — bool
Line 279: Line 280:
 ======= Imports ======= ======= Imports =======
  
-  ^ Alias ^ Fully-qualified name ^ +^ Alias ^ Fully-qualified name ^ 
-  | ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |+| ''Dao'' | [[scriptlog:lib:core:dao|''Scriptlog\Core\Dao'']] |
  
  
scriptlog/lib/dao/configurationdao.1790413760.txt.gz · Last modified: by admin