mikeselander / dummybot

types/post.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 Post extends Abs\Type {

	/**
	 * metabox_types
	 * Easy access for the MetaboxTypes class.
	 *
	 * @var object
	 * @access private
	 */
	private $metabox_types;

	/**
	 * metabox_values
	 * Easy access for the MetaboxValues class.
	 *
	 * @var object
	 * @access private
	 */
	private $metabox_values;

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

	/**
	 * Constructor to load in the Metaboxes class.
	 *
	 * @see MetaboxTypes, MetaboxValues
	 */
	public function __construct() {

		$this->metabox_types = new Main\MetaboxTypes;
		$this->metabox_values = new Main\MetaboxValues;

	}

	/**
	 * 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 = '' ) {

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

		// Gather the necessary data to create the posts
		$supports 	= $this->get_cpt_supports( $slug );
		$metaboxes	= $this->metabox_types->get_metaboxes( $slug );

		// 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, $supports, $metaboxes );

			return $return;

		}

	}


	/**
	 * Creates the individual test data post.
	 *
	 * 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->get_values
	 *
	 * @param string $slug a custom post type ID.
	 * @param array $supports Features that the post type supports.
	 * @param array $supports All CMB2 metaboxes attached to the post type.
	 */
	private function create_test_object( $slug, $supports, $metaboxes ) {

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

		$return = '';

		// Get a random title
		$title = apply_filters( "tc_{$slug}_post_title", TestContent::title() );

		// First, insert our post
		$post = array(
		  'post_name'      => sanitize_title( $title ),
		  'post_status'    => 'publish',
		  'post_type'      => $slug,
		  'ping_status'    => 'closed',
		  'comment_status' => 'closed',
		);

		// Add title if supported
		if ( $supports['title'] === true ) {
			$post['post_title'] = $title;
		}

		// Add main content if supported
		if ( $supports['editor'] === true ) {
			$post['post_content'] = apply_filters( "tc_{$slug}_post_content", TestContent::paragraphs() );
		}

		// Add excerpt content if supported
		if ( $supports['excerpt'] === true ) {
			$post['post_excerpt'] = apply_filters( "tc_{$slug}_post_excerpt", TestContent::plain_text() );
		}

		// Insert then post object
		$post_id = wp_insert_post( apply_filters( "tc_{$slug}_post_arguments", $post ) );

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

		// Add thumbnail if supported
		if ( $this->connected == true && ( $supports['thumbnail'] === true || in_array( $slug, array( 'post', 'page' ) ) ) ) {

It seems like you are loosely comparing two booleans. Considering using the strict comparison === instead.

			 update_post_meta( $post_id, '_thumbnail_id', TestContent::image( $post_id ) );
		}

		$taxonomies = get_object_taxonomies( $slug );

		// Assign the post to terms
		if ( ! empty( $taxonomies ) ) {
			$return .= $this->assign_terms( $post_id, $taxonomies );
		}

		// Spin up metaboxes
		if ( ! empty( $metaboxes ) ) {
			foreach ( $metaboxes as $cmb ) :
				$return .= $this->metabox_values->get_values( $post_id, $cmb, $this->connected );
			endforeach;
		}

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

This code seems to be duplicated across your project.

			error_log( $post_id->get_error_message() );
			return $post_id;
		} else {
			return array(
				'action'	=> 'created',
				'object'	=> 'post',
				'oid'		=> $post_id,
				'type'		=> get_post_type( $post_id ),
				'link_edit'	=> admin_url( '/post.php?post='.$post_id.'&action=edit' ),
				'link_view'	=> get_permalink( $post_id ),
			);
		}

	}


	/**
	 * Assemble supports statements for a particular post type.
	 *
	 * @access private
	 *
	 * @see post_type_supports
	 *
	 * @param string $slug a custom post type ID.
	 * @return array Array of necessary supports booleans.
	 */
	private function get_cpt_supports( $slug ) {

		$supports = array(
			'title'		=> post_type_supports( $slug, 'title' ),
			'editor'	=> post_type_supports( $slug, 'editor' ),
			'excerpt'	=> post_type_supports( $slug, 'excerpt' ),
			'thumbnail'	=> post_type_supports( $slug, 'thumbnail' ),
		);

		return $supports;

	}


	/**
	 * Assigns taxonomies to the new post.
	 *
	 * Loop through every taxonomy type associated with a custom post type &
	 * assign the post to a random item out of each taxonomy. Taxonomies must
	 * have at least one term in them for this to work.
	 *
	 * @access private
	 *
	 * @param int $post_id a custom post type ID.
	 * @param array $taxonomies taxonomies assigned to this cpt.
	 * @return object WP Error if there is one.
	 */
	private function assign_terms( $post_id, $taxonomies ) {

		// Make sure it's an array & has items
		if ( empty( $taxonomies ) || ! is_array( $taxonomies ) ) {
			return;
		}

		foreach ( $taxonomies as $tax ) {

			// Get the individual terms already existing
			$terms = get_terms( $tax, array( 'hide_empty'	=> false ) );
			$count = count( $terms ) - 1;

			// If there are no terms, skip to the next taxonomy
			if ( empty( $terms ) ) {
				continue;
			}

			// Get a random index to use
			$index = rand( 0, $count );

			// Initialize our array
			$post_data = array(
				'ID'	=> $post_id
			);

			// Set the term data to update
			$post_data['tax_input'][ $tax ] = array( $terms[$index]->term_id );

			// Update the post with the taxonomy info
			$return = wp_update_post( $post_data );

			// Return the error if it exists
			if ( is_wp_error( $return ) ) {
				error_log( $return->get_error_messages() );
				return $return->get_error_messages();
			}

		}

	}


	/**
	 * 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 ) :

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

		endforeach;

	}


	/**
	 * Delete test data posts.
	 *
	 * 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(
			'post_type' 		=> $slug,
			'posts_per_page'	=> 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_Query( $query );

		if ( $objects->have_posts() ) {

			$events = array();

			while ( $objects->have_posts() ) : $objects->the_post();

				// Find any media associated with the test post and delete it as well
				$this->delete_associated_media( get_the_id() );

				// Double check our set user meta value
				if ( '__test__' != get_post_meta( get_the_id(), 'dummypress_test_data', true ) && '__test__' != get_post_meta( get_the_id(), 'evans_test_content', true ) ) {
					continue;
				}

				$events[] = array(
					'action'	=> 'deleted',
					'oid'		=> get_the_id(),
					'type'		=> get_post_type( get_the_id() ),
					'link'		=> ''
				);

				// Force delete the post
				wp_delete_post( get_the_id(), true );

			endwhile;

			$obj = get_post_type_object( $slug );

			$events[] = array(
				'action'	=> 'general',
				'message'	=> __( 'Deleted', 'dummybot' ) . ' ' . $obj->labels->all_items
			);

			return $events;

		}

	}


	/**
	 * Find and delete attachments associated with a post ID.
	 *
	 * This function finds each attachment that is associated with a post ID
	 * and deletes it completely from the site. This is to prevent leftover
	 * random images from sitting on the site forever.
	 *
	 * @access private
	 *
	 * @see get_attached_media, wp_delete_attachment
	 *
	 * @param int $pid a custom post type ID.
	 */
	private function delete_associated_media( $pid ) {

		$delete =  new Delete;

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

		// Make sure $pid is, in fact, an ID
		if ( ! is_int( $pid ) ) {
			return;
		}

		// Get our images
		$media = get_attached_media( 'image', $pid );

		if ( ! empty( $media ) ) {

			// Loop through the media & delete each one
			foreach ( $media as $attachment ) {
				wp_delete_attachment( $attachment->ID, true );
			}

		}

	}


}