mikeselander / dummybot

types/user.php

<?php
namespace DummyPress\Types;
use DummyPress as Main;
use DummyPress\TestContent as TestContent;
use DummyPress\Delete as Delete;
use DummyPress\Abstracts as Abs;


/**
 * Class to build test data for custom post types.
 *
 * @package    WordPress
 * @subpackage Evans
 * @author     Mike Selander
 */
class User extends Abs\Type {

	/**
	 * type
	 * Defines type slug for use elsewhere in the plugin
	 *
	 * @var string
	 * @access protected
	 */
	protected $type = 'user';

	/**
	 * Create test data posts.
	 *
	 * This is where the magic begins. We accept a cpt id (slug) and potntially
	 * a number of posts to create. We then fetch the supports & metaboxes
	 * for that cpt and feed them into a function to create each post individually.
	 *
	 * @access private
	 *
	 * @see $this->get_cpt_supports, $this->get_metaboxes, $this->create_test_object
	 *
	 * @param string $slug a custom post type ID.
	 * @param boolean $connection Whether or not we're connected to the Internet.
	 * @param int $num Optional. Number of posts to create.

Should the type for parameter $num not be string|integer?

	 */
	public function create_objects( $slug, $connection, $num = '' ) {

This method seems to be duplicated in your project.

The return type could not be reliably inferred; please add a @return annotation.

		// If we're missing a custom post type id - don't do anything
		if ( empty( $slug ) ) {
			return;
		}

		// Set our connection status for the rest of the methods
		$this->connected = $connection;

		// If we forgot to put in a quantity, make one for us
		if ( empty( $num ) ) {
			$num = rand( 5, 30 );
		}

		// Create test posts
		for( $i = 0; $i < $num; $i++ ) {

$i++; does not seem to be reachable.

			$return = $this->create_test_object( $slug );

			return $return;

		}

	}


	/**
	 * Creates the individual test data user.
	 *
	 * Create individual posts for testing with. Gathers basic information such
	 * as title, content, thumbnail, etc. and inserts them with the post. Also
	 * adds metaboxes if applicable .
	 *
	 * @access private
	 *
	 * @see TestContent, wp_insert_post, add_post_meta, update_post_meta, $this->random_metabox_content
	 *
	 * @param string $slug a custom post type ID.
	 */
	private function create_test_object( $slug ) {

The return type could not be reliably inferred; please add a @return annotation.

		if ( ! is_user_logged_in() ) {
			return false;
		}

		$name = apply_filters( "tc_{$slug}_user_name", TestContent::name() );

		// First, insert our post
		$userdata = array(
			'user_pass'			=> wp_generate_password( 12, true, true ),
			'user_login'		=> strtolower( $name['first'] . $name['last'] ) . rand( 10, 100 ),
			'user_email'		=> apply_filters( "tc_{$slug}_user_email", TestContent::email( true ) ),
			'display_name'		=> strtolower( $name['first'] . $name['last'] ),
			'first_name'		=> $name['first'],
			'last_name'			=> $name['last'],
			'description'		=> TestContent::title(),
			'user_registered'	=> date( 'Y-m-d H:i:s' ),
			'role'				=> $slug,
		);

		// Insert the user
		$user_id = wp_insert_user( apply_filters( "tc_{$slug}_user_arguments", $userdata ) );

		// Then, set a test content flag on the new post for later deletion
		add_user_meta( $user_id, 'dummypress_test_data', '__test__', true );

		// Check if we have errors and return them or created message
		if ( is_wp_error( $user_id ) ) {

This code seems to be duplicated across your project.

			error_log( $user_id->get_error_message() );
			return $user_id;
		} else {
			return array(
				'action'	=> 'created',
				'object'	=> 'user',
				'oid'		=> $user_id,
				'type'		=> $slug,
				'link_edit'	=> admin_url( '/user-edit.php?user_id=' . $user_id ),
				'link_view' => get_author_posts_url( $user_id )
			);
		}

	}


	/**
	 * Get all roles and set a cleaner array.
	 *
	 * @see get_editable_roles
	 *
	 * @global object $wp_roles WP Roles obbject
	 *
	 * @return array Array of roles for use in creation and deletion
	 */
	public function get_roles() {
		global $wp_roles;

Use of global functionality is not recommended; it makes your code harder to test, and less reusable.

		$clean_roles = array();

	    $role_names = $wp_roles->get_names();
		$flipped = array_flip( $role_names );

		// Loop through all available roles
		$roles = get_editable_roles();

		$skipped_roles = array(
			'Administrator'
		);

		foreach ( $roles as $role ) {

			if ( in_array( $role['name'], $skipped_roles ) ) {
				continue;
			}

			$clean_roles[] = array(
				'name'	=> $role['name'],
				'slug'	=> $flipped[ $role['name'] ]
			);

		}

		return $clean_roles;

	}


	/**
	 * Delete all test data, regardless of type, within posts.
	 *
	 * @see Delete
	 */
	public function delete_all() {

		$delete =  new Delete;

		// Make sure that the current user is logged in & has full permissions.
		if ( ! $delete->user_can_delete() ) {
			return;
		}

		// Loop through all post types and remove any test data
		$post_types = get_post_types( array( 'public' => true ), 'objects' );
		foreach ( $post_types as $post_type ) :

		    $this->delete( $post_type->name );

		endforeach;

		// Loop through all user roles and remove any data
		foreach ( $this->get_roles() as $role ) :

			$this->delete( $role['slug'] );

		endforeach;

	}


	/**
	 * Delete test data users.
	 *
	 * This function will search for all posts of a particular post type ($slug)
	 * and delete them all using a particular cmb flag that we set when creating
	 * the posts. Validates the user first.
	 *
	 * @see WP_Query, wp_delete_post
	 *
	 * @param string $slug a custom post type ID.
	 */
	public function delete( $slug ) {

		$delete = new Delete;

		// Make sure that the current user is logged in & has full permissions.
		if ( ! $delete->user_can_delete() ) {
			return;
		}

		// Check that $cptslg has a string.
		if ( empty( $slug ) ) {
			return;
		}

		// Find our test data by the unique flag we set when we created the data
		$query = array(
			'role' 			=> $slug,
			'number'		=> 500,
			'meta_query' 	=> array(
				'relation'		=> 'OR',
		        array(
		           'key'       => 'dummypress_test_data',
		           'value'     => '__test__',
		           'compare'   => '='
			   ),
			   array(
				  'key'       => 'evans_test_content',
				  'value'     => '__test__',
				  'compare'   => '='
			  ),
			),
		);

		$objects = new \WP_User_Query( $query );
		$users	 = $objects->get_results();

		if ( ! empty( $users ) ) {

			$events = array();

			foreach ( $users as $user ) {

This code seems to be duplicated across your project.

				// Make sure we can't delete ourselves by accident
				if ( $user->ID == get_current_user_id() ) {
					continue;
				}

				// Double check our set user meta value
				if ( '__test__' != get_user_meta( $user->ID, 'dummypress_test_data', true ) && '__test__' != get_user_meta( $user->ID, 'evans_test_content', true ) ) {
					continue;
				}

				$events[] = array(
					'action'	=> 'deleted',
					'oid'		=> $user->ID,
					'type'		=> $slug,
					'link'		=> ''
				);

				// Force delete the user
				wp_delete_user( $user->ID );

			}

			$events[] = array(
				'action'	=> 'general',
				'message'	=> __( 'Deleted', 'dummybot' ) . ' ' . $slug
			);

			return $events;

		}

	}

}