From d299b87a145ff1ad39972696c41b518a9ba17cc0 Mon Sep 17 00:00:00 2001
From: Josh Pollock <josh@calderawp.com>
Date: Wed, 4 Apr 2018 20:41:21 -0400
Subject: [PATCH] Clean up code
---
Tests/Traits/CanCreateEntryWithEmailField.php | 12 +++++-----
Tests/Traits/HasFactories.php | 2 +-
Tests/Traits/UsersMockFormAsDBForm.php | 2 --
Tests/Unit/Delete/DeleteQueryBuilderTest.php | 9 +++-----
...{DoesQueries.php => CreatesSqlQueries.php} | 7 +++++-
src/Delete/DeleteQueryBuilder.php | 5 ++---
src/Delete/DoesDeleteQuery.php | 4 +---
src/Delete/Entry.php | 3 +--
src/Delete/EntryValues.php | 10 ++++-----
src/EntryQueries.php | 5 +++++
src/Escape.php | 8 +++----
src/QueriesEntries.php | 5 +++++
src/QueryBuilder.php | 22 ++++++++++++-------
src/Select/EntryValues.php | 2 +-
src/Select/SelectQueryBuilder.php | 8 ++-----
15 files changed, 55 insertions(+), 49 deletions(-)
rename src/{DoesQueries.php => CreatesSqlQueries.php} (72%)
diff --git a/Tests/Traits/CanCreateEntryWithEmailField.php b/Tests/Traits/CanCreateEntryWithEmailField.php
index c3de5af..16d01bd 100644
--- a/Tests/Traits/CanCreateEntryWithEmailField.php
+++ b/Tests/Traits/CanCreateEntryWithEmailField.php
@@ -19,19 +19,19 @@ trait CanCreateEntryWithEmailField
*
* @return int
*/
- protected function createEntryWithEmail( $email = 'hiroy@hiroy.club' )
+ protected function createEntryWithEmail($email = 'hiroy@hiroy.club')
{
$fieldData = [];
$emailFieldConfig = $this->getEmailField();
- foreach( $this->mock_form[ 'fields' ] as $fieldId => $fieldConfig ){
- if ( $fieldId === $emailFieldConfig[ 'ID'] ) {
+ foreach ($this->mock_form[ 'fields' ] as $fieldId => $fieldConfig) {
+ if ($fieldId === $emailFieldConfig[ 'ID']) {
$fieldData[ $fieldId ] = $email;
} else {
$fieldData[ $fieldId ] = rand() . $fieldId;
}
}
- return \Caldera_Forms_Save_Final::create_entry( $this->mock_form, $fieldData );
+ return \Caldera_Forms_Save_Final::create_entry($this->mock_form, $fieldData);
}
/**
@@ -41,7 +41,7 @@ trait CanCreateEntryWithEmailField
*/
protected function getEmailField()
{
- return \Caldera_Forms_Field_Util::get_field_by_slug( 'email', $this->mock_form );
+ return \Caldera_Forms_Field_Util::get_field_by_slug('email', $this->mock_form);
}
/**
@@ -53,4 +53,4 @@ trait CanCreateEntryWithEmailField
{
return $this->getEmailField()[ 'slug' ];
}
-}
\ No newline at end of file
+}
diff --git a/Tests/Traits/HasFactories.php b/Tests/Traits/HasFactories.php
index ad3e5eb..378b308 100644
--- a/Tests/Traits/HasFactories.php
+++ b/Tests/Traits/HasFactories.php
@@ -84,7 +84,7 @@ trait HasFactories
protected function getWPDB()
{
global $wpdb;
- if (! class_exists( '\WP_User')) {
+ if (! class_exists('\WP_User')) {
include_once dirname(dirname(__FILE__)) . '/Mock/wpdb.php';
}
diff --git a/Tests/Traits/UsersMockFormAsDBForm.php b/Tests/Traits/UsersMockFormAsDBForm.php
index 595bc9a..cb44455 100644
--- a/Tests/Traits/UsersMockFormAsDBForm.php
+++ b/Tests/Traits/UsersMockFormAsDBForm.php
@@ -23,6 +23,4 @@ trait UsersMockFormAsDBForm
$this->mock_form = \Caldera_Forms_Forms::get_form($this->mock_form_id);
parent::setUp();
}
-
-
}
diff --git a/Tests/Unit/Delete/DeleteQueryBuilderTest.php b/Tests/Unit/Delete/DeleteQueryBuilderTest.php
index e7ad222..a52929f 100644
--- a/Tests/Unit/Delete/DeleteQueryBuilderTest.php
+++ b/Tests/Unit/Delete/DeleteQueryBuilderTest.php
@@ -3,7 +3,6 @@
namespace calderawp\CalderaFormsQuery\Tests\Unit\Delete;
-
use calderawp\CalderaFormsQuery\Delete\DeleteQueryBuilder;
use calderawp\CalderaFormsQuery\MySqlBuilder;
use calderawp\CalderaFormsQuery\Tests\Unit\TestCase;
@@ -40,7 +39,6 @@ class DeleteQueryBuilderTest extends TestCase
$entryValues = $this->entryValuesDeleteGeneratorFactory();
$this->assertTrue(is_a($entryValues->getBuilder(), MySqlBuilder::class));
-
}
/**
@@ -56,7 +54,6 @@ class DeleteQueryBuilderTest extends TestCase
$entryValues = $this->entryValuesDeleteGeneratorFactory();
$this->assertTrue(is_a($entryValues->getDeleteQuery(), Delete::class));
-
}
/**
@@ -68,10 +65,10 @@ class DeleteQueryBuilderTest extends TestCase
public function testGetDeleteQueryAndCurrentQueryAreSame()
{
$entry = $this->entryDeleteGeneratorFactory();
- $this->assertSame( $entry->getDeleteQuery(), $entry->getCurrentQuery() );
+ $this->assertSame($entry->getDeleteQuery(), $entry->getCurrentQuery());
$entryValues = $this->entryValuesDeleteGeneratorFactory();
- $this->assertSame( $entryValues->getDeleteQuery(), $entryValues->getCurrentQuery() );
+ $this->assertSame($entryValues->getDeleteQuery(), $entryValues->getCurrentQuery());
}
/**
@@ -99,4 +96,4 @@ class DeleteQueryBuilderTest extends TestCase
->getName()
);
}
-}
\ No newline at end of file
+}
diff --git a/src/DoesQueries.php b/src/CreatesSqlQueries.php
similarity index 72%
rename from src/DoesQueries.php
rename to src/CreatesSqlQueries.php
index 858870f..546475d 100644
--- a/src/DoesQueries.php
+++ b/src/CreatesSqlQueries.php
@@ -3,7 +3,12 @@
namespace calderawp\CalderaFormsQuery;
-interface DoesQueries
+/**
+ * Interface CreatesSqlQueries
+ *
+ * Interface that all classes that create SQL queries MUST impliment
+ */
+interface CreatesSqlQueries
{
/**
diff --git a/src/Delete/DeleteQueryBuilder.php b/src/Delete/DeleteQueryBuilder.php
index 3f5d487..f55c08a 100644
--- a/src/Delete/DeleteQueryBuilder.php
+++ b/src/Delete/DeleteQueryBuilder.php
@@ -3,7 +3,6 @@
namespace calderawp\CalderaFormsQuery\Delete;
-
use calderawp\CalderaFormsQuery\QueryBuilder;
use NilPortugues\Sql\QueryBuilder\Manipulation\Delete;
@@ -20,7 +19,7 @@ abstract class DeleteQueryBuilder extends QueryBuilder implements DoesDeleteQuer
*/
public function getDeleteQuery()
{
- if( ! $this->deleteQuery ){
+ if (! $this->deleteQuery) {
$this->deleteQuery = new Delete($this->getTableName());
}
@@ -34,4 +33,4 @@ abstract class DeleteQueryBuilder extends QueryBuilder implements DoesDeleteQuer
{
return $this->getDeleteQuery();
}
-}
\ No newline at end of file
+}
diff --git a/src/Delete/DoesDeleteQuery.php b/src/Delete/DoesDeleteQuery.php
index f01a333..a8b1571 100644
--- a/src/Delete/DoesDeleteQuery.php
+++ b/src/Delete/DoesDeleteQuery.php
@@ -3,7 +3,6 @@
namespace calderawp\CalderaFormsQuery\Delete;
-
use NilPortugues\Sql\QueryBuilder\Manipulation\Delete;
/**
@@ -20,5 +19,4 @@ interface DoesDeleteQuery
* @return Delete
*/
public function getCurrentQuery();
-
-}
\ No newline at end of file
+}
diff --git a/src/Delete/Entry.php b/src/Delete/Entry.php
index 1d550bf..edbf882 100644
--- a/src/Delete/Entry.php
+++ b/src/Delete/Entry.php
@@ -3,7 +3,6 @@
namespace calderawp\CalderaFormsQuery\Delete;
-
class Entry extends DeleteQueryBuilder
{
@@ -39,4 +38,4 @@ class Entry extends DeleteQueryBuilder
{
return $this->is('user_id', $userId);
}
-}
\ No newline at end of file
+}
diff --git a/src/Delete/EntryValues.php b/src/Delete/EntryValues.php
index 5207537..4995cb7 100644
--- a/src/Delete/EntryValues.php
+++ b/src/Delete/EntryValues.php
@@ -3,7 +3,6 @@
namespace calderawp\CalderaFormsQuery\Delete;
-
class EntryValues extends DeleteQueryBuilder
{
@@ -18,7 +17,7 @@ class EntryValues extends DeleteQueryBuilder
$this
->getDeleteQuery()
->where()
- ->equals( 'entry_id', (int)$entryId )
+ ->equals('entry_id', (int)$entryId)
;
return $this;
}
@@ -35,15 +34,14 @@ class EntryValues extends DeleteQueryBuilder
$this
->getDeleteQuery()
->where()
- ->equals( 'value', $fieldValue )
+ ->equals('value', $fieldValue)
;
$this
->getDeleteQuery()
->where()
- ->equals( 'slug', $fieldSlug );
+ ->equals('slug', $fieldSlug);
return $this;
}
-
-}
\ No newline at end of file
+}
diff --git a/src/EntryQueries.php b/src/EntryQueries.php
index 8bf04f7..c54876e 100644
--- a/src/EntryQueries.php
+++ b/src/EntryQueries.php
@@ -6,6 +6,11 @@ namespace calderawp\CalderaFormsQuery;
use calderawp\CalderaFormsQuery\Select\Entry;
use calderawp\CalderaFormsQuery\Select\EntryValues;
+/**
+ * Class EntryQueries
+ *
+ * Used to query entry data, using SQL created by genrators
+ */
class EntryQueries implements QueriesEntries
{
/**
diff --git a/src/Escape.php b/src/Escape.php
index f09d066..5191caa 100644
--- a/src/Escape.php
+++ b/src/Escape.php
@@ -33,8 +33,8 @@ class Escape
* @return string Text in the form of a LIKE phrase. The output is not SQL safe. Call $wpdb::prepare()
* or real_escape next.
*/
- public static function like( $text ) {
- return addcslashes( $text, '_%\\' );
+ public static function like($text)
+ {
+ return addcslashes($text, '_%\\');
}
-
-}
\ No newline at end of file
+}
diff --git a/src/QueriesEntries.php b/src/QueriesEntries.php
index 4b173f6..d7f5c4e 100644
--- a/src/QueriesEntries.php
+++ b/src/QueriesEntries.php
@@ -6,6 +6,11 @@ namespace calderawp\CalderaFormsQuery;
use calderawp\CalderaFormsQuery\Select\Entry;
use calderawp\CalderaFormsQuery\Select\EntryValues;
+/**
+ * Interface QueriesEntries
+ *
+ * Interface that all classes that query for entries MUST impliment
+ */
interface QueriesEntries
{
/**
diff --git a/src/QueryBuilder.php b/src/QueryBuilder.php
index f4075a3..67ef15c 100644
--- a/src/QueryBuilder.php
+++ b/src/QueryBuilder.php
@@ -3,11 +3,16 @@
namespace calderawp\CalderaFormsQuery;
-
use calderawp\CalderaFormsQuery\Select\DoesSelectQuery;
use NilPortugues\Sql\QueryBuilder\Manipulation\AbstractBaseQuery;
-abstract class QueryBuilder implements DoesQueries
+/**
+ * Class QueryBuilder
+ *
+ *
+ * Used to create SQL queries, NOT run SQL queries
+ */
+abstract class QueryBuilder implements CreatesSqlQueries
{
const ASC = 'ASC';
const DESC = 'DESC';
@@ -64,7 +69,7 @@ abstract class QueryBuilder implements DoesQueries
* @param string $value
* @return $this
*/
- protected function addWhereEquals( AbstractBaseQuery $queryBuilder, $column, $value )
+ protected function addWhereEquals(AbstractBaseQuery $queryBuilder, $column, $value)
{
$queryBuilder
->where()
@@ -101,7 +106,8 @@ abstract class QueryBuilder implements DoesQueries
*/
protected function getSecondDeliminator()
{
- return $this->isLike ? "%'" : "'"; }
+ return $this->isLike ? "%'" : "'";
+ }
/**
* Surround one value with quotes or %
@@ -112,10 +118,10 @@ abstract class QueryBuilder implements DoesQueries
protected function surroundValue($value)
{
$value = "{$this->getFirstDeliminator()}$value{$this->getSecondDeliminator()}";
- if( ! $this->isLike){
+ if (! $this->isLike) {
return $value;
}
- return Escape::like( $value );
+ return Escape::like($value);
}
@@ -128,7 +134,7 @@ abstract class QueryBuilder implements DoesQueries
*/
protected function is($column, $value)
{
- return $this->addWhereEquals($this->getCurrentQuery(),$column, $value);
+ return $this->addWhereEquals($this->getCurrentQuery(), $column, $value);
}
/** @inheritdoc */
@@ -136,4 +142,4 @@ abstract class QueryBuilder implements DoesQueries
{
return $this->substituteValues($this->getBuilder()->write($this->getCurrentQuery()));
}
-}
\ No newline at end of file
+}
diff --git a/src/Select/EntryValues.php b/src/Select/EntryValues.php
index d46d3ce..a2f1860 100644
--- a/src/Select/EntryValues.php
+++ b/src/Select/EntryValues.php
@@ -29,7 +29,7 @@ class EntryValues extends SelectQueryBuilder
* @param string $fieldSlug Field slug
* @param string $fieldValue Field value
* @param string $type Optional. Type of comparison. Values: equals|notEquals|like Default: 'equals'
- * @param string $whereOperator Optional. Type of where. Default is 'AND'. Any valid MySQL where operator is accepted
+ * @param string $whereOperator Optional. Type of where. Default is 'AND'. Any valid WHERE operator is accepted
* @return $this
*/
public function queryByFieldValue($fieldSlug, $fieldValue, $type = 'equals', $whereOperator = 'AND')
diff --git a/src/Select/SelectQueryBuilder.php b/src/Select/SelectQueryBuilder.php
index c21ab94..16f8fbf 100644
--- a/src/Select/SelectQueryBuilder.php
+++ b/src/Select/SelectQueryBuilder.php
@@ -3,14 +3,14 @@
namespace calderawp\CalderaFormsQuery\Select;
-use calderawp\CalderaFormsQuery\DoesQueries;
+use calderawp\CalderaFormsQuery\CreatesSqlQueries;
use calderawp\CalderaFormsQuery\MySqlBuilder;
use calderawp\CalderaFormsQuery\QueryBuilder;
use NilPortugues\Sql\QueryBuilder\Manipulation\AbstractBaseQuery;
use NilPortugues\Sql\QueryBuilder\Manipulation\Delete;
use NilPortugues\Sql\QueryBuilder\Manipulation\Select;
-abstract class SelectQueryBuilder extends QueryBuilder implements DoesSelectQuery
+abstract class SelectQueryBuilder extends QueryBuilder implements DoesSelectQuery
{
/**
@@ -47,8 +47,4 @@ abstract class SelectQueryBuilder extends QueryBuilder implements DoesSelectQue
$this->getCurrentQuery()->orderBy($column, $order);
return $this;
}
-
-
-
-
}
--
GitLab