From: Philipp Date: Tue, 12 Jul 2022 22:27:39 +0000 (+0200) Subject: Add docs X-Git-Url: https://git.mxchange.org/?a=commitdiff_plain;h=74c5c66cb5bbd494eba4c329c129218f4ce6ec25;p=friendica.git Add docs --- diff --git a/src/Util/Writer/ViewDefinitionSqlWriter.php b/src/Util/Writer/ViewDefinitionSqlWriter.php index 5e6715b6f4..429a7dc5cb 100644 --- a/src/Util/Writer/ViewDefinitionSqlWriter.php +++ b/src/Util/Writer/ViewDefinitionSqlWriter.php @@ -23,8 +23,18 @@ namespace Friendica\Util\Writer; use Friendica\Database\Definition\ViewDefinition; +/** + * SQL writer utility for the db view definition + */ class ViewDefinitionSqlWriter { + /** + * Creates a complete SQL definition bases on a give View Definition class + * + * @param ViewDefinition $definition The View definition class + * + * @return string The SQL definition as a string + */ public static function create(ViewDefinition $definition): string { $sqlString = ''; @@ -40,11 +50,26 @@ class ViewDefinitionSqlWriter return $sqlString; } + /** + * Creates the SQL definition to drop a view + * + * @param string $viewName the view name + * + * @return string The SQL definition + */ public static function dropView(string $viewName): string { return sprintf("DROP VIEW IF EXISTS `%s`", static::escape($viewName)) . ";\n"; } + /** + * Creates the SQL definition to create a new view + * + * @param string $viewName The view name + * @param array $viewStructure The structure information of the view + * + * @return string The SQL definition + */ public static function createView(string $viewName, array $viewStructure): string { $sql_rows = []; @@ -59,6 +84,13 @@ class ViewDefinitionSqlWriter implode(",\n\t", $sql_rows) . "\n\t" . $viewStructure['query'] . ";\n\n"; } + /** + * Standard escaping for SQL definitions + * + * @param string $sqlString the SQL string to escape + * + * @return string escaped SQL string + */ public static function escape(string $sqlString): string { return str_replace("'", "\\'", $sqlString);