custom-post-types.php

<?php

/**
 * Abstract class for defining custom post types.
 *
 * */
abstract class CustomPostType {
	public
		$name           = 'custom_post_type',
		$plural_name    = 'Custom Posts',
		$singular_name  = 'Custom Post',
		$add_new_item   = 'Add New Custom Post',
		$edit_item      = 'Edit Custom Post',
		$new_item       = 'New Custom Post',
		$public         = True,  // I dunno...leave it true
		$use_title      = True,  // Title field
		$use_editor     = True,  // WYSIWYG editor, post content field
		$use_revisions  = True,  // Revisions on post content and titles
		$use_thumbnails = False, // Featured images
		$use_order      = False, // Wordpress built-in order meta data
		$use_metabox    = False, // Enable if you have custom fields to display in admin
		$use_shortcode  = False, // Auto generate a shortcode for the post type
		// (see also objectsToHTML and toHTML methods)
		$taxonomies     = array( 'post_tag' ),
		$built_in       = False,

		// Optional default ordering for generic shortcode if not specified by user.
		$default_orderby = null,
		$default_order   = null;


	/**
	 * Wrapper for get_posts function, that predefines post_type for this
	 * custom post type.  Any options valid in get_posts can be passed as an
	 * option array.  Returns an array of objects.
	 * */
	public function get_objects( $options=array() ) {

		$defaults = array(
			'numberposts'   => -1,
			'orderby'       => 'title',
			'order'         => 'ASC',
			'post_type'     => $this->options( 'name' ),
		);
		$options = array_merge( $defaults, $options );
		$objects = get_posts( $options );
		return $objects;
	}


	/**
	 * Similar to get_objects, but returns array of key values mapping post
	 * title to id if available, otherwise it defaults to id=>id.
	 * */
	public function get_objects_as_options( $options=array() ) {
		$objects = $this->get_objects( $options );
		$opt     = array();
		foreach ( $objects as $o ) {
			switch ( True ) {
			case $this->options( 'use_title' ):
				$opt[$o->post_title] = $o->ID;
				break;
			default:
				$opt[$o->ID] = $o->ID;
				break;
			}
		}
		return $opt;
	}


	/**
	 * Return the instances values defined by $key.
	 * */
	public function options( $key ) {
		$vars = get_object_vars( $this );
		return $vars[$key];
	}


	/**
	 * Additional fields on a custom post type may be defined by overriding this
	 * method on an descendant object.
	 * */
	public function fields() {
		return array();
	}


	/**
	 * Using instance variables defined, returns an array defining what this
	 * custom post type supports.
	 * */
	public function supports() {
		//Default support array
		$supports = array();
		if ( $this->options( 'use_title' ) ) {
			$supports[] = 'title';
		}
		if ( $this->options( 'use_order' ) ) {
			$supports[] = 'page-attributes';
		}
		if ( $this->options( 'use_thumbnails' ) ) {
			$supports[] = 'thumbnail';
		}
		if ( $this->options( 'use_editor' ) ) {
			$supports[] = 'editor';
		}
		if ( $this->options( 'use_revisions' ) ) {
			$supports[] = 'revisions';
		}
		return $supports;
	}


	/**
	 * Creates labels array, defining names for admin panel.
	 * */
	public function labels() {
		return array(
			'name'          => __( $this->options( 'plural_name' ) ),
			'singular_name' => __( $this->options( 'singular_name' ) ),
			'add_new_item'  => __( $this->options( 'add_new_item' ) ),
			'edit_item'     => __( $this->options( 'edit_item' ) ),
			'new_item'      => __( $this->options( 'new_item' ) ),
		);
	}


	/**
	 * Creates metabox array for custom post type. Override method in
	 * descendants to add or modify metaboxes.
	 * */
	public function metabox() {
		if ( $this->options( 'use_metabox' ) ) {
			return array(
				'id'       => $this->options( 'name' ).'_metabox',
				'title'    => __( $this->options( 'singular_name' ).' Fields' ),
				'page'     => $this->options( 'name' ),
				'context'  => 'normal',
				'priority' => 'high',
				'fields'   => $this->fields(),
			);
		}
		return null;
	}


	/**
	 * Registers metaboxes defined for custom post type.
	 * */
	public function register_metaboxes() {
		if ( $this->options( 'use_metabox' ) ) {
			$metabox = $this->metabox();
			add_meta_box(
				$metabox['id'],
				$metabox['title'],
				'show_meta_boxes',
				$metabox['page'],
				$metabox['context'],
				$metabox['priority']
			);
		}
	}


