]> Kevux Git Server - koopa/commitdiff
Cleanup: Rename t_database_reset to t_database_reset_configuration_parameter
authorKevin Day <thekevinday@gmail.com>
Wed, 16 Jan 2019 01:51:35 +0000 (19:51 -0600)
committerKevin Day <thekevinday@gmail.com>
Wed, 16 Jan 2019 01:51:35 +0000 (19:51 -0600)
common/database/classes/database_alter_role.php
common/database/traits/database_reset_configuration_parameter.php [moved from common/database/traits/database_reset.php with 62% similarity]

index 711a2d1555a5bbc25c4e0e67c0b3176a08b0d5ad..ab8430a3349356719ae18d7b3ca697c5eff3aaea 100644 (file)
@@ -13,7 +13,7 @@ require_once('common/database/classes/database_query.php');
 require_once('common/database/traits/database_in_database.php');
 require_once('common/database/traits/database_name.php');
 require_once('common/database/traits/database_rename_to.php');
-require_once('common/database/traits/database_reset.php');
+require_once('common/database/traits/database_reset_configuration_parameter.php');
 require_once('common/database/traits/database_role_specification.php');
 require_once('common/database/traits/database_set_configuration_parameter.php');
 require_once('common/database/traits/database_with_role_option.php');
@@ -28,7 +28,7 @@ class c_database_alter_role extends c_database_query {
   use t_database_in_database;
   use t_database_name;
   use t_database_rename_to;
-  use t_database_reset;
+  use t_database_reset_configuration_parameter;
   use t_database_role_option;
   use t_database_role_specification;
   use t_database_set_configuration_parameter;
@@ -42,13 +42,13 @@ class c_database_alter_role extends c_database_query {
   public function __construct() {
     parent::__construct();
 
-    $this->in_database                 = NULL;
-    $this->name                        = NULL;
-    $this->rename                      = NULL;
-    $this->reset                       = NULL;
-    $this->role_specification          = NULL;
-    $this->set_configuration_parameter = NULL;
-    $this->with_role_option            = NULL;
+    $this->in_database                   = NULL;
+    $this->name                          = NULL;
+    $this->rename                        = NULL;
+    $this->reset_configuration_parameter = NULL;
+    $this->role_specification            = NULL;
+    $this->set_configuration_parameter   = NULL;
+    $this->with_role_option              = NULL;
   }
 
   /**
@@ -58,7 +58,7 @@ class c_database_alter_role extends c_database_query {
     unset($this->in_database);
     unset($this->name);
     unset($this->rename);
-    unset($this->reset);
+    unset($this->reset_configuration_parameter);
     unset($this->role_specification);
     unset($this->set_configuration_parameter);
     unset($this->with_role_option);
@@ -113,8 +113,8 @@ class c_database_alter_role extends c_database_query {
       if (isset($this->set_configuration_parameter)) {
         $value .= ' ' . $this->p_do_build_set_configuration_parameter();
       }
-      else if (isset($this->reset)) {
-        $value .= ' ' . $this->p_do_build_reset();
+      else if (isset($this->reset_configuration_parameter)) {
+        $value .= ' ' . $this->p_do_build_reset_configuration_parameter();
       }
       else {
         unset($value);
similarity index 62%
rename from common/database/traits/database_reset.php
rename to common/database/traits/database_reset_configuration_parameter.php
index 985a90d4cc0384efcda9a6ad7279982f85267180..688ba4f67f5d76e52bf388245b6d5d03f88562bb 100644 (file)
@@ -15,15 +15,15 @@ require_once('common/database/classes/database_string.php');
 require_once('common/database/enumerations/database_reset.php');
 
 /**
- * Provide the sql RESET functionality.
+ * Provide the sql RESET configuration_parameter functionality.
  */
-trait t_database_reset {
-  protected $reset;
+trait t_database_reset_configuration_parameter {
+  protected $reset_configuration_parameter;
 
   /**
-   * Set the RESET settings.
+   * Set the RESET configuration_parameter settings.
    *
-   * @param int|null $reset
+   * @param int|null $type
    *   The reset code to assign.
    *   Should be one of: e_database_reset.
    *   Set to NULL to disable.
@@ -35,18 +35,18 @@ trait t_database_reset {
    *   TRUE on success, FALSE otherwise.
    *   FALSE with the error bit set is returned on error.
    */
-  public function set_reset($reset, $parameter = NULL) {
-    if (is_null($reset)) {
-      $this->reset = NULL;
+  public function set_reset_configuration_parameter($type, $parameter = NULL) {
+    if (is_null($type)) {
+      $this->reset_configuration_parameter = NULL;
       return new c_base_return_true();
     }
 
-    if (!is_int($reset)) {
-      $error = c_base_error::s_log(NULL, ['arguments' => [':{argument_name}' => 'reset', ':{function_name}' => __CLASS__ . '->' . __FUNCTION__]], i_base_error_messages::INVALID_ARGUMENT);
+    if (!is_int($type)) {
+      $error = c_base_error::s_log(NULL, ['arguments' => [':{argument_name}' => 'type', ':{function_name}' => __CLASS__ . '->' . __FUNCTION__]], i_base_error_messages::INVALID_ARGUMENT);
       return c_base_return_error::s_false($error);
     }
 
-    if ($reset === e_database_reset::PARAMETER) {
+    if ($type === e_database_reset::PARAMETER) {
       if (!is_null($parameter) || !is_string($parameter)) {
         $error = c_base_error::s_log(NULL, ['arguments' => [':{argument_name}' => 'parameter', ':{function_name}' => __CLASS__ . '->' . __FUNCTION__]], i_base_error_messages::INVALID_ARGUMENT);
         return c_base_return_error::s_false($error);
@@ -57,17 +57,17 @@ trait t_database_reset {
         return c_base_return_error::s_false($placeholder->get_error());
       }
 
-      $this->reset = [
-        'type' => $reset,
+      $this->reset_configuration_parameter = [
+        'type' => $type,
         'value' => $placeholder,
       ];
       unset($placeholder);
 
       return new c_base_return_true();
     }
-    else if ($reset == e_database_reset::ALL) {
-      $this->reset = [
-        'type' => $reset,
+    else if ($type == e_database_reset::ALL) {
+      $this->reset_configuration_parameter = [
+        'type' => $type,
         'value' => NULL,
       ];
 
@@ -78,23 +78,23 @@ trait t_database_reset {
   }
 
   /**
-   * Get the currently assigned reset settings.
+   * Get the currently assigned reset configuration_parameter settings.
    *
    * @return c_base_return_array|c_base_return_null
    *   An array containing reset settings on success.
    *   NULL is returned if not set (reset tablespace is not to be used).
    *   NULL with the error bit set is returned on error.
    */
-  public function get_reset() {
-    if (is_null($this->reset)) {
+  public function get_reset_configuration_parameter() {
+    if (is_null($this->reset_configuration_parameter)) {
       return new c_base_return_null();
     }
 
-    if (is_array($this->reset)) {
-      return c_base_return_array::s_new($this->reset);
+    if (is_array($this->reset_configuration_parameter)) {
+      return c_base_return_array::s_new($this->reset_configuration_parameter);
     }
 
-    $error = c_base_error::s_log(NULL, ['arguments' => [':{variable_name}' => 'reset', ':{function_name}' => __CLASS__ . '->' . __FUNCTION__]], i_base_error_messages::INVALID_VARIABLE);
+    $error = c_base_error::s_log(NULL, ['arguments' => [':{variable_name}' => 'reset_configuration_parameter', ':{function_name}' => __CLASS__ . '->' . __FUNCTION__]], i_base_error_messages::INVALID_VARIABLE);
     return c_base_return_error::s_null($error);
   }
 
@@ -107,12 +107,12 @@ trait t_database_reset {
    *   A string is returned on success.
    *   NULL is returned if there is nothing to process or there is an error.
    */
-  protected function p_do_build_reset() {
+  protected function p_do_build_reset_configuration_parameter() {
     $value = NULL;
-    if ($this->reset['type'] === e_database_reset::PARAMETER) {
-      $value = c_database_string::RESET . ' ' . $this->reset['value'];
+    if ($this->reset_configuration_parameter['type'] === e_database_reset::PARAMETER) {
+      $value = c_database_string::RESET . ' ' . $this->reset_configuration_parameter['value'];
     }
-    else if ($this->reset['type'] === e_database_reset::ALL) {
+    else if ($this->reset_configuration_parameter['type'] === e_database_reset::ALL) {
       $value = c_database_string::RESET . ' ' . c_database_string::ALL;
     }