Clean up code

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
+}

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';
 		}
 

Tests/Traits/UsersMockFormAsDBForm.php

@@ -23,6 +23,4 @@ trait UsersMockFormAsDBForm
 		$this->mock_form = \Caldera_Forms_Forms::get_form($this->mock_form_id);
 		parent::setUp();
 	}
-
-
 }

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
+}

src/DoesQueries.php → 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
 {
 
 	/**

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
+}

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
+}

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
+}

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
+}

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
 {
 	/**

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
+}

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
 {
 	/**

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
+}

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')

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;
 	}
-
-
-
-
 }