	/**
	 * Registers the custom post type and any other ancillary actions that are
	 * required for the post to function properly.
	 * */
	public function register() {
		$registration = array(
			'labels'     => $this->labels(),
			'supports'   => $this->supports(),
			'public'     => $this->options( 'public' ),
			'taxonomies' => $this->options( 'taxonomies' ),
			'_builtin'   => $this->options( 'built_in' )
		);

		if ( $this->options( 'use_order' ) ) {
			$registration = array_merge( $registration, array( 'hierarchical' => True, ) );
		}

		register_post_type( $this->options( 'name' ), $registration );

		if ( $this->options( 'use_shortcode' ) ) {
			add_shortcode( $this->options( 'name' ).'-list', array( $this, 'shortcode' ) );
		}
	}


	/**
	 * Shortcode for this custom post type.  Can be overridden for descendants.
	 * Defaults to just outputting a list of objects outputted as defined by
	 * toHTML method.
	 * */
	public function shortcode( $attr ) {
		$default = array(
			'type' => $this->options( 'name' ),
		);
		if ( is_array( $attr ) ) {
			$attr = array_merge( $default, $attr );
		}else {
			$attr = $default;
		}
		return sc_object_list( $attr );
	}


	/**
	 * Handles output for a list of objects, can be overridden for descendants.
	 * If you want to override how a list of objects are outputted, override
	 * this, if you just want to override how a single object is outputted, see
	 * the toHTML method.
	 * */
	public function objectsToHTML( $objects, $css_classes ) {
		if ( count( $objects ) < 1 ) { return '';}

		$class = get_custom_post_type( $objects[0]->post_type );
		$class = new $class;

		ob_start();
?>
		<ul class="<?php if ( $css_classes ):?><?php echo $css_classes?><?php else:?><?php echo $class->options( 'name' )?>-list<?php endif;?>">
			<?php foreach ( $objects as $o ):?>
			<li>
				<?php echo $class->toHTML( $o )?>
			</li>
			<?php endforeach;?>
		</ul>
		<?php
			$html = ob_get_clean();
		return $html;
	}


	/**
	 * Outputs this item in HTML.  Can be overridden for descendants.
	 * */
	public function toHTML( $object ) {
		$html = '<a href="'.get_permalink( $object->ID ).'">'.$object->post_title.'</a>';
		return $html;
	}
}


class Page extends CustomPostType {
	public
		$name           = 'page',
		$plural_name    = 'Pages',
		$singular_name  = 'Page',
		$add_new_item   = 'Add New Page',
		$edit_item      = 'Edit Page',
		$new_item       = 'New Page',
		$public         = True,
		$use_editor     = True,
		$use_thumbnails = False,
		$use_order      = True,
		$use_title      = True,
		$use_metabox    = True,
		$built_in       = True;

	public function fields() {
		$prefix = $this->options( 'name' ).'_';
		return array(
			array(
				'name' => 'Stylesheet',
				'desc' => '',
				'id' => $prefix.'stylesheet',
				'type' => 'file',
			)
		);
	}
}


class Post extends CustomPostType {
	public
		$name           = 'post',
		$plural_name    = 'Posts',
		$singular_name  = 'Post',
		$add_new_item   = 'Add New Post',
		$edit_item      = 'Edit Post',
		$new_item       = 'New Post',
		$public         = True,
		$use_editor     = True,
		$use_thumbnails = False,
		$use_order      = True,
		$use_title      = True,
		$use_metabox    = True,
		$taxonomies     = array( 'post_tag', 'category' ),
		$built_in       = True;

	public function fields() {
		$prefix = $this->options( 'name' ).'_';
		return array(
			array(
				'name' => 'Stylesheet',
				'desc' => '',
				'id' => $prefix.'stylesheet',
				'type' => 'file',
			),
		);
	}
}


class FAQ extends CustomPostType {
	public
		$name           = 'faq',
		$plural_name    = 'FAQs',
		$singular_name  = 'FAQ',
		$add_new_item   = 'Add New FAQ',
		$edit_item      = 'Edit FAQ',
		$new_item       = 'New FAQ',
		$public         = True,
		$use_editor     = True,
		$use_thumbnails = False,
		$use_order      = True,
		$use_title      = True,
		$use_metabox    = False,
		$use_shortcode  = True;

	public function objectsToHTML( $faqs, $css_classes ) {
		if ( count( $faqs ) < 1 ) { return ''; }

		ob_start();

		?> <div class="row"><?php

		foreach ( $faqs as $i=>$faq ) {
?>
			<div class="col-md-6">
				<article class="faq">
					<h2 class="faq-q"><span class="ucf-gold">Q:</span> <?php echo $faq->post_title; ?></h2>
					<p class="faq-a"><span class="ucf-gold">A:</span> <?php echo $faq->post_content; ?></p>
				</article>
			</div>
			<?php
			if ( $i % 2 == 1 ) {
				?></div><div class="row"><?php
			}
		}

		?> </div> <?php

		return ob_get_clean();
	}
}


