WordPoints / hooks-api

src/includes/classes/hierarchy.php

Doc Comments +44 added lines

@@ -9,17 +9,49 @@ 
 
 interface WordPoints_HierarchyI {
 	public function get();
+
+	/**
+	 * @return void
+	 */
 	public function push( $field, $data );
+
+	/**
+	 * @return void
+	 */
 	public function pop();
 	public function set_field( $field, $value );
+
+	/**
+	 * @param string $field
+	 * @param string $sub
+	 * @param string $sub_2
+	 */
 	public function get_field( $field, $sub = null, $sub_2 = null );
 	public function get_id();
 	public function go_to( $id );
+
+	/**
+	 * @param string $field
+	 *
+	 * @return void
+	 */
 	public function push_to( $field, $value );
+
+	/**
+	 * @return boolean
+	 */
 	public function ascend();
+
+	/**
+	 * @return boolean
+	 */
 	public function descend( $to = null );
 	public function is_main();
 	public function next();
+
+	/**
+	 * @return void
+	 */
 	public function reset();
 }
 
@@ -134,6 +166,9 @@ 
 	protected $current = 0;
 	protected $i = 0;
 
+	/**
+	 * @param string $descendant_index
+	 */
 	public function __construct( $descendant_index ) {
 		$this->descendant_index = $descendant_index;
 	}
