diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/dev-function-overview.md | 10 | ||||
| -rw-r--r-- | doc/developer_function_primer.bb | 4 |
2 files changed, 11 insertions, 3 deletions
diff --git a/doc/dev-function-overview.md b/doc/dev-function-overview.md index cd2526ead..4dccc8cef 100644 --- a/doc/dev-function-overview.md +++ b/doc/dev-function-overview.md @@ -21,11 +21,15 @@ returns an xchan structure representing the current viewer if authenticated (loc * get_config($family,$key), get_pconfig($uid,$family,$key) -Returns the config setting for $family and $key or false if unset. +Returns the config setting for $family and $key or false if unset. + +Deprecated: Use Zotlabs\Lib\Config::Get instead. * set_config($family,$key,$value), set_pconfig($uid,$family,$key,$value) -Sets the value of config setting for $family and $key to $value. Returns $value. The config versions operate on system-wide settings. The pconfig versions get/set the values for a specific integer uid (channel_id). +Sets the value of config setting for $family and $key to $value. Returns $value. The config versions operate on system-wide settings. The pconfig versions get/set the values for a specific integer uid (channel_id). + +Deprecated: Use Zotlabs\Lib\Config::Set instead. * dbesc() @@ -33,7 +37,7 @@ Always escape strings being used in DB queries. This function returns the escape * q($sql,$var1...) -Perform a DB query with the SQL statement $sql. printf style arguments %s and %d are replaced with variable arguments, which should each be appropriately dbesc() or intval(). SELECT queries return an array of results or false if SQL or DB error. Other queries return true if the command was successful or false if it wasn't. +Perform a DB query with the SQL statement $sql. printf style arguments %s and %d are replaced with variable arguments, which should each be appropriately dbesc() or intval(). SELECT queries return an array of results or false if SQL or DB error. Other queries return true if the command was successful or false if it wasn't. * t($string) diff --git a/doc/developer_function_primer.bb b/doc/developer_function_primer.bb index 48af9523d..f39954d73 100644 --- a/doc/developer_function_primer.bb +++ b/doc/developer_function_primer.bb @@ -20,10 +20,14 @@ returns an xchan structure representing the current viewer if authenticated (loc Returns the config setting for $family and $key or false if unset. +Deprecated: Use Zotlabs\Lib\Config::Get instead. + [b] set_config($family,$key,$value), set_pconfig($uid,$family,$key,$value)[/b] Sets the value of config setting for $family and $key to $value. Returns $value. The config versions operate on system-wide settings. The pconfig versions get/set the values for a specific integer uid (channel_id). The xconfig version get/sets the value for a specific xchan hash - generally used for remote users. +Deprecated: Use Zotlabs\Lib\Config::Set instead. + [b]dbesc()[/b] Always escape strings being used in DB queries. This function returns the escaped string. Integer DB parameters should all be proven integers by wrapping with intval() |