class Cluster extends CustomPostType {
	public
		$name           = 'cluster',
		$plural_name    = 'Faculty Clusters',
		$singular_name  = 'Faculty Cluster',
		$add_new_item   = 'Add New Faculty Cluster',
		$edit_item      = 'Edit Faculty Cluster',
		$new_item       = 'New Faculty Cluster',
		$public         = True,
		$use_editor     = True,
		$use_thumbnails = False,
		$use_order      = True,
		$use_title      = True,
		$use_metabox    = True,
		$taxonomies     = array( 'post_tag' ),
		$use_shortcode  = True;

	public function get_people_as_options() {
		// Note: $person->get_objects_as_options() will NOT return
		// People that do not have a Order By Name set!
		$person = new Person;
		return $person->get_objects_as_options();
	}

	public static function get_leads( $cluster ) {
		$lead_posts = array();
		$leads = get_post_meta( $cluster->ID, 'cluster_leads' );
		if ( $leads ) {
			foreach ( $leads[0] as $post_id ) {
				$lead_posts[] = get_post( intval( $post_id ) );
			}
		}
		return $lead_posts;
	}

	public function fields() {
		$prefix = $this->options( 'name' ) . '_';
		return array(
			array(
				'name' => 'Stylesheet',
				'desc' => '',
				'id' => $prefix . 'stylesheet',
				'type' => 'file',
			),
			array(
				'name' => 'Header Image',
				'desc' => 'Full-width image to show when displaying this Faculty Cluster in a list.',
				'id' => $prefix . 'header_image',
				'type' => 'file',
			),
			array(
				'name' => 'Short Description',
				'desc' => 'Short description to show when displaying this Faculty Cluster in a list.',
				'id' => $prefix . 'short_description',
				'type' => 'textarea',
			),
			array(
				'name' => 'Cluster Leads',
				'desc' => 'One or more people that serve as the lead(s) of this cluster.',
				'id' => $prefix . 'leads',
				'type' => 'multiselect',
				'options' => $this->get_people_as_options()
			),
			array(
				'name' => 'List of Positions URL',
				'desc' => 'URL to use when linking to this cluster\'s list of positions.',
				'id' => $prefix . 'positions_url',
				'type' => 'text',
				'default' => 'https://www.jobswithucf.com/'
			),
			array(
				'name' => 'CTA Text',
				'desc' => 'Text to use within this cluster\'s call-to-action button.  Accepts HTML.',
				'id' => $prefix . 'cta_text',
				'type' => 'textarea',
				'default' => '<span class="btn-cta-left">Apply Now</span>
<span class="sr-only"> for </span>
<span class="btn-cta-right">Open Cluster Positions</span>'
			),
			array(
				'name' => 'CTA URL',
				'desc' => 'URL to use when linking to this cluster\'s call-to-action.',
				'id' => $prefix . 'cta_url',
				'type' => 'text',
			),
		);
	}

	public function toHTML( $object ) {
		$html = '';
		if ( $object->post_content ) {
			$html = '<a href="'.get_permalink( $object->ID ).'">'.$object->post_title.'</a>';
		}
		else {
			$html = $object->post_title;
		}
		return $html;
	}
}


/**
 * Describes a staff member
 *
 * @author Chris Conover
 * */
class Person extends CustomPostType {
	public
		$name           = 'person',
		$plural_name    = 'People',
		$singular_name  = 'Person',
		$add_new_item   = 'Add Person',
		$edit_item      = 'Edit Person',
		$new_item       = 'New Person',
		$public         = True,
		$use_shortcode  = True,
		$use_metabox    = True,
		$use_thumbnails = True,
		$use_order      = True,
		$taxonomies     = array( 'org_groups' );