@@ -196,10 +231,16 @@ 
 		$this->current = 0;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function set_field( $field, $value ) {
 		$this->hierarchy[ $this->current ][ $field ] = $value;
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function get_field( $field, $sub = null, $sub_2 = null ) {
 
 		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {
@@ -225,6 +266,9 @@ 
 		return $this->hierarchy[ $this->current ][ $field ];
 	}
 
+	/**
+	 * @param string $field
+	 */
 	public function push_to( $field, $value ) {
 
 		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {

Spacing +91 added lines, -91 removed lines

@@ -9,15 +9,15 @@ 
 
 interface WordPoints_HierarchyI {
 	public function get();
-	public function push( $field, $data );
+	public function push($field, $data);
 	public function pop();
-	public function set_field( $field, $value );
-	public function get_field( $field, $sub = null, $sub_2 = null );
+	public function set_field($field, $value);
+	public function get_field($field, $sub = null, $sub_2 = null);
 	public function get_id();
-	public function go_to( $id );
-	public function push_to( $field, $value );
+	public function go_to($id);
+	public function push_to($field, $value);
 	public function ascend();
-	public function descend( $to = null );
+	public function descend($to = null);
 	public function is_main();
 	public function next();
 	public function reset();
@@ -31,20 +31,20 @@ 
 	protected $descendant_index;
 
 	public function __construct() {
-		$this->current =& $this->hierarchy;
+		$this->current = & $this->hierarchy;
 	}
 
 	public function get() {
 		return $this->hierarchy;
 	}
 
-	public function push( $field, $data ) {
+	public function push($field, $data) {
 
-		if ( ! isset( $this->current['slug'] ) || $this->current['slug'] !== $field ) {
+		if ( ! isset($this->current['slug']) || $this->current['slug'] !== $field) {
 
-			if ( ! empty( $this->hierarchy ) ) {
-				$this->current[ $this->descendant_index ][ $field ] = $data;
-				$this->current =& $this->current[ $this->descendant_index ][ $field ];
+			if ( ! empty($this->hierarchy)) {
+				$this->current[$this->descendant_index][$field] = $data;
+				$this->current = & $this->current[$this->descendant_index][$field];
 			} else {
 				$this->current = $this->stack[0] = $data;
 			}
@@ -57,14 +57,14 @@ 
 
 	public function pop() {
 
-		unset( $this->current );
+		unset($this->current);
 
-		$this->current = array_pop( $this->stack );
+		$this->current = array_pop($this->stack);
 	}
 
 	public function reset() {
 		//	unset( $this->current_arg );
-		$this->current =& $this->hierarchy;
+		$this->current = & $this->hierarchy;
 		$this->stack = array();
 	}
 
@@ -80,30 +80,30 @@ 
 //		return $this->current[ $field ];
 //	}
 
-	public function push_to( $field, $value ) {
+	public function push_to($field, $value) {
 
-		if ( ! isset( $this->current[ $field ] ) ) {
+		if ( ! isset($this->current[$field])) {
 
 		}
 		//var_dump( $field, $value,$this->current[ $field ] );
-		$this->current[ $field ][] = $value;
+		$this->current[$field][] = $value;
 	}
 
-	public function set_sub_field( $slug, $field, $value ) {
-		$this->current[ $this->descendant_index ][ $slug ][ $field ] = $value;
+	public function set_sub_field($slug, $field, $value) {
+		$this->current[$this->descendant_index][$slug][$field] = $value;
 	}
 
-	public function get_sub_field( $slug, $field ) {
-		return $this->current[ $this->descendant_index ][ $slug ][ $field ];
+	public function get_sub_field($slug, $field) {
+		return $this->current[$this->descendant_index][$slug][$field];
 	}
 
-	public function get_sub_data( $slug ) {
-		return $this->current[ $this->descendant_index ][ $slug ];
+	public function get_sub_data($slug) {
+		return $this->current[$this->descendant_index][$slug];
 	}
 
 	public function ascend() {
 
-		if ( ! $this->stack ) {
+		if ( ! $this->stack) {
 			return false;
 		}
 
@@ -112,15 +112,15 @@ 
 		return true;
 	}
 
-	public function descend( $to = null ) {
+	public function descend($to = null) {
 
-		if ( ! isset( $this->hierarchy[ $this->descendant_index ] ) ) {
+		if ( ! isset($this->hierarchy[$this->descendant_index])) {
 			return false;
 		}
 
-		reset( $this->current[ $this->descendant_index ] );
-		$field = key( $this->current[ $this->descendant_index ] );
-		$this->current =& $this->current[ $this->descendant_index ][ $field ];
+		reset($this->current[$this->descendant_index]);
+		$field = key($this->current[$this->descendant_index]);
+		$this->current = & $this->current[$this->descendant_index][$field];
 
 		$this->stack[] = $this->current;
 
@@ -134,52 +134,52 @@ 
 	protected $current = 0;
 	protected $i = 0;
 
-	public function __construct( $descendant_index ) {
+	public function __construct($descendant_index) {
 		$this->descendant_index = $descendant_index;
 	}
 
 	public function get() {
 	//	var_dump( $this->hierarchy );
 
-		if ( empty( $this->hierarchy ) ) {
+		if (empty($this->hierarchy)) {
 			return array();
 		}
 
-		return $this->build_hierarchy( $this->hierarchy[0] );
+		return $this->build_hierarchy($this->hierarchy[0]);
 	}
 
-	protected function build_hierarchy( $arg ) {
+	protected function build_hierarchy($arg) {
 
-		if ( isset( $arg[ $this->descendant_index ] ) ) {
+		if (isset($arg[$this->descendant_index])) {
 
-			foreach ( $arg[ $this->descendant_index ] as $sub_arg => $i ) {
-				$arg[ $this->descendant_index ][ $sub_arg ] = $this->build_hierarchy( $this->hierarchy[ $i ] );
+			foreach ($arg[$this->descendant_index] as $sub_arg => $i) {
+				$arg[$this->descendant_index][$sub_arg] = $this->build_hierarchy($this->hierarchy[$i]);
 			}
 		}
 
-		if ( isset( $arg['_parent'] ) ) {
-			unset( $arg['_parent'] );
+		if (isset($arg['_parent'])) {
+			unset($arg['_parent']);
 		}
 
-		unset( $arg['_i'] );
+		unset($arg['_i']);
 
 		return $arg;
 	}
 
-	public function push( $field, $data ) {
+	public function push($field, $data) {
 
-		if ( ! isset( $this->hierarchy[ $this->current ]['slug'] ) || $this->hierarchy[ $this->current ]['slug'] !== $field ) {
+		if ( ! isset($this->hierarchy[$this->current]['slug']) || $this->hierarchy[$this->current]['slug'] !== $field) {
 
 			$i = $this->i++;
 
-			if ( ! empty( $this->hierarchy ) ) {
-				$this->hierarchy[ $this->current ][ $this->descendant_index ][ $field ] = $i;
+			if ( ! empty($this->hierarchy)) {
+				$this->hierarchy[$this->current][$this->descendant_index][$field] = $i;
 				$data['_parent'] = $this->current;
 			}
 
-			$this->hierarchy[ $i ] = $data;
-			$this->hierarchy[ $i ]['slug'] = $field;
-			$this->hierarchy[ $i ]['_i'] = $i;
+			$this->hierarchy[$i] = $data;
+			$this->hierarchy[$i]['slug'] = $field;
+			$this->hierarchy[$i]['_i'] = $i;
 
 			$this->current = $i;
 		}
@@ -187,8 +187,8 @@ 
 
 	public function pop() {
 
-		$this->current = isset( $this->hierarchy[ $this->current ]['_parent'] )
-			?  $this->hierarchy[ $this->current ]['_parent']
+		$this->current = isset($this->hierarchy[$this->current]['_parent'])
+			? $this->hierarchy[$this->current]['_parent']
 			: 0;
 	}
 
@@ -196,95 +196,95 @@ 
 		$this->current = 0;
 	}
 
-	public function set_field( $field, $value ) {
-		$this->hierarchy[ $this->current ][ $field ] = $value;
+	public function set_field($field, $value) {
+		$this->hierarchy[$this->current][$field] = $value;
 	}
 
-	public function get_field( $field, $sub = null, $sub_2 = null ) {
+	public function get_field($field, $sub = null, $sub_2 = null) {
 
-		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {
+		if ( ! isset($this->hierarchy[$this->current][$field])) {
 			return null;
 		}
 
-		if ( isset( $sub ) ) {
-			if ( ! isset( $this->hierarchy[ $this->current ][ $field ][ $sub ] ) ) {
+		if (isset($sub)) {
+			if ( ! isset($this->hierarchy[$this->current][$field][$sub])) {
 				return null;
 			}
 
-			if ( isset( $sub_2 ) ) {
-				if ( ! isset( $this->hierarchy[ $this->current ][ $field ][ $sub ][ $sub_2 ] ) ) {
+			if (isset($sub_2)) {
+				if ( ! isset($this->hierarchy[$this->current][$field][$sub][$sub_2])) {
 					return null;
 				} else {
-					return $this->hierarchy[ $this->current ][ $field ][ $sub ][ $sub_2 ];
+					return $this->hierarchy[$this->current][$field][$sub][$sub_2];
 				}
 			}
 
-			return $this->hierarchy[ $this->current ][ $field ][ $sub ];
+			return $this->hierarchy[$this->current][$field][$sub];
 		}
 
-		return $this->hierarchy[ $this->current ][ $field ];
+		return $this->hierarchy[$this->current][$field];
 	}
 
-	public function push_to( $field, $value ) {
+	public function push_to($field, $value) {
 
-		if ( ! isset( $this->hierarchy[ $this->current ][ $field ] ) ) {
+		if ( ! isset($this->hierarchy[$this->current][$field])) {
 
 		}
 		//var_dump( $field, $value,$this->current[ $field ] );
-		$this->hierarchy[ $this->current ][ $field ][] = $value;
+		$this->hierarchy[$this->current][$field][] = $value;
 	}
 
-	public function set_sub_field( $slug, $field, $value ) {
-		$this->hierarchy[ $this->current ][ $this->descendant_index ][ $slug ][ $field ] = $value;
+	public function set_sub_field($slug, $field, $value) {
+		$this->hierarchy[$this->current][$this->descendant_index][$slug][$field] = $value;
 	}
 
-	public function get_sub_field( $slug, $field ) {
+	public function get_sub_field($slug, $field) {
 
-		return $this->hierarchy[ $this->current ][ $this->descendant_index ][ $slug ][ $field ];
+		return $this->hierarchy[$this->current][$this->descendant_index][$slug][$field];
 	}
 
-	public function get_sub_data( $slug ) {
-		return $this->hierarchy[ $this->current ][ $this->descendant_index ][ $slug ];
+	public function get_sub_data($slug) {
+		return $this->hierarchy[$this->current][$this->descendant_index][$slug];
 	}
 
-	public function has_child( $slug ) {
-		return isset( $this->hierarchy[ $this->current ][ $this->descendant_index ][ $slug ] );
+	public function has_child($slug) {
+		return isset($this->hierarchy[$this->current][$this->descendant_index][$slug]);
 	}
 
 	public function get_children() {
-		return isset( $this->hierarchy[ $this->current ][ $this->descendant_index ][ $slug ] );
+		return isset($this->hierarchy[$this->current][$this->descendant_index][$slug]);
 
 	}
 
 	public function ascend() {
 
-		if ( ! isset( $this->hierarchy[ $this->current ]['_parent'] ) ) {
+		if ( ! isset($this->hierarchy[$this->current]['_parent'])) {
 			return false;
 		}
 
-		$this->current = $this->hierarchy[ $this->current ]['_parent'];
+		$this->current = $this->hierarchy[$this->current]['_parent'];
 
 		return true;
 	}
 
-	public function descend( $to = null ) {
+	public function descend($to = null) {
 
-		if ( ! isset( $this->hierarchy[ $this->current ][ $this->descendant_index ] ) ) {
+		if ( ! isset($this->hierarchy[$this->current][$this->descendant_index])) {
 			return false;
 		}
 
-		if ( isset( $to ) ) {
+		if (isset($to)) {
 
-			if ( ! isset( $this->hierarchy[ $this->current ][ $this->descendant_index ][ $to ] ) ) {
+			if ( ! isset($this->hierarchy[$this->current][$this->descendant_index][$to])) {
 				return false;
 			}
 
-			$this->current = $this->hierarchy[ $this->current ][ $this->descendant_index ][ $to ];
+			$this->current = $this->hierarchy[$this->current][$this->descendant_index][$to];
 
 		} else {
 
 			$this->current = reset(
-				$this->hierarchy[ $this->current ][ $this->descendant_index ]
+				$this->hierarchy[$this->current][$this->descendant_index]
 			);
 		}
 
@@ -293,29 +293,29 @@ 
 
 	public function next() {
 
-		if ( ! isset( $this->hierarchy[ $this->current ]['_parent'] ) ) {
+		if ( ! isset($this->hierarchy[$this->current]['_parent'])) {
 			return false;
 		}
 
-		$parent = $this->hierarchy[ $this->current ]['_parent'];
+		$parent = $this->hierarchy[$this->current]['_parent'];
 
-		if ( ! isset( $this->hierarchy[ $parent ][ $this->descendant_index ] ) ) {
+		if ( ! isset($this->hierarchy[$parent][$this->descendant_index])) {
 			return false;
 		}
 
-		$sub_args = $this->hierarchy[ $parent ][ $this->descendant_index ];
+		$sub_args = $this->hierarchy[$parent][$this->descendant_index];
 
-		reset( $sub_args );
+		reset($sub_args);
 
-		while ( current( $sub_args ) !== $this->current ) {
-			next( $sub_args );
+		while (current($sub_args) !== $this->current) {
+			next($sub_args);
 		}
 
-		if ( ! next( $sub_args ) ) {
+		if ( ! next($sub_args)) {
 			return false;
 		}
 
-		$this->current = current( $sub_args );
+		$this->current = current($sub_args);
 
 		return true;
 	}
@@ -324,9 +324,9 @@ 
 		return $this->current;
 	}
 
-	public function go_to( $id ) {
+	public function go_to($id) {
 
-		if ( false === wordpoints_posint( $id ) || $id < 0 ) {
+		if (false === wordpoints_posint($id) || $id < 0) {
 			return;
 		}
 

src/includes/classes/hook/retroactive/query.php

Doc Comments +4 added lines

@@ -73,6 +73,10 @@
 
 
 interface WordPoints_Hook_Reactor_RetroactiveI extends WordPoints_Hook_Retroactive_Query_ModifierI {
+
+	/**
+	 * @return void
+	 */
 	public function retroactive_hit( $target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction );
 }
 

Spacing +155 added lines, -155 removed lines

@@ -73,14 +73,14 @@ 
 
 
 interface WordPoints_Hook_Reactor_RetroactiveI extends WordPoints_Hook_Retroactive_Query_ModifierI {
-	public function retroactive_hit( $target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction );
+	public function retroactive_hit($target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction);
 }
 
 abstract class WordPoints_Hook_Reactor_Retroactive implements WordPoints_Hook_Reactor_RetroactiveI {
 
-	public function modify_retroactive_query( WordPoints_Hook_Retroactive_QueryI $query ) {
+	public function modify_retroactive_query(WordPoints_Hook_Retroactive_QueryI $query) {
 
-		$query->set_target( $query->get_reaction()->get_meta( 'target' ) );
+		$query->set_target($query->get_reaction()->get_meta('target'));
 	}
 
 	public function reverse_hits() {
@@ -97,17 +97,17 @@ 
 	/**
 	 * @since 1.0.0
 	 */
-	public function retroactive_hit( $target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction ) {
+	public function retroactive_hit($target, array $records, WordPoints_Hook_Event_RetroactiveI $event, WordPoints_Hook_ReactionI $reaction) {
 
-		$count = count( $records );
+		$count = count($records);
 
 		wordpoints_alter_points(
 			$target
-			, $reaction->get_meta( 'points' ) * $count
-			, $reaction->get_meta( 'points_type' )
-			, 'retroactive_' . $reaction->get_event_slug()
-			, array( 'count' => $count )
-			, $event->get_retroactive_description( $reaction )
+			, $reaction->get_meta('points') * $count
+			, $reaction->get_meta('points_type')
+			, 'retroactive_'.$reaction->get_event_slug()
+			, array('count' => $count)
+			, $event->get_retroactive_description($reaction)
 		);
 	}
 
@@ -139,22 +139,22 @@ 
 
 		$logs = $query->get();
 
-		if ( ! $logs ) {
+		if ( ! $logs) {
 			return;
 		}
 
-		foreach ( $logs as $log ) {
+		foreach ($logs as $log) {
 
 			wordpoints_alter_points(
 				$log->user_id
-				, - ( $log->points / wordpoints_get_points_log_meta( $log->id, 'count', true ) )
+				, -($log->points / wordpoints_get_points_log_meta($log->id, 'count', true))
 				, $log->points_type
 				, "reverse_{$event}"
-				, array( 'original_log_id' => $log->id )
+				, array('original_log_id' => $log->id)
 				, $args->get_description()
 			);
 
-			wordpoints_add_points_log_meta( $log->id, 'auto_reversed', $args->get_entity_id() );
+			wordpoints_add_points_log_meta($log->id, 'auto_reversed', $args->get_entity_id());
 		}
 	}
 }
@@ -196,13 +196,13 @@ 
 
 	protected $results;
 
-	public function __construct( WordPoints_Hook_ReactionI $reaction ) {
+	public function __construct(WordPoints_Hook_ReactionI $reaction) {
 
 		$this->reaction = $reaction;
-		$this->arg_hierarchy = new WordPoints_Hierarchy( 'sub_args' );
+		$this->arg_hierarchy = new WordPoints_Hierarchy('sub_args');
 		$this->hooks = wordpoints_hooks();
 		$this->entities = wordpoints_entities();
-		$this->validator = new WordPoints_Hook_Reaction_Validator( $reaction, true );
+		$this->validator = new WordPoints_Hook_Reaction_Validator($reaction, true);
 	}
 
 	public function get_reaction() {
@@ -215,11 +215,11 @@ 
 
 	public function get_results() {
 
-		if ( ! isset( $this->results ) ) {
+		if ( ! isset($this->results)) {
 
 			$this->execute();
 
-			if ( $this->validator->had_errors() ) {
+			if ($this->validator->had_errors()) {
 				$this->results = $this->validator;
 			}
 		}
@@ -236,8 +236,8 @@ 
 			$this->filter_results();
 			$this->group_results();
 
-		} catch ( WordPoints_Hook_Validator_Exception $e ) {
-			unset( $e );
+		} catch (WordPoints_Hook_Validator_Exception $e) {
+			unset($e);
 		}
 	}
 
@@ -245,33 +245,33 @@ 
 
 		$event_slug = $this->reaction->get_event_slug();
 
-		$events = $this->hooks->get_sub_app( 'events' );
-		$event  = $events->get( $event_slug );
+		$events = $this->hooks->get_sub_app('events');
+		$event  = $events->get($event_slug);
 
-		if ( ! ( $event instanceof WordPoints_Hook_Event_RetroactiveI ) ) {
-			$this->validator->add_error( 'invalid hook' );
+		if ( ! ($event instanceof WordPoints_Hook_Event_RetroactiveI)) {
+			$this->validator->add_error('invalid hook');
 		}
 
-		foreach ( $events->get_sub_app( 'args' )->get_children( $event_slug ) as $arg ) {
+		foreach ($events->get_sub_app('args')->get_children($event_slug) as $arg) {
 			$this->arg_hierarchy_push( // TODO
 				$arg
 			);
 		}
 
-		if ( $event instanceof WordPoints_Hook_Retroactive_Query_ModifierI ) {
-			$event->modify_retroactive_query( $this );
+		if ($event instanceof WordPoints_Hook_Retroactive_Query_ModifierI) {
+			$event->modify_retroactive_query($this);
 			$this->reset();
 		}
 
-		$reactor = $this->hooks->get_sub_app( 'reactors' )->get( $this->reaction->get_reactor_slug() );
+		$reactor = $this->hooks->get_sub_app('reactors')->get($this->reaction->get_reactor_slug());
 
-		$reactor->modify_retroactive_query( $this );
+		$reactor->modify_retroactive_query($this);
 		$this->reset();
 
-		foreach ( $this->hooks->get_sub_app( 'extensions' )->get_all() as $extension ) {
+		foreach ($this->hooks->get_sub_app('extensions')->get_all() as $extension) {
 
-			if ( $extension instanceof WordPoints_Hook_Retroactive_Query_ModifierI ) {
-				$extension->modify_retroactive_query( $this );
+			if ($extension instanceof WordPoints_Hook_Retroactive_Query_ModifierI) {
+				$extension->modify_retroactive_query($this);
 				$this->reset();
 			}
 		}
@@ -279,126 +279,126 @@ 
 
 	protected function perform_query() {
 
-		$this->queries = new WordPoints_Hierarchy( 'sub_queries' );
-		$this->consolidate_queries( array( $this->arg_hierarchy->get() ) );
-		unset( $this->query );
+		$this->queries = new WordPoints_Hierarchy('sub_queries');
+		$this->consolidate_queries(array($this->arg_hierarchy->get()));
+		unset($this->query);
 
 		$this->queries->reset();
 
 		// Find the tip of a query.
-		$this->results = $this->execute_queries( $this->queries->get() );
+		$this->results = $this->execute_queries($this->queries->get());
 
-		if ( is_wp_error( $this->results ) ) {
-			$this->validator->add_error( $this->results );
+		if (is_wp_error($this->results)) {
+			$this->validator->add_error($this->results);
 		}
 	}
 
-	protected function consolidate_queries( $arg_hierarchy, $storage_type = null ) {
+	protected function consolidate_queries($arg_hierarchy, $storage_type = null) {
 
-		foreach ( $arg_hierarchy as $data ) {
-			$this->consolidate_query( $data );
+		foreach ($arg_hierarchy as $data) {
+			$this->consolidate_query($data);
 		}
 	}
 
-	protected function consolidate_query( $data ) {
+	protected function consolidate_query($data) {
 
-		if ( $data['storage_info']['type'] !== $this->queries->get_field( 'slug' ) ) {
+		if ($data['storage_info']['type'] !== $this->queries->get_field('slug')) {
 
 			$parent_id = null;
-			if ( isset( $this->query ) ) {
+			if (isset($this->query)) {
 				$parent_id = $this->query->get_id();
 			}
 
-			$this->query = new WordPoints_Hierarchy( 'sub_args' );
+			$this->query = new WordPoints_Hierarchy('sub_args');
 
 			$this->queries->push(
 				$data['storage_info']['type']
-				, array( 'query' => $this->query, 'parent_id' => $parent_id )
+				, array('query' => $this->query, 'parent_id' => $parent_id)
 			);
 
 			$pushed_query = true;
 		}
 
-		if ( isset( $data['sub_args'] ) ) {
+		if (isset($data['sub_args'])) {
 			$sub_args = $data['sub_args'];
-			unset( $data['sub_args'] );
+			unset($data['sub_args']);
 		}
 
-		$this->query->push( $data['slug'], $data );
+		$this->query->push($data['slug'], $data);
 
-		if ( isset( $sub_args ) ) {
-			$this->consolidate_queries( $sub_args, $data['storage_info']['type'] );
+		if (isset($sub_args)) {
+			$this->consolidate_queries($sub_args, $data['storage_info']['type']);
 		}
 
 		$this->query->pop();
 
-		if ( ! empty( $pushed_query ) ) {
+		if ( ! empty($pushed_query)) {
 			$this->queries->pop();
-			$this->query = $this->queries->get_field( 'query' );
+			$this->query = $this->queries->get_field('query');
 		}
 	}
 
-	protected function execute_queries( $queries ) {
+	protected function execute_queries($queries) {
 
 		/** @var WordPoints_HierarchyI $query */
 		$query = $queries['query'];
 
-		if ( isset( $queries['sub_queries'] ) ) {
-			foreach ( $queries['sub_queries'] as $query_data ) {
+		if (isset($queries['sub_queries'])) {
+			foreach ($queries['sub_queries'] as $query_data) {
 
-				$results = $this->execute_queries( $query_data );
+				$results = $this->execute_queries($query_data);
 
-				if ( is_wp_error( $results ) ) {
+				if (is_wp_error($results)) {
 					return $results;
 				}
 
-				if ( empty( $results ) ) {
+				if (empty($results)) {
 					return array();
 				}
 
 				/** @var WordPoints_HierarchyI $child_query */
 				$child_query = $query_data['query'];
-				$query->go_to( $query_data['parent_id'] );
+				$query->go_to($query_data['parent_id']);
 
 				$condition = array(
 //					'field' => $child_query->get_field( 'slug' ),
 					'compare' => 'in',
 					'value' => wp_list_pluck(
 						$results
-						, $child_query->get_field( 'storage_info', 'meta', 'id_field' )
+						, $child_query->get_field('storage_info', 'meta', 'id_field')
 					),
 				);
 
-				$query->push_to( 'conditions', $condition );
+				$query->push_to('conditions', $condition);
 			}
 		}
 
 		$query->reset();
-		$storage_type = $query->get_field( 'storage_info', 'type' );
+		$storage_type = $query->get_field('storage_info', 'type');
 
 		// it is pretty stupid to wait until now to figure this out.
-		$executor = $this->hooks->get_sub_app( 'retroactive_query_executors' )->get( $storage_type );
+		$executor = $this->hooks->get_sub_app('retroactive_query_executors')->get($storage_type);
 
-		if ( ! $executor ) {
+		if ( ! $executor) {
 			$this->validator->add_error(
-				sprintf( 'unknown storage type "%s".', $storage_type )
+				sprintf('unknown storage type "%s".', $storage_type)
 			);
 		}
 
-		return $executor->execute( array( $query->get() ) );
+		return $executor->execute(array($query->get()));
 	}
 
 	protected function filter_results() {
 
-		$reactor = $this->hooks->get_sub_app( 'reactors' )->get( $this->reaction->get_reactor_slug() );
+		$reactor = $this->hooks->get_sub_app('reactors')->get($this->reaction->get_reactor_slug());
 
-		if ( $reactor instanceof WordPoints_Hook_Retroactive_Query_FilterI ) {
-			$reactor->filter_retroactive_query( $this );
+		if ($reactor instanceof WordPoints_Hook_Retroactive_Query_FilterI) {
+			$reactor->filter_retroactive_query($this);
 		}
 
-		foreach ( $this->hooks->get_sub_app( 'extensions' )->get_all() as $extension ) {
-			if ( $extension instanceof WordPoints_Hook_Retroactive_Query_FilterI ) {
-				$extension->filter_retroactive_query( $this );
+		foreach ($this->hooks->get_sub_app('extensions')->get_all() as $extension) {
+			if ($extension instanceof WordPoints_Hook_Retroactive_Query_FilterI) {
+				$extension->filter_retroactive_query($this);
 			}
 		}
 	}
@@ -407,27 +407,27 @@ 
 
 		$grouped_results = array();
 
-		foreach ( $this->results as $result ) {
-			$grouped_results[ $result->target ][] = $result;
+		foreach ($this->results as $result) {
+			$grouped_results[$result->target][] = $result;
 		}
 
 		$this->results = $grouped_results;
 	}
 
-	public function add_condition( array $condition ) {
+	public function add_condition(array $condition) {
 
-		$this->arg_hierarchy->push_to( 'conditions', $condition );
+		$this->arg_hierarchy->push_to('conditions', $condition);
 	}
 
-	public function select_value( $data = array() ) {
+	public function select_value($data = array()) {
 
-		$this->arg_hierarchy->set_field( 'select', $data );
+		$this->arg_hierarchy->set_field('select', $data);
 	}
 
-	public function set_target( $target_arg ) {
+	public function set_target($target_arg) {
 
-		foreach ( $target_arg as $arg_slug ) {
-			$this->arg_hierarchy_push( $arg_slug );
+		foreach ($target_arg as $arg_slug) {
+			$this->arg_hierarchy_push($arg_slug);
 		}
 
 //		$id = $this->arg_hierarchy->get_id();
@@ -437,10 +437,10 @@ 
 //			$field = $this->arg_hierarchy->get_field( 'storage_info', 'meta', 'field' );
 //			$this->arg_hierarchy->ascend();
 //		} else {
-			$field = $this->arg_hierarchy->get_field( 'storage_info', 'meta', 'id_field' );
+			$field = $this->arg_hierarchy->get_field('storage_info', 'meta', 'id_field');
 //		}
 
-		$this->select_value( array( 'field' => $field, 'as' => 'target' ) );
+		$this->select_value(array('field' => $field, 'as' => 'target'));
 
 //		$this->arg_hierarchy->go_to( $id );
 	}
@@ -452,40 +452,40 @@ 
 	 * @return WordPoints_EntityishI
 	 */
 	public function get_arg() {
-		return $this->arg_hierarchy->get_field( 'arg' );
+		return $this->arg_hierarchy->get_field('arg');
 	}
 
-	public function arg_hierarchy_push( $slug ) {
+	public function arg_hierarchy_push($slug) {
 
-		$current_slug = $this->arg_hierarchy->get_field( 'slug' );
+		$current_slug = $this->arg_hierarchy->get_field('slug');
 
-		if ( $current_slug === $slug && $this->arg_hierarchy->is_main() ) {
+		if ($current_slug === $slug && $this->arg_hierarchy->is_main()) {
 			return;
 		}
 
 //		if ( $current_slug !== $slug ) {
 
-			if ( empty( $current_slug ) ) {
-				$arg = $this->entities->get( $slug );
+			if (empty($current_slug)) {
+				$arg = $this->entities->get($slug);
 			} else {
 
 				// If this child exists, don't overwrite it, just descend into it.
-				if ( $this->arg_hierarchy->has_child( $slug ) ) {
-					$this->arg_hierarchy->descend( $slug );
+				if ($this->arg_hierarchy->has_child($slug)) {
+					$this->arg_hierarchy->descend($slug);
 					return;
 				}
 
-				$parent_arg = $this->arg_hierarchy->get_field( 'arg' );
+				$parent_arg = $this->arg_hierarchy->get_field('arg');
 
-				if ( $parent_arg instanceof WordPoints_Entity_ParentI ) {
-					$arg = $parent_arg->get_child( $slug );
+				if ($parent_arg instanceof WordPoints_Entity_ParentI) {
+					$arg = $parent_arg->get_child($slug);
 				} else {
 					return; // TODO
 				}
 			}
 
-			if ( $arg instanceof WordPoints_Entity_Array ) {
-				$arg = $this->entities->get( $arg->get_entity_slug() );
+			if ($arg instanceof WordPoints_Entity_Array) {
+				$arg = $this->entities->get($arg->get_entity_slug());
 			}
 
 			$data['arg'] = $arg;
@@ -493,7 +493,7 @@ 
 			// TODO check if storage type is recognized?
 			$data['storage_info'] = $arg->get_storage_info();
 
-			$this->arg_hierarchy->push( $slug, $data );
+			$this->arg_hierarchy->push($slug, $data);
 
 //		} else {
 //			$data = array();
@@ -510,11 +510,11 @@ 
 }
 
 interface WordPoints_Hook_Retroactive_Query_FilterI {
-	public function filter_retroactive_query( WordPoints_Hook_Retroactive_QueryI $query );
+	public function filter_retroactive_query(WordPoints_Hook_Retroactive_QueryI $query);
 }
 
 interface WordPoints_Hook_Retroactive_Query_ExecutorI {
-	public function execute( $query );
+	public function execute($query);
 }
 
 /*
@@ -543,48 +543,48 @@ 
 	protected $array;
 	protected $results;
 
-	public function execute( $query ) {
+	public function execute($query) {
 
-		foreach ( $query as $arg_data ) {
+		foreach ($query as $arg_data) {
 
 			$meta = $arg_data['storage_info']['meta'];
 
-			if ( isset( $meta['getter'] ) ) {
+			if (isset($meta['getter'])) {
 				$this->array = $meta['getter']();
 			}
 
-			if ( isset( $arg_data['conditions'] ) ) {
+			if (isset($arg_data['conditions'])) {
 
-				foreach ( $arg_data['conditions'] as $condition ) {
+				foreach ($arg_data['conditions'] as $condition) {
 
-					if ( ! isset( $condition['field'] ) ) {
-						if ( $arg_data['arg'] instanceof WordPoints_Entity_Attr ) {
+					if ( ! isset($condition['field'])) {
+						if ($arg_data['arg'] instanceof WordPoints_Entity_Attr) {
 							$condition['field'] = $meta['field'];
 						} else {
 							$condition['field'] = $meta['id_field'];
 						}
 					}
 
-					if ( ! isset( $condition['condition'] ) ) {
+					if ( ! isset($condition['condition'])) {
 						$condition['condition'] = '=';
 					}
 
 					$filter_args = array();
 
-					switch ( $condition['condition'] ) {
+					switch ($condition['condition']) {
 
 						case '=':
-							$filter_args[ $condition['field'] ] = $condition['value'];
+							$filter_args[$condition['field']] = $condition['value'];
 							break;
 
 						case 'in':
 							// TODO
 
 						default:
-							return new WP_Error( 'invalid condition type' );
+							return new WP_Error('invalid condition type');
 					}
 
-					$this->array = wp_list_filter( $this->array, $filter_args );
+					$this->array = wp_list_filter($this->array, $filter_args);
 				}
 			}
 
@@ -592,9 +592,9 @@ 
 //				$builder->add_field( $arg_data['select'] );
 //			}
 
-			if ( isset( $arg_data['sub_args'] ) ) {
+			if (isset($arg_data['sub_args'])) {
 				$this->parent_data = $arg_data;
-				$this->array = $this->execute( $arg_data['sub_args'] );
+				$this->array = $this->execute($arg_data['sub_args']);
 			}
 
 			$this->results = $this->array;
@@ -623,7 +623,7 @@ 
 
 	protected $entered_join;
 
-	public function execute( $query ) {
+	public function execute($query) {
 		// WE should be getting a hierarchy object here.
 		// This will let us loop over things easier.
 		// We'll also need to be marking the non-usable parts of the query.
@@ -633,69 +633,69 @@ 
 
 		$this->builder = new WordPoints_Query_Builder_DB_MySQL();
 
-		$this->build_query( $query );
+		$this->build_query($query);
 
 		$sql = $this->builder->get_query();
 
-		if ( is_wp_error( $sql ) ) {
+		if (is_wp_error($sql)) {
 			return $sql;
 		}
 
-		return $wpdb->get_results( $sql );
+		return $wpdb->get_results($sql);
 	}
 
-	protected function build_query( $args ) {
+	protected function build_query($args) {
 
-		foreach ( $args as $arg_data ) {
+		foreach ($args as $arg_data) {
 
 			$this->arg_data = $arg_data;
 
-			if ( isset( $arg_data['storage_info']['meta']['table_name'] ) ) {
-				$this->build_table_schema( $arg_data['storage_info']['meta'] );
+			if (isset($arg_data['storage_info']['meta']['table_name'])) {
+				$this->build_table_schema($arg_data['storage_info']['meta']);
 			}
 
-			if ( isset( $arg_data['conditions'] ) ) {
-				$this->build_conditions( $arg_data['conditions'] );
+			if (isset($arg_data['conditions'])) {
+				$this->build_conditions($arg_data['conditions']);
 			}
 
-			if ( isset( $arg_data['select'] ) ) {
-				$this->builder->add_field( $arg_data['select'] );
+			if (isset($arg_data['select'])) {
+				$this->builder->add_field($arg_data['select']);
 			}
 
-			if ( isset( $arg_data['sub_args'] ) ) {
+			if (isset($arg_data['sub_args'])) {
 
 				$this->grandparent_data = $this->parent_data;
 				$this->parent_data = $arg_data;
 
-				$this->build_query( $arg_data['sub_args'] );
+				$this->build_query($arg_data['sub_args']);
 
 				$this->parent_data = $this->grandparent_data;
 			}
 
-			if ( isset( $this->entered_join ) ) {
+			if (isset($this->entered_join)) {
 				$this->builder->exit_join();
 				$this->entered_join = null;
 			}
 		}
 	}
 
-	protected function build_table_schema( $db ) {
+	protected function build_table_schema($db) {
 
-		if ( $this->builder->get_table() ) {
+		if ($this->builder->get_table()) {
 
-			if ( $this->parent_data['arg'] instanceof WordPoints_Entity_Relationship ) {
+			if ($this->parent_data['arg'] instanceof WordPoints_Entity_Relationship) {
 				$primary_field = $this->parent_data['storage_info']['meta']['field'];
 				$join_field = $db['id_field'];
 				//$primary_field = $this->arg_data['arg']->get_secondary_field();
-			} elseif ( $this->arg_data['arg'] instanceof WordPoints_Entity_Relationship ) {
+			} elseif ($this->arg_data['arg'] instanceof WordPoints_Entity_Relationship) {
 				$join_field = $db['join_field'];
 				$primary_field = $this->parent_data['storage_info']['meta']['id_field'];
 			} else {
-				throw new WordPoints_Query_Builder_Exception( 'Houston, we have a problem.' );
+				throw new WordPoints_Query_Builder_Exception('Houston, we have a problem.');
 			}
 
-			if ( is_array( $primary_field ) && isset( $primary_field['table_name'] ) ) {
-				$this->builder->enter_join( $primary_field );
+			if (is_array($primary_field) && isset($primary_field['table_name'])) {
+				$this->builder->enter_join($primary_field);
 				$primary_field = $primary_field['on']['join_field'];
 			}
 
@@ -707,26 +707,26 @@ 
 				),
 			);
 
-			if ( isset( $db['join_where'] ) ) {
+			if (isset($db['join_where'])) {
 				$join['where'] = $db['join_where'];
 			}
 
-			$this->builder->enter_join( $join );
+			$this->builder->enter_join($join);
 
 			$this->entered_join = true;
 
 		} else {
-			$this->builder->set_table( $db['table_name'] );
-			$this->builder->add_field( $db['id_field'] );
+			$this->builder->set_table($db['table_name']);
+			$this->builder->add_field($db['id_field']);
 		}
 	}
 
-	protected function build_conditions( $conditions ) {
+	protected function build_conditions($conditions) {
 
 		// Join conditions should be pushed to the end.
 		$join_conditions = array();
 
-		foreach ( $conditions as $condition ) {
+		foreach ($conditions as $condition) {
 
 			// THis needs to be the identifier field for the type of arg that this
 			// field represents.
@@ -734,43 +734,43 @@ 
 			// However, for a relationship it could be something else.
 			// Ultimately, this will have to be left up to the arg object to
 			// decide.
-			if ( ! isset( $condition['field'] ) ) {
-				if ( $this->arg_data['arg'] instanceof WordPoints_Entity_Relationship ) {
+			if ( ! isset($condition['field'])) {
+				if ($this->arg_data['arg'] instanceof WordPoints_Entity_Relationship) {
 //					$condition['field'] = $this->arg_data['arg']->get_secondary_field();
 					$condition['field'] = $this->arg_data['storage_info']['meta']['field'];
 
-					if ( is_array( $condition['field'] && isset( $condition['field']['table_name'] ) ) ) {
+					if (is_array($condition['field'] && isset($condition['field']['table_name']))) {
 						$join_conditions[] = $condition;
 						continue;
 					}
-				} elseif ( $this->arg_data['arg'] instanceof WordPoints_Entity_Attr ) {
+				} elseif ($this->arg_data['arg'] instanceof WordPoints_Entity_Attr) {
 					$condition['field'] = $this->arg_data['arg']->get_field();
 				} else {
-					var_dump($this->arg_data['arg']);exit;
+					var_dump($this->arg_data['arg']); exit;
 				}
 			}
 
-			$this->builder->where( $condition );
+			$this->builder->where($condition);
 		}
 
-		$join_count = count( $join_conditions );
+		$join_count = count($join_conditions);
 		$i = 0;
 
-		foreach ( $join_conditions as $condition ) {
+		foreach ($join_conditions as $condition) {
 
 			$i++;
 
-			$this->builder->enter_join( $condition['field'] );
+			$this->builder->enter_join($condition['field']);
 
 			$condition['field'] = $condition['field']['on']['primary_field'];
 
-			$this->builder->where( $condition );
+			$this->builder->where($condition);
 
 			$this->builder->exit_join();
 
 			// If there are more join conditions, we need to leave a fresh, trailing
 			// join for the next one to join to.
-			if ( $i < $join_count ) {
+			if ($i < $join_count) {
 
 				// There is a current join, but it is already being used, so we
 				// need to exit it.

src/includes/classes/query/builder/db/mysql.php

Doc Comments +24 added lines

@@ -9,12 +9,36 @@
 
 
 interface WordPoints_Query_BuilderI {
+
+	/**
+	 * @return void
+	 */
 	public function set_fields( $fields );
+
+	/**
+	 * @return void
+	 */
 	public function add_field( $field );
+
+	/**
+	 * @return void
+	 */
 	public function set_table( $table_name );
 	public function get_table();
+
+	/**
+	 * @return void
+	 */
 	public function enter_join( $join );
+
+	/**
+	 * @return void
+	 */
 	public function exit_join();
+
+	/**
+	 * @return void
+	 */
 	public function where( $condition );
 	public function get_query();
 }

Spacing +119 added lines, -119 removed lines

@@ -9,13 +9,13 @@ 
 
 
 interface WordPoints_Query_BuilderI {
-	public function set_fields( $fields );
-	public function add_field( $field );
-	public function set_table( $table_name );
+	public function set_fields($fields);
+	public function add_field($field);
+	public function set_table($table_name);
 	public function get_table();
-	public function enter_join( $join );
+	public function enter_join($join);
 	public function exit_join();
-	public function where( $condition );
+	public function where($condition);
 	public function get_query();
 }
 
@@ -33,55 +33,55 @@ 
 	protected $aliases = array();
 
 	public function __construct() {
-		$this->query = new WordPoints_Hierarchy( 'joins' );
-		$this->query->push( '', array() );
+		$this->query = new WordPoints_Hierarchy('joins');
+		$this->query->push('', array());
 	}
 
-	public function set_fields( $fields ) {
-		$this->query->set_field( 'fields', $fields );
+	public function set_fields($fields) {
+		$this->query->set_field('fields', $fields);
 	}
 
-	public function add_field( $field ) {
-		$this->query->push_to( 'fields', $field );
+	public function add_field($field) {
+		$this->query->push_to('fields', $field);
 	}
 
-	public function set_table( $table_name ) {
-		$this->query->set_field( 'table_name',  $table_name );
+	public function set_table($table_name) {
+		$this->query->set_field('table_name', $table_name);
 	}
 
 	public function get_table() {
-		return $this->query->get_field( 'table_name' );
+		return $this->query->get_field('table_name');
 	}
 
-	protected function get_alias( $data ) {
+	protected function get_alias($data) {
 
-		if ( ! isset( $this->aliases[ $data['table_name'] ] ) ) {
-			$this->aliases[ $data['table_name'] ] = 0;
+		if ( ! isset($this->aliases[$data['table_name']])) {
+			$this->aliases[$data['table_name']] = 0;
 		}
 
-		return $data['table_name'] . '_' . ++$this->aliases[ $data['table_name'] ];
+		return $data['table_name'].'_'.++$this->aliases[$data['table_name']];
 	}
 
-	public function enter_join( $join ) {
-		$alias = $this->get_alias( $join );
-		$this->query->push( $alias, $join );
+	public function enter_join($join) {
+		$alias = $this->get_alias($join);
+		$this->query->push($alias, $join);
 	}
 
 	public function exit_join() {
 		$this->query->pop();
 	}
 
-	public function where( $condition ) {
+	public function where($condition) {
 
-		$where = $this->query->get_field( 'where' );
+		$where = $this->query->get_field('where');
 
-		if ( ! is_array( $where ) ) {
+		if ( ! is_array($where)) {
 			$where = array();
 		}
 
 		$where[] = $condition;
 
-		$this->query->set_field( 'where', $where );
+		$this->query->set_field('where', $where);
 	}
 }
 
@@ -101,64 +101,64 @@ 
 
 		var_dump($this->query);
 		try {
-			$this->build_query( $this->query->get() );
-		} catch ( WordPoints_Query_Builder_Exception $e ) {
-			return new WP_Error( $e->getMessage(), $e->getTraceAsString() );
+			$this->build_query($this->query->get());
+		} catch (WordPoints_Query_Builder_Exception $e) {
+			return new WP_Error($e->getMessage(), $e->getTraceAsString());
 		}
 
 		return $this->sql;
 	}
 
-	protected function build_query( $query ) {
+	protected function build_query($query) {
 
-		var_dump( __METHOD__, $query );
+		var_dump(__METHOD__, $query);
 
-		$this->alias = $this->get_alias( $query );
+		$this->alias = $this->get_alias($query);
 
-		$this->build_fields( $query );
-		$this->build_from( $query );
-		$this->build_joins( $query );
-		$this->build_where( $query );
+		$this->build_fields($query);
+		$this->build_from($query);
+		$this->build_joins($query);
+		$this->build_where($query);
 		$this->build_select();
 	}
 
 	protected function build_select() {
 
-		if ( empty( $this->fields ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'no fields' );
+		if (empty($this->fields)) {
+			throw new WordPoints_Query_Builder_Exception('no fields');
 		}
 
-		$this->sql = 'SELECT' . $this->fields . $this->sql;
+		$this->sql = 'SELECT'.$this->fields.$this->sql;
 	}
 
-	protected function build_fields( $query ) {
+	protected function build_fields($query) {
 
-		if ( empty( $query['fields'] ) ) {
+		if (empty($query['fields'])) {
 			return;
 		}
 
-		foreach ( $query['fields'] as $field ) {
+		foreach ($query['fields'] as $field) {
 
-			if ( ! is_array( $field ) ) {
-				$field = array( 'field' => $field );
+			if ( ! is_array($field)) {
+				$field = array('field' => $field);
 			}
 
-			if ( ! isset( $field['field'] ) ) {
-				throw new WordPoints_Query_Builder_Exception( 'invalid field' );
+			if ( ! isset($field['field'])) {
+				throw new WordPoints_Query_Builder_Exception('invalid field');
 			}
 
-			if ( ! empty( $this->fields ) ) {
+			if ( ! empty($this->fields)) {
 				$this->fields .= ',';
 			}
 
-			$this->fields .= ' ' . $this->build_field( $field['field'] );
+			$this->fields .= ' '.$this->build_field($field['field']);
 
 			$as = $field['field'];
-			if ( isset( $field['as'] ) ) {
+			if (isset($field['as'])) {
 				$as = $field['as'];
 			}
 
-			$this->fields .= ' AS `' . $this->escape_identifier( $as ) . '`';
+			$this->fields .= ' AS `'.$this->escape_identifier($as).'`';
 		}
 	}
 
@@ -171,118 +171,118 @@ 
 	 *
 	 * @throws WordPoints_Query_Builder_Exception
 	 */
-	protected function build_field( $field ) {
+	protected function build_field($field) {
 
-		$field_name = $this->get_field_name( $field );
+		$field_name = $this->get_field_name($field);
 
-		$sql = '`' . $this->escape_identifier( $this->alias ) . '`';
-		$sql .= '.`' . $this->escape_identifier( $field_name ) . '`';
+		$sql = '`'.$this->escape_identifier($this->alias).'`';
+		$sql .= '.`'.$this->escape_identifier($field_name).'`';
 
 		return $sql;
 	}
 
-	protected function build_from( $query ) {
+	protected function build_from($query) {
 
-		if ( ! isset( $query['table_name'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'table_name' );
+		if ( ! isset($query['table_name'])) {
+			throw new WordPoints_Query_Builder_Exception('table_name');
 		}
 
 		$this->sql .= "\n";
-		$this->sql .= 'FROM `' . $this->escape_identifier( $query['table_name'] ) . '`';
-		$this->sql .= ' AS `' . $this->escape_identifier( $this->alias ) . '`';
+		$this->sql .= 'FROM `'.$this->escape_identifier($query['table_name']).'`';
+		$this->sql .= ' AS `'.$this->escape_identifier($this->alias).'`';
 	}
 
-	protected function build_joins( $query ) {
+	protected function build_joins($query) {
 
-		if ( ! isset( $query['joins'] ) ) {
+		if ( ! isset($query['joins'])) {
 			return;
 		}
 
-		foreach ( $query['joins'] as $join ) {
-			$this->build_join( $join );
+		foreach ($query['joins'] as $join) {
+			$this->build_join($join);
 		}
 	}
 
-	protected function build_join( $join ) {
+	protected function build_join($join) {
 
-		if ( ! isset( $join['table_name'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'join table_name' );
+		if ( ! isset($join['table_name'])) {
+			throw new WordPoints_Query_Builder_Exception('join table_name');
 		}
 
-		if ( ! isset( $join['on'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'join on' );
+		if ( ! isset($join['on'])) {
+			throw new WordPoints_Query_Builder_Exception('join on');
 		}
 
-		if ( ! isset( $join['on']['join_field'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'join on join_field' );
+		if ( ! isset($join['on']['join_field'])) {
+			throw new WordPoints_Query_Builder_Exception('join on join_field');
 		}
 
-		if ( ! isset( $join['on']['primary_field'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'join on primary_field' );
+		if ( ! isset($join['on']['primary_field'])) {
+			throw new WordPoints_Query_Builder_Exception('join on primary_field');
 		}
 
-		$alias = $this->get_alias( $join );
+		$alias = $this->get_alias($join);
 
 		$this->sql .= "\n";
-		$this->sql .= 'INNER JOIN `' . $this->escape_identifier( $join['table_name'] ) . '`';
-		$this->sql .= ' AS `' . $this->escape_identifier( $alias ) . '`';
-		$this->sql .= "\n\t" . 'ON ' . $this->build_field( $join['on']['primary_field'] );
+		$this->sql .= 'INNER JOIN `'.$this->escape_identifier($join['table_name']).'`';
+		$this->sql .= ' AS `'.$this->escape_identifier($alias).'`';
+		$this->sql .= "\n\t".'ON '.$this->build_field($join['on']['primary_field']);
 
 		$old_alias = $this->alias;
 		$this->alias = $alias;
 
-		$this->sql .= ' = ' . $this->build_field( $join['on']['join_field'] );
+		$this->sql .= ' = '.$this->build_field($join['on']['join_field']);
 
-		$this->build_fields( $join );
+		$this->build_fields($join);
 
-		if ( isset( $join['where'] ) ) {
-			foreach ( $join['where'] as $condition ) {
-				$this->build_condition( $condition );
+		if (isset($join['where'])) {
+			foreach ($join['where'] as $condition) {
+				$this->build_condition($condition);
 			}
 		}
 
-		$this->build_joins( $join );
+		$this->build_joins($join);
 
 		$this->alias = $old_alias;
 	}
 
-	protected function build_where( $query ) {
+	protected function build_where($query) {
 
-		if ( empty( $query['where'] ) ) {
+		if (empty($query['where'])) {
 			return;
 		}
 
 		$this->sql .= "\n";
 		$this->sql .= 'WHERE 1=1';
 
-		foreach ( $query['where'] as $condition ) {
-			$this->build_condition( $condition );
+		foreach ($query['where'] as $condition) {
+			$this->build_condition($condition);
 		}
 	}
 
-	protected function build_condition( $condition ) {
+	protected function build_condition($condition) {
 
 		global $wpdb;
 
-		if ( ! isset( $condition['field'], $condition['value'] ) ) {
+		if ( ! isset($condition['field'], $condition['value'])) {
 			var_dump($condition);
-			throw new WordPoints_Query_Builder_Exception( 'bad condition' );
+			throw new WordPoints_Query_Builder_Exception('bad condition');
 		}
 
-		if ( ! isset( $condition['compare'] ) ) {
+		if ( ! isset($condition['compare'])) {
 			$condition['compare'] = '=';
 		}
 
 		$this->sql .= "\n\t";
 
-		$this->build_condition_type( $condition );
+		$this->build_condition_type($condition);
 
-		$field_type = $this->get_field_type( $condition['field'] );
-		if ( 'serialized_array' === $field_type ) {
-			if ( is_array( $condition['value'] ) ) {
-				if ( isset( $condition['compare'] ) && 'in' === $condition['compare'] ) {
+		$field_type = $this->get_field_type($condition['field']);
+		if ('serialized_array' === $field_type) {
+			if (is_array($condition['value'])) {
+				if (isset($condition['compare']) && 'in' === $condition['compare']) {
 					$this->sql .= '( 1=0 ';
-					foreach ( $condition['value'] as $index => $value ) {
+					foreach ($condition['value'] as $index => $value) {
 						$this->build_condition(
 							array(
 								'type' => 'or',
@@ -296,13 +296,13 @@ 
 					return;
 				}
 			} else {
-				$condition['value'] = $this->serialize_value( $condition['value'] );
+				$condition['value'] = $this->serialize_value($condition['value']);
 			}
 		}
 
-		$this->sql .= $this->build_field( $condition['field'] );
+		$this->sql .= $this->build_field($condition['field']);
 
-		switch ( $condition['compare'] ) {
+		switch ($condition['compare']) {
 
 			case '=':
 				$this->sql .= ' = ';
@@ -313,18 +313,18 @@ 
 				break;
 
 			case 'in':
-				$this->sql .= ' IN (' . wordpoints_prepare__in( $condition['value'] ) . ')';
+				$this->sql .= ' IN ('.wordpoints_prepare__in($condition['value']).')';
 				return;
 
 			default:
-				throw new WordPoints_Query_Builder_Exception( 'bad condition comparison' );
+				throw new WordPoints_Query_Builder_Exception('bad condition comparison');
 		}
 
-		if ( ! is_scalar( $condition['value'] ) ) {
-			throw new WordPoints_Query_Builder_Exception( 'bad condition value' );
+		if ( ! is_scalar($condition['value'])) {
+			throw new WordPoints_Query_Builder_Exception('bad condition value');
 		}
 
-		$this->sql .= $wpdb->prepare( '%s', $condition['value'] );
+		$this->sql .= $wpdb->prepare('%s', $condition['value']);
 	}
 
 	/**
@@ -336,13 +336,13 @@ 
 	 *
 	 * @throws WordPoints_Query_Builder_Exception
 	 */
-	protected function build_condition_type( $condition ) {
+	protected function build_condition_type($condition) {
 
-		if ( ! isset( $condition['type'] ) ) {
+		if ( ! isset($condition['type'])) {
 			$condition['type'] = 'and';
 		}
 
-		switch ( $condition['type'] ) {
+		switch ($condition['type']) {
 
 			case 'and':
 				$this->sql .= 'AND ';
@@ -353,21 +353,21 @@ 
 				break;
 
 			default:
-				throw new WordPoints_Query_Builder_Exception( 'bad condition type' );
+				throw new WordPoints_Query_Builder_Exception('bad condition type');
 		}
 	}
 
-	protected function escape_identifier( $identifier ) {
+	protected function escape_identifier($identifier) {
 
-		return str_replace( '`', '``', $identifier );
+		return str_replace('`', '``', $identifier);
 	}
 
-	protected function get_field_name( $field ) {
+	protected function get_field_name($field) {
 
-		if ( is_array( $field ) ) {
+		if (is_array($field)) {
 
-			if ( ! isset( $field['name'] ) ) {
-				throw new WordPoints_Query_Builder_Exception( 'field name' );
+			if ( ! isset($field['name'])) {
+				throw new WordPoints_Query_Builder_Exception('field name');
 			}
 
 			$field = $field['name'];
@@ -376,22 +376,22 @@ 
 		return $field;
 	}
 
-	protected function get_field_type( $field ) {
+	protected function get_field_type($field) {
 
-		if ( is_array( $field ) && isset( $field['type'] ) ) {
+		if (is_array($field) && isset($field['type'])) {
 			return $field['type'];
 		}
 
 		return 'string';
 	}
 
-	protected function serialize_value( $value ) {
+	protected function serialize_value($value) {
 
-		if ( is_string( $value ) ) {
-			$value = '"' . $value . '"';
+		if (is_string($value)) {
+			$value = '"'.$value.'"';
 		}
 
-		return '%:' . $value . ';%';
+		return '%:'.$value.';%';
 	}
 }
 

src/includes/classes/spec.php

Doc Comments +3 added lines

@@ -284,6 +284,9 @@
 		return $entities;
 	}
 
+	/**
+	 * @param integer $count
+	 */
 	protected function check_count( $count ) {
 
 		if ( isset( $this->settings['max'] ) && $count > $this->settings['max'] ) {

Spacing +50 added lines, -50 removed lines

@@ -11,9 +11,9 @@ 
 interface WordPoints_SpecI {
 	public function get_title();
 	public function get_settings_fields();
-	public function validate_settings( $settings );
+	public function validate_settings($settings);
 	public function is_met();
-	public function get_error( $name );
+	public function get_error($name);
 }
 
 abstract class WordPoints_Spec implements  WordPoints_SpecI {
@@ -25,38 +25,38 @@ 
 	 * @param $value
 	 * @param $expected
 	 */
-	public function __construct( $value, $expected ) {
+	public function __construct($value, $expected) {
 		$this->value = $value;
 		$this->expected = $expected;
 	}
 
-	public function validate_settings( $settings ) {
+	public function validate_settings($settings) {
 
-		$data_types = wordpoints_apps()->get_sub_app( 'data_types' );
+		$data_types = wordpoints_apps()->get_sub_app('data_types');
 
-		foreach ( $this->get_settings_fields() as $setting => $data ) {
+		foreach ($this->get_settings_fields() as $setting => $data) {
 
-			if ( ! isset( $settings[ $setting ] ) ) {
+			if ( ! isset($settings[$setting])) {
 
-				if ( ! empty( $data['required'] ) ) {
+				if ( ! empty($data['required'])) {
 					return 'error'; // TODO
 				}
 
 			} else {
 
-				$data_type = $data_types->get( $data['type'] );
+				$data_type = $data_types->get($data['type']);
 
-				if ( ! $data_type instanceof WordPoints_Data_TypeI ) {
+				if ( ! $data_type instanceof WordPoints_Data_TypeI) {
 					continue;
 				}
 
-				$value = $data_type->validate_value( $settings[ $setting ] );
+				$value = $data_type->validate_value($settings[$setting]);
 
-				if ( is_wp_error( $value ) ) {
+				if (is_wp_error($value)) {
 					return $value;
 				}
 
-				$settings[ $setting ] = $value;
+				$settings[$setting] = $value;
 			}
 		}
 
@@ -67,7 +67,7 @@ 
 class WordPoints_Spec_Number_Max extends WordPoints_Spec {
 
 	public function get_title() {
-		return __( 'Maximum', 'wordpoints' );
+		return __('Maximum', 'wordpoints');
 	}
 
 	public function get_settings_fields() {
@@ -85,10 +85,10 @@ 
 		return $this->value <= $this->expected;
 	}
 
-	public function get_error( $name ) {
+	public function get_error($name) {
 
 		return sprintf(
-			__( '%1$s must not be more than %2$s.', 'wordpoints' )
+			__('%1$s must not be more than %2$s.', 'wordpoints')
 			, $name
 			, $this->expected
 		);
@@ -98,7 +98,7 @@ 
 class WordPoints_Spec_String_Length_Max extends WordPoints_Spec {
 
 	public function get_title() {
-		return __( 'Maximum Length', 'wordpoints' );
+		return __('Maximum Length', 'wordpoints');
 	}
 
 	public function get_settings_fields() {
@@ -112,13 +112,13 @@ 
 	}
 
 	public function is_met() {
-		return strlen( $this->value ) <= $this->expected;
+		return strlen($this->value) <= $this->expected;
 	}
 
-	public function get_error( $name ) {
+	public function get_error($name) {
 
 		return sprintf(
-			__( '%1$s must not be longer than %2$s characters.', 'wordpoints' )
+			__('%1$s must not be longer than %2$s characters.', 'wordpoints')
 			, $name
 			, $this->expected
 		);
@@ -129,20 +129,20 @@ 
 class WordPoints_Spec_String_Contains extends WordPoints_Spec {
 
 	public function get_title() {
-		return __( 'Contains', 'wordpoints' );
+		return __('Contains', 'wordpoints');
 	}
 
 	public function get_settings_fields() {
 	}
 
 	public function is_met() {
-		return false !== strpos( $this->value, $this->expected );
+		return false !== strpos($this->value, $this->expected);
 	}
 
-	public function get_error( $name ) {
+	public function get_error($name) {
 
 		return sprintf(
-			__( '%1$s must contain "%2$s".', 'wordpoints' ) // TODO quotes
+			__('%1$s must contain "%2$s".', 'wordpoints') // TODO quotes
 			, $name
 			, $this->expected
 		);
@@ -165,19 +165,19 @@ 
 	protected $validator;
 
 	public function get_title() {
-		return __( 'Contains', 'wordpoints' );
+		return __('Contains', 'wordpoints');
 	}
 
 	public function get_settings_fields() {
 		return array(
 			'min' => array(
 				'slug'  => 'min',
-				'label' => __( 'Minimum number of items', 'wordpoints' ),
+				'label' => __('Minimum number of items', 'wordpoints'),
 				'type'  => 'number',
 			),
 			'max' => array(
 				'slug'  => 'max',
-				'label' => __( 'Maximum number of items', 'wordpoints' ),
+				'label' => __('Maximum number of items', 'wordpoints'),
 				'type'  => 'number',
 			),
 		);
@@ -192,18 +192,18 @@ 
 //		WordPoints_Hook_Reaction_Validator $validator
 	) {
 
-		if ( ! $this->arg_type_supported( $arg, $validator ) ) {
+		if ( ! $this->arg_type_supported($arg, $validator)) {
 			return false;
 		}
 
 		$this->settings = $settings;
 		$this->validator = $validator;
 
-		if ( ! $this->validate_count() ) {
+		if ( ! $this->validate_count()) {
 			return false;
 		}
 
-		if ( isset( $settings['conditions'] ) ) {
+		if (isset($settings['conditions'])) {
 			$this->validate_conditions();
 		}
 
@@ -213,21 +213,21 @@ 
 	protected function validate_count() {
 
 		if (
-			! empty( $this->settings['max'] )
-			&& ! wordpoints_posint( $this->settings['max'] )
+			! empty($this->settings['max'])
+			&& ! wordpoints_posint($this->settings['max'])
 		) {
 			$this->validator->add_error(
-				__( 'The maximum must be a positive integer.', 'wordpoints' )
+				__('The maximum must be a positive integer.', 'wordpoints')
 				, 'max'
 			);
 		}
 
 		if (
-			! empty( $this->settings['min'] )
-			&& ! wordpoints_posint( $this->settings['min'] )
+			! empty($this->settings['min'])
+			&& ! wordpoints_posint($this->settings['min'])
 		) {
 			$this->validator->add_error(
-				__( 'The minimum must be a positive integer.', 'wordpoints' )
+				__('The minimum must be a positive integer.', 'wordpoints')
 				, 'min'
 			);
 		}
@@ -237,12 +237,12 @@ 
 
 	protected function validate_conditions() {
 
-		$conditions_extension = wordpoints_hooks()->get_sub_app( 'extensions' )->get(
+		$conditions_extension = wordpoints_hooks()->get_sub_app('extensions')->get(
 			'conditions'
 		);
 
 		$conditions = $conditions_extension->validate_settings(
-			array( 'conditions' => $this->settings['conditions'] )
+			array('conditions' => $this->settings['conditions'])
 			, $this->validator
 			, $this->validator->get_event_args()
 		);
@@ -252,9 +252,9 @@ 
 
 	public function is_met() {
 
-		$entities = $this->filter_entities( $this->value );
+		$entities = $this->filter_entities($this->value);
 
-		return $this->check_count( count( $entities ) );
+		return $this->check_count(count($entities));
 	}
 
 	/**
@@ -266,41 +266,41 @@ 
 	 *
 	 * @return WordPoints_Entity[]
 	 */
-	protected function filter_entities( $entities ) {
+	protected function filter_entities($entities) {
 
-		$conditions_extension = wordpoints_hooks()->get_sub_app( 'extensions' )->get(
+		$conditions_extension = wordpoints_hooks()->get_sub_app('extensions')->get(
 			'conditions'
 		);
 
-		foreach ( $entities as $index => $entity ) {
+		foreach ($entities as $index => $entity) {
 
 			$matches = $conditions_extension->conditions_are_met(
 				$this->expected['conditions']
-				, new WordPoints_Hook_Event_Args( array( $entity ) )
+				, new WordPoints_Hook_Event_Args(array($entity))
 			);
 
-			if ( ! $matches ) {
-				unset( $entities[ $index ] );
+			if ( ! $matches) {
+				unset($entities[$index]);
 			}
 		}
 
 		return $entities;
 	}
 
-	protected function check_count( $count ) {
+	protected function check_count($count) {
 
-		if ( isset( $this->settings['max'] ) && $count > $this->settings['max'] ) {
+		if (isset($this->settings['max']) && $count > $this->settings['max']) {
 			return false;
 		}
 
-		if ( isset( $this->settings['min'] ) && $count < $this->settings['min'] ) {
+		if (isset($this->settings['min']) && $count < $this->settings['min']) {
 			return false;
 		}
 
 		return true;
 	}
 
-	public function get_error( $name ) {
+	public function get_error($name) {
 		// TODO: Implement get_error() method.
 	}
 }

src/includes/classes/entity/post/type/name.php

Spacing +1 added lines, -1 removed lines

@@ -28,7 +28,7 @@
 	 * @since 1.0.0
 	 */
 	public function get_title() {
-		return _x( 'Name', 'post type', 'wordpoints' );
+		return _x('Name', 'post type', 'wordpoints');
 	}
 }
 

src/includes/classes/entity/post/type/relationship.php

Spacing +1 added lines, -1 removed lines

@@ -34,7 +34,7 @@
 	 * @since 1.0.0
 	 */
 	public function get_title() {
-		return __( 'Post Type', 'wordpoints' );
+		return __('Post Type', 'wordpoints');
 	}
 }
 

src/includes/classes/entity/site.php

Spacing +1 added lines, -1 removed lines

@@ -35,7 +35,7 @@
 	 * @since 1.0.0
 	 */
 	public function get_title() {
-		return __( 'Site', 'wordpoints' );
+		return __('Site', 'wordpoints');
 	}
 }
 

src/includes/classes/hook/arg/current/post.php

Spacing +3 added lines, -3 removed lines

@@ -18,7 +18,7 @@ 
 	 * @since 1.0.0
 	 */
 	public function get_title() {
-		return __( 'Current Post', 'wordpoints' ); // TODO better title?
+		return __('Current Post', 'wordpoints'); // TODO better title?
 	}
 
 	/**
@@ -26,13 +26,13 @@ 
 	 */
 	public function get_value() {
 
-		if ( ! is_main_query() ) {
+		if ( ! is_main_query()) {
 			return false;
 		}
 
 		$object = get_queried_object();
 
-		if ( $object instanceof WP_Post ) {
+		if ($object instanceof WP_Post) {
 			return $object;
 		} else {
 			return false;

src/includes/classes/hook/retroactive/query/modifieri.php

Spacing +1 added lines, -1 removed lines

@@ -8,7 +8,7 @@
  */
 
 interface WordPoints_Hook_Retroactive_Query_ModifierI {
-	public function modify_retroactive_query( WordPoints_Hook_Retroactive_QueryI $query );
+	public function modify_retroactive_query(WordPoints_Hook_Retroactive_QueryI $query);
 }
 
 // EOF