WordPoints / hooks-api

src/includes/classes/wpdb/wrapper.php

Doc Comments +20 added lines

@@ -73,12 +73,28 @@ 
 
 
 interface WordPoints_WPDB_Query_Data {
+
+	/**
+	 * @return string
+	 */
 	public function get_table_name();
+
+	/**
+	 * @return void
+	 */
 	public function get_where_clause();
 }
 
 interface WordPoints_MySQL_Query_Parser_SimpleI {
+
+	/**
+	 * @return void
+	 */
 	public function get_table_name();
+
+	/**
+	 * @return string
+	 */
 	public function get_where_clause();
 }
 
@@ -164,6 +180,10 @@ 
 }
 
 interface WordPoints_WPDB_Query_WrapperI {
+
+	/**
+	 * @return void
+	 */
 	public function __construct( $slug, $args, $wpdb );
 	public function execute();
 

Spacing +51 added lines, -51 removed lines

@@ -11,60 +11,60 @@ 
 
 	protected $wpdb;
 
-	public function __construct( $wpdb ) {
+	public function __construct($wpdb) {
 		$this->wpdb = $wpdb;
 	}
 
-	public function __get( $name ) {
+	public function __get($name) {
 		return $this->wpdb->$name;
 	}
 
-	public function __set( $name, $value ) {
+	public function __set($name, $value) {
 		$this->wpdb->$name = $value;
 	}
 
-	public function __isset( $name ) {
-		return isset( $this->wpdb->$name );
+	public function __isset($name) {
+		return isset($this->wpdb->$name);
 	}
 
-	public function __unset( $name ) {
-		unset( $this->wpdb->$name );
+	public function __unset($name) {
+		unset($this->wpdb->$name);
 	}
 
-	public function __call( $name, $arguments ) {
+	public function __call($name, $arguments) {
 
-		$wrappers = wordpoints_apps()->get_sub_app( 'wpdb_wrappers' );
-		$slugs = $wrappers->get_child_slugs( $name );
+		$wrappers = wordpoints_apps()->get_sub_app('wpdb_wrappers');
+		$slugs = $wrappers->get_child_slugs($name);
 		$should_listen = $query = false;
 
 
-		switch ( $name ) {
+		switch ($name) {
 
 			case 'insert':
 //			case 'replace':
-				$query = new WordPoints_WPDB_Query_Data_Array( $this->args[0] );
+				$query = new WordPoints_WPDB_Query_Data_Array($this->args[0]);
 			break;
 
 			case 'update':
-				$query =  new WordPoints_WPDB_Query_Data_Array( $this->args[0], $this->args[2] );
+				$query = new WordPoints_WPDB_Query_Data_Array($this->args[0], $this->args[2]);
 			break;
 
 			case 'delete':
-				$query =  new WordPoints_WPDB_Query_Data_Array( $this->args[0], $this->args[1] );
+				$query = new WordPoints_WPDB_Query_Data_Array($this->args[0], $this->args[1]);
 			break;
 
 			case 'query':
-				$query =  new WordPoints_WPDB_Query_Data_SQL( $this->args[0] );
+				$query = new WordPoints_WPDB_Query_Data_SQL($this->args[0]);
 			break;
 		}
 
-		if ( $query ) {
+		if ($query) {
 			/** @var WordPoints_WPDB_Query_WrapperI $wrapper */
-			$wrapper = $wrappers->get( $name, $query );
+			$wrapper = $wrappers->get($name, $query);
 
 			$result = $wrapper->execute();
 		} else {
-			$result = call_user_func_array( array( $this->wpdb, $name ), $arguments );
+			$result = call_user_func_array(array($this->wpdb, $name), $arguments);
 		}
 
 		return $result;
@@ -84,7 +84,7 @@ 
 
 class WordPoints_MySQL_Query_Parser_Simple_Insert implements WordPoints_MySQL_Query_Parser_SimpleI {
 
-	public function __construct( $sql ) {
+	public function __construct($sql) {
 		$this->sql = $sql;
 	}
 
@@ -99,7 +99,7 @@ 
 		// columns will not be needed. then the other code can decide what to do.
 		// although I guess sense we have the tablel name we could reun the query
 		// ourselves if we need/want to.
-		if ( stripos( $this->sql, 'ON DUPLICATE KEY UPDATE' ) ) {
+		if (stripos($this->sql, 'ON DUPLICATE KEY UPDATE')) {
 
 		}
 
@@ -119,7 +119,7 @@ 
 	 */
 	protected $parser;
 
-	public function __construct( $sql ) {
+	public function __construct($sql) {
 		$this->sql = $sql;
 		$this->parser = $this->get_parser();
 	}
@@ -130,7 +130,7 @@ 
 		// of query it is.
 		// maybe the parser will actually be passed in, and the query type deterimed
 		// by teh method wrapper.
-		$parser = new WordPoints_MySQL_Query_Parser_Simple_Insert( $this->sql );
+		$parser = new WordPoints_MySQL_Query_Parser_Simple_Insert($this->sql);
 		// maybe we don't even need to parse.
 		return $parser;
 	}
@@ -149,7 +149,7 @@ 
 	protected $table_name;
 	protected $where_data;
 
-	public function __construct( $table_name, $where_data = array() ) {
+	public function __construct($table_name, $where_data = array()) {
 		$this->table_name = $table_name;
 		$this->where_data = $where_data;
 	}
@@ -164,7 +164,7 @@ 
 }
 
 interface WordPoints_WPDB_Query_WrapperI {
-	public function __construct( $slug, $args, $wpdb );
+	public function __construct($slug, $args, $wpdb);
 	public function execute();
 
 }
@@ -185,7 +185,7 @@ 
 	protected $result;
 	protected $backed_up_wpdb_vars;
 
-	public function __construct( $slug, $args, $wpdb ) {
+	public function __construct($slug, $args, $wpdb) {
 		$this->slug = $slug;
 		$this->args = $args;
 		$this->wpdb = $wpdb;
@@ -194,20 +194,20 @@ 
 
 	protected function get_query_data() {
 
-		switch ( $this->slug ) {
+		switch ($this->slug) {
 
 			case 'insert':
 				//			case 'replace':
-				return new WordPoints_WPDB_Query_Data_Array( $this->args[0] );
+				return new WordPoints_WPDB_Query_Data_Array($this->args[0]);
 
 			case 'update':
-				return new WordPoints_WPDB_Query_Data_Array( $this->args[0], $this->args[2] );
+				return new WordPoints_WPDB_Query_Data_Array($this->args[0], $this->args[2]);
 
 			case 'delete':
-				return new WordPoints_WPDB_Query_Data_Array( $this->args[0], $this->args[1] );
+				return new WordPoints_WPDB_Query_Data_Array($this->args[0], $this->args[1]);
 
 			case 'query':
-				return new WordPoints_WPDB_Query_Data_SQL( $this->args[0] );
+				return new WordPoints_WPDB_Query_Data_SQL($this->args[0]);
 		}
 
 		return false;
@@ -217,13 +217,13 @@ 
 
 		$should_listen = $this->should_listen();
 
-		if ( $should_listen ) {
+		if ($should_listen) {
 			$this->before_query();
 		}
 
-		$this->result = call_user_func_array( array( $this->wpdb, $this->slug ), $this->args );
+		$this->result = call_user_func_array(array($this->wpdb, $this->slug), $this->args);
 
-		if ( $should_listen && $this->was_successful_query() ) {
+		if ($should_listen && $this->was_successful_query()) {
 			$this->backup_wpdb_vars();
 			$this->after_query();
 			$this->restore_wpdb_vars();
@@ -252,8 +252,8 @@ 
 
 		// we could check for the availableility of eahc valu here in case of dropins
 		// or they become not available in the future.
-		foreach ( $to_backup as $property ) {
-			$this->backed_up_wpdb_vars[ $property ] = $this->wpdb->$property;
+		foreach ($to_backup as $property) {
+			$this->backed_up_wpdb_vars[$property] = $this->wpdb->$property;
 		}
 	}
 
@@ -263,7 +263,7 @@ 
 		// with the backed up result.
 		$this->wpdb->flush();
 
-		foreach ( $this->backed_up_wpdb_vars as $property => $value ) {
+		foreach ($this->backed_up_wpdb_vars as $property => $value) {
 			$this->wpdb->$property = $value;
 		}
 	}
@@ -301,18 +301,18 @@ 
 	 */
 	protected function is_entity_table() {
 
-		$this->entity = 'new entity object' . $this->data->get_table_name();
+		$this->entity = 'new entity object'.$this->data->get_table_name();
 
 		return true;
 	}
 
 	public function should_listen() {
 
-		if ( ! $this->data ) {
+		if ( ! $this->data) {
 			return false;
 		}
 
-		if ( $this->is_entity_table() ) {
+		if ($this->is_entity_table()) {
 			return false;
 		}
 
@@ -320,7 +320,7 @@ 
 	}
 
 	protected function was_successful_query() {
-		return (bool) wordpoints_posint( $not_by_ref = $this->wpdb->num_rows );
+		return (bool) wordpoints_posint($not_by_ref = $this->wpdb->num_rows);
 	}
 }
 
@@ -330,7 +330,7 @@ 
 	protected $args;
 	protected $wpdb;
 
-	public function __construct( $slug, $args, $wpdb ) {
+	public function __construct($slug, $args, $wpdb) {
 		$this->slug = $slug;
 		$this->args = $args;
 		$this->wpdb = $wpdb;
@@ -341,10 +341,10 @@ 
 		// check if this is a query that we want to listen to.
 		// if so, call execute on a particular child.
 		// otherwise, just call execute.
-		if ( $this->get_query_type() ) {
+		if ($this->get_query_type()) {
 
 		} else {
-			$result = call_user_func_array( array( $this->wpdb, $this->slug ), $this->args );
+			$result = call_user_func_array(array($this->wpdb, $this->slug), $this->args);
 		}
 
 		return $result;
@@ -369,15 +369,15 @@ 
 
 		$ids = $this->get_entity_ids();
 
-		$this->entities = new WordPoints_Entity_Array( $this->entity->get_slug() );
-		$this->entities->set_the_value( $ids );
+		$this->entities = new WordPoints_Entity_Array($this->entity->get_slug());
+		$this->entities->set_the_value($ids);
 	}
 
 	protected function get_entity_ids() {
 		$where = $this->data->get_where_clause();
-		$id_field = wordpoints_escape_mysql_identifier( $this->entity->get_id_field() );
-		$table_name = wordpoints_escape_mysql_identifier( $this->data->get_table_name() );
-		return $this->wpdb->get_col( "SELECT {$id_field} FROM {$table_name} {$where}" );
+		$id_field = wordpoints_escape_mysql_identifier($this->entity->get_id_field());
+		$table_name = wordpoints_escape_mysql_identifier($this->data->get_table_name());
+		return $this->wpdb->get_col("SELECT {$id_field} FROM {$table_name} {$where}");
 	}
 
 	protected function after_query() {
@@ -396,13 +396,13 @@ 
 		$where_clause = $this->data->get_where_clause();
 
 		// get a before snapshot, if any matching are found.
-		if ( $where_clause ) {
+		if ($where_clause) {
 
 		}
 	}
 
 	protected function after_query() {
-		$this->entity->set_the_value( $this->wpdb->insert_id );
+		$this->entity->set_the_value($this->wpdb->insert_id);
 		// I guess we invoke the api to run the action now?
 		$this->trigger_entity_create_actions();
 	}
@@ -413,7 +413,7 @@ 
 
 	protected function after_query() {
 		// I guess we invoke the api to run the action now?
-		$this->trigger_entity_delete_actions( $this->entities );
+		$this->trigger_entity_delete_actions($this->entities);
 	}
 }
 

src/includes/classes/hook/extension/repeat/blocker.php

Spacing +5 added lines, -5 removed lines

@@ -22,22 +22,22 @@
 	/**
 	 * @since 1.0.0
 	 */
-	protected function validate_action_type_settings( $settings ) {
+	protected function validate_action_type_settings($settings) {
 		return (bool) $settings;
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
-	public function should_hit( WordPoints_Hook_Fire $fire ) {
+	public function should_hit(WordPoints_Hook_Fire $fire) {
 
-		$block_repeats = (bool) $this->get_settings_from_fire( $fire );
+		$block_repeats = (bool) $this->get_settings_from_fire($fire);
 
-		if ( ! $block_repeats ) {
+		if ( ! $block_repeats) {
 			return true;
 		}
 
-		if ( $fire->get_matching_hits_query()->count() > 0 ) {
+		if ($fire->get_matching_hits_query()->count() > 0) {
 			return false;
 		}
 

src/includes/classes/hook/extension/reversals.php

Spacing +17 added lines, -17 removed lines

@@ -32,36 +32,36 @@ 
 	/**
 	 * @since 1.0.0
 	 */
-	public function should_hit( WordPoints_Hook_Fire $fire ) {
+	public function should_hit(WordPoints_Hook_Fire $fire) {
 
-		if ( ! $this->get_settings_from_fire( $fire ) ) {
+		if ( ! $this->get_settings_from_fire($fire)) {
 			return true;
 		}
 
-		$ids = $this->get_hits_to_be_reversed( $fire );
+		$ids = $this->get_hits_to_be_reversed($fire);
 
-		return count( $ids ) > 0;
+		return count($ids) > 0;
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
-	public function after_hit( WordPoints_Hook_Fire $fire ) {
+	public function after_hit(WordPoints_Hook_Fire $fire) {
 
-		if ( ! $this->get_settings_from_fire( $fire ) ) {
+		if ( ! $this->get_settings_from_fire($fire)) {
 			return;
 		}
 
-		foreach ( $this->get_hits_to_be_reversed( $fire ) as $id ) {
-			add_metadata( 'wordpoints_hook_hit', $id, 'reverse_fired', true );
+		foreach ($this->get_hits_to_be_reversed($fire) as $id) {
+			add_metadata('wordpoints_hook_hit', $id, 'reverse_fired', true);
 		}
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
-	public function after_miss( WordPoints_Hook_Fire $fire ) {
-		$this->after_hit( $fire );
+	public function after_miss(WordPoints_Hook_Fire $fire) {
+		$this->after_hit($fire);
 	}
 
 	/**
@@ -73,12 +73,12 @@ 
 	 *
 	 * @return array The ids the hits to be reversed.
 	 */
-	protected function get_hits_to_be_reversed( WordPoints_Hook_Fire $fire ) {
+	protected function get_hits_to_be_reversed(WordPoints_Hook_Fire $fire) {
 
 		// We cache these so that we don't run the query both before and after the
 		// fire.
-		if ( isset( $fire->data[ $this->slug ]['hit_ids'] ) ) {
-			return $fire->data[ $this->slug ]['hit_ids'];
+		if (isset($fire->data[$this->slug]['hit_ids'])) {
+			return $fire->data[$this->slug]['hit_ids'];
 		}
 
 		$query = $fire->get_matching_hits_query();
@@ -86,19 +86,19 @@ 
 		$query->set_args(
 			array(
 				'fields'       => 'id',
-				'action_type'  => $this->get_settings_from_fire( $fire ),
+				'action_type'  => $this->get_settings_from_fire($fire),
 				'meta_key'     => 'reverse_fired',
 				'meta_compare' => 'NOT EXISTS',
 			)
 		);
 
-		$ids = $query->get( 'col' );
+		$ids = $query->get('col');
 
-		if ( ! $ids ) {
+		if ( ! $ids) {
 			$ids = array();
 		}
 
-		$fire->data[ $this->slug ]['hit_ids'] = $ids;
+		$fire->data[$this->slug]['hit_ids'] = $ids;
 
 		return $ids;
 	}

src/includes/classes/hook/extension/hit/listeneri.php

Spacing +1 added lines, -1 removed lines

@@ -21,7 +21,7 @@
 	 *
 	 * @param WordPoints_Hook_Fire $fire The hook fire object.
 	 */
-	public function after_hit( WordPoints_Hook_Fire $fire );
+	public function after_hit(WordPoints_Hook_Fire $fire);
 }
 
 // EOF

src/includes/classes/hook/reactor/points/legacy.php

Spacing +7 added lines, -7 removed lines

@@ -27,14 +27,14 @@ 
 		array $settings
 	) {
 
-		if ( isset( $settings['legacy_log_type'] ) ) {
+		if (isset($settings['legacy_log_type'])) {
 			$reaction->update_meta(
 				'legacy_log_type',
 				$settings['legacy_log_type']
 			);
 		}
 
-		parent::update_settings( $reaction, $settings );
+		parent::update_settings($reaction, $settings);
 	}
 
 	/**
@@ -52,9 +52,9 @@ 
 	/**
 	 * @since 1.0.0
 	 */
-	public function reverse_hit( WordPoints_Hook_Fire $fire ) {
+	public function reverse_hit(WordPoints_Hook_Fire $fire) {
 
-		if ( isset( $fire->data['reversals_legacy_points']['points_logs'] ) ) {
+		if (isset($fire->data['reversals_legacy_points']['points_logs'])) {
 
 			$this->reverse_logs(
 				$fire->data['reversals_legacy_points']['points_logs']
@@ -62,17 +62,17 @@ 
 			);
 
 		} else {
-			parent::reverse_hit( $fire );
+			parent::reverse_hit($fire);
 		}
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
-	protected function get_hit_ids_to_be_reversed( WordPoints_Hook_Fire $fire ) {
+	protected function get_hit_ids_to_be_reversed(WordPoints_Hook_Fire $fire) {
 
 		// We closely integrate with the legacy reversals extension to get the IDs.
-		if ( ! isset( $fire->data['reversals_legacy_points']['hit_ids'] ) ) {
+		if ( ! isset($fire->data['reversals_legacy_points']['hit_ids'])) {
 			return array();
 		}
 

src/includes/classes/hook/event/media/upload.php

Spacing +3 added lines, -3 removed lines

@@ -21,7 +21,7 @@ 
 	 */
 	public function get_title() {
 
-		return __( 'Upload Media', 'wordpoints' );
+		return __('Upload Media', 'wordpoints');
 	}
 
 	/**
@@ -29,14 +29,14 @@ 
 	 */
 	public function get_description() {
 
-		return __( 'When a file is uploaded to the Media Library.', 'wordpoints' );
+		return __('When a file is uploaded to the Media Library.', 'wordpoints');
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
 	public function get_reversal_text() {
-		return __( 'Media file deleted.', 'wordpoints' );
+		return __('Media file deleted.', 'wordpoints');
 	}
 }
 

src/includes/classes/hook/event/user/register.php

Spacing +3 added lines, -3 removed lines

@@ -20,21 +20,21 @@
 	 * @since 1.0.0
 	 */
 	public function get_title() {
-		return __( 'Register', 'wordpoints' );
+		return __('Register', 'wordpoints');
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
 	public function get_description() {
-		return __( 'Registering.', 'wordpoints' );
+		return __('Registering.', 'wordpoints');
 	}
 
 	/**
 	 * @since 1.0.0
 	 */
 	public function get_reversal_text() {
-		return __( 'User removed.', 'wordpoints' );
+		return __('User removed.', 'wordpoints');
 	}
 }
 

src/includes/classes/hook/event/post/publish.php

Spacing +15 added lines, -15 removed lines

@@ -26,20 +26,20 @@ 
 	 */
 	public function get_title() {
 
-		$parsed = wordpoints_parse_dynamic_slug( $this->slug );
+		$parsed = wordpoints_parse_dynamic_slug($this->slug);
 
-		switch ( $parsed['dynamic'] ) {
+		switch ($parsed['dynamic']) {
 
 			case 'post':
-				return __( 'Publish Post', 'wordpoints' );
+				return __('Publish Post', 'wordpoints');
 
 			case 'page':
-				return __( 'Publish Page', 'wordpoints' );
+				return __('Publish Page', 'wordpoints');
 
 			default:
 				return sprintf(
 					// translators: singular name of the post type
-					__( 'Publish %s', 'wordpoints' )
+					__('Publish %s', 'wordpoints')
 					, $this->get_entity_title()
 				);
 		}
@@ -50,20 +50,20 @@ 
 	 */
 	public function get_description() {
 
-		$parsed = wordpoints_parse_dynamic_slug( $this->slug );
+		$parsed = wordpoints_parse_dynamic_slug($this->slug);
 
-		switch ( $parsed['dynamic'] ) {
+		switch ($parsed['dynamic']) {
 
 			case 'post':
-				return __( 'When a Post is published.', 'wordpoints' );
+				return __('When a Post is published.', 'wordpoints');
 
 			case 'page':
-				return __( 'When a Page is published.', 'wordpoints' );
+				return __('When a Page is published.', 'wordpoints');
 
 			default:
 				return sprintf(
 					// translators: singular name of the post type
-					__( 'When a %s is published.', 'wordpoints' )
+					__('When a %s is published.', 'wordpoints')
 					, $this->get_entity_title()
 				);
 		}
@@ -74,20 +74,20 @@ 
 	 */
 	public function get_reversal_text() {
 		
-		$parsed = wordpoints_parse_dynamic_slug( $this->slug );
+		$parsed = wordpoints_parse_dynamic_slug($this->slug);
 
-		switch ( $parsed['dynamic'] ) {
+		switch ($parsed['dynamic']) {
 
 			case 'post':
-				return __( 'Post removed.', 'wordpoints' );
+				return __('Post removed.', 'wordpoints');
 
 			case 'page':
-				return __( 'Page removed.', 'wordpoints' );
+				return __('Page removed.', 'wordpoints');
 
 			default:
 				return sprintf(
 					// translators: singular name of the post type
-					_x( '%s removed.', 'post type', 'wordpoints' )
+					_x('%s removed.', 'post type', 'wordpoints')
 					, $this->get_entity_title()
 				);
 		}

src/includes/classes/hook/event/comment/leave.php

Spacing +13 added lines, -13 removed lines

@@ -26,23 +26,23 @@ 
 	 */
 	public function get_title() {
 
-		$parsed = wordpoints_parse_dynamic_slug( $this->slug );
+		$parsed = wordpoints_parse_dynamic_slug($this->slug);
 
-		switch ( $parsed['dynamic'] ) {
+		switch ($parsed['dynamic']) {
 
 			case 'post':
-				return __( 'Comment on a Post', 'wordpoints' );
+				return __('Comment on a Post', 'wordpoints');
 
 			case 'page':
-				return __( 'Comment on a Page', 'wordpoints' );
+				return __('Comment on a Page', 'wordpoints');
 
 			case 'attachment':
-				return __( 'Comment on a Media Upload', 'wordpoints' );
+				return __('Comment on a Media Upload', 'wordpoints');
 
 			default:
 				return sprintf(
 					// translators: singular name of the post type
-					__( 'Comment on a %s', 'wordpoints' )
+					__('Comment on a %s', 'wordpoints')
 					, $this->get_entity_title()
 				);
 		}
@@ -53,23 +53,23 @@ 
 	 */
 	public function get_description() {
 
-		$parsed = wordpoints_parse_dynamic_slug( $this->slug );
+		$parsed = wordpoints_parse_dynamic_slug($this->slug);
 
-		switch ( $parsed['dynamic'] ) {
+		switch ($parsed['dynamic']) {
 
 			case 'post':
-				return __( 'When a user leaves a comment on a Post.', 'wordpoints' );
+				return __('When a user leaves a comment on a Post.', 'wordpoints');
 
 			case 'page':
-				return __( 'When a user leaves a comment on a Page.', 'wordpoints' );
+				return __('When a user leaves a comment on a Page.', 'wordpoints');
 
 			case 'attachment':
-				return __( 'When a user leaves a comment on a file uploaded to the Media Library.', 'wordpoints' );
+				return __('When a user leaves a comment on a file uploaded to the Media Library.', 'wordpoints');
 
 			default:
 				return sprintf(
 					// translators: singular name of the post type
-					__( 'When a user leaves a comment on a %s.', 'wordpoints' )
+					__('When a user leaves a comment on a %s.', 'wordpoints')
 					, $this->get_entity_title()
 				);
 		}
@@ -79,7 +79,7 @@ 
 	 * @since 1.0.0
 	 */
 	public function get_reversal_text() {
-		return __( 'Comment removed.', 'wordpoints' );
+		return __('Comment removed.', 'wordpoints');
 	}
 }