	public function fields() {
		$fields = array(
			array(
				'name'    => __( 'Title Prefix' ),
				'desc'    => '',
				'id'      => $this->options( 'name' ).'_title_prefix',
				'type'    => 'text',
			),
			array(
				'name'    => __( 'Title Suffix' ),
				'desc'    => __( 'Be sure to include leading comma or space if neccessary.' ),
				'id'      => $this->options( 'name' ).'_title_suffix',
				'type'    => 'text',
			),
			array(
				'name'    => __( 'Job Title' ),
				'desc'    => __( '' ),
				'id'      => $this->options( 'name' ).'_jobtitle',
				'type'    => 'text',
			),
			array(
				'name'    => __( 'Phone' ),
				'desc'    => __( 'Separate multiple entries with commas.' ),
				'id'      => $this->options( 'name' ).'_phones',
				'type'    => 'text',
			),
			array(
				'name'    => __( 'Email' ),
				'desc'    => __( '' ),
				'id'      => $this->options( 'name' ).'_email',
				'type'    => 'text',
			),
			array(
				'name'    => __( 'Order By Name' ),
				'desc'    => __( 'Name used for sorting. Leaving this field blank may lead to an unexpected sort order.' ),
				'id'      => $this->options( 'name' ).'_orderby_name',
				'type'    => 'text',
			),
		);
		return $fields;
	}

	public function get_objects( $options=array() ) {
		$options['order']    = 'ASC';
		$options['orderby']  = 'person_orderby_name';
		$options['meta_key'] = 'person_orderby_name';
		return parent::get_objects( $options );
	}

	public static function get_name( $person ) {
		$prefix = get_post_meta( $person->ID, 'person_title_prefix', True );
		$suffix = get_post_meta( $person->ID, 'person_title_suffix', True );
		$name = $person->post_title;
		return $prefix.' '.$name.' '.$suffix;
	}

	public static function get_phones( $person ) {
		$phones = get_post_meta( $person->ID, 'person_phones', True );
		return ( $phones != '' ) ? explode( ',', $phones ) : array();
	}

	public function objectsToHTML( $people, $css_classes ) {
		ob_start();
	?>
		<div class="row">
			<div class="col-md-12">
				<table class="table table-striped">
					<thead>
						<tr>
							<th scope="col" class="name">Name</th>
							<th scope="col" class="job_title">Title</th>
							<th scope="col" class="phones">Phone</th>
							<th scope="col" class="email">Email</th>
						</tr>
					</thead>
					<tbody>
		<?php
		foreach ( $people as $person ):
			$email = get_post_meta( $person->ID, 'person_email', True );
			$link = ( $person->post_content == '' ) ? False : True; ?>
						<tr>
							<td class="name">
								<?php if ( $link ) {?><a href="<?php echo get_permalink( $person->ID )?>"><?php }?>
									<?php echo $this->get_name( $person )?>
								<?php if ( $link ) {?></a><?php }?>
							</td>
							<td class="job_title">
								<?php if ( $link ) {?><a href="<?php echo get_permalink( $person->ID )?>"><?php }?>
								<?php echo get_post_meta( $person->ID, 'person_jobtitle', True )?>
								<?php if ( $link ) {?></a><?php }?>
							</td>
							<td class="phones"><?php if ( ( $link ) && ( $this->get_phones( $person ) ) ) {?><a href="<?php echo get_permalink( $person->ID )?>">
								<?php } if ( $this->get_phones( $person ) ) {?>
									<ul class="list-unstyled"><?php foreach ( $this->get_phones( $person ) as $phone ) { ?><li><?php echo $phone?></li><?php } ?></ul>
								<?php } if ( ( $link ) && ( $this->get_phones( $person ) ) ) {?></a><?php }?></td>
							<td class="email"><?php echo ( $email != '' ) ? '<a href="mailto:'.$email.'">'.$email.'</a>' : ''?></td>
						</tr>
		<?php endforeach; ?>
					</tbody>
				</table>
			</div>
		</div>
	<?php
		return ob_get_clean();
	}
} // END class


class Feature extends CustomPostType {
	public
		$name           = 'feature',
		$plural_name    = 'Features',
		$singular_name  = 'Feature',
		$add_new_item   = 'Add New Feature',
		$edit_item      = 'Edit Feature',
		$new_item       = 'New Feature',
		$public         = True,
		$use_editor     = True,
		$use_thumbnails = True,
		$use_order      = True,
		$use_title      = True,
		$use_metabox    = True,
		$taxonomies     = array( 'post_tag' );

	public function fields() {
		$prefix = $this->options( 'name' ).'_';
		return array(
			array(
				'name' => 'Stylesheet',
				'desc' => '',
				'id' => $prefix.'stylesheet',
				'type' => 'file',
			),
			array(
				'name' => 'Primary Title Text',
				'desc' => 'Smaller text displayed within the Feature\'s title.',
				'id' => $prefix . 'header_text_primary',
				'type' => 'text',
				'default' => ''
			),
			array(
				'name' => 'Secondary Title Text',
				'desc' => 'Larger text displayed within the Feature\'s title. If unset, the Feature\'s post title will be used.',
				'id' => $prefix . 'header_text_secondary',
				'type' => 'text',
				'default' => ''
			),
		);
	}
}

?>