Taxonomy images error handling

code-snippets.php

@@ -1,27 +1,34 @@
 <?php
+
 /**
- * Tests for various filters.
+ * @package     Taxonomy Images
+ * @subpackage  Code Snippets
+ *
+ * The following are a series of example tests to check the output
+ * of the Taxonomy Images filters.
  */
 
 
+
+// Don't actually output any of this!
 exit;
 
 
 
-/*
+/**
  * Append the term images to content + excerpt.
  */
-function mytheme_append_the_term_images( $content ) {
+function taxonomy_images_test_theme_append_the_term_images( $content ) {
 	return $content . apply_filters( 'taxonomy-images-list-the-terms', '', array(
 		'image_size' => 'detail',
-		) );
+	) );
 }
-add_filter( 'the_content', 'mytheme_append_the_term_images' );
-add_filter( 'the_excerpt', 'mytheme_append_the_term_images' );
+add_filter( 'the_content', 'taxonomy_images_test_theme_append_the_term_images' );
+add_filter( 'the_excerpt', 'taxonomy_images_test_theme_append_the_term_images' );
 
 
 
-/*
+/**
  * Queried Term Image.
  *
  * Return html markup representing the image associated with the
@@ -41,7 +48,7 @@ function mytheme_append_the_term_images( $content ) {
 
 /* Inside a yellow box */
 $img = apply_filters( 'taxonomy-images-queried-term-image', 'PLEASE INSTALL PLUGIN', array(
-	'before' => '<div style="padding:20px;background-color:yellow;">',
+	'before' => '<div style="padding: 20px; background-color: yellow;">',
 	'after'  => '</div>',
 	) );
 print '<h2>taxonomy-images-queried-term-image - custom wrapper element.</h2>';
@@ -51,15 +58,15 @@ function mytheme_append_the_term_images( $content ) {
 /* Medium Size */
 $img = apply_filters( 'taxonomy-images-queried-term-image', 'PLEASE INSTALL PLUGIN', array(
 	'image_size' => 'medium',
-	) );
+) );
 print '<h2>taxonomy-images-queried-term-image - medium image size</h2>';
 print '<pre>' . htmlentities( $img ) . '</pre>';
 
 
 /* Unrecognized size */
 $img = apply_filters( 'taxonomy-images-queried-term-image', 'PLEASE INSTALL PLUGIN', array(
 	'image_size' => 'this-is-probably-not-a-real-image-size',
-	) );
+) );
 print '<h2>taxonomy-images-queried-term-image - unknown image size</h2>';
 print '<pre>' . htmlentities( $img ) . '</pre>';
 
@@ -71,14 +78,14 @@ function mytheme_append_the_term_images( $content ) {
 		'class' => 'my-class-list bunnies turtles',
 		'src'   => 'this-is-where-the-image-lives.png',
 		'title' => 'Custom Title',
-		),
-	) );
+	),
+) );
 print '<h2>taxonomy-images-queried-term-image - custom attributes</h2>';
 print '<pre>' . htmlentities( $img ) . '</pre>';
 
 
 
-/*
+/**
  * Queried Term Image ID.
  *
  * Return the id of the image associated with the currently
@@ -89,14 +96,13 @@ function mytheme_append_the_term_images( $content ) {
  * apply_filters() will return it's second parameter.
  */
 $img = apply_filters( 'taxonomy-images-queried-term-image-id', 'PLEASE INSTALL PLUGIN' );
-
 print '<h2>taxonomy-images-queried-term-image-id</h2>';
 print '<pre>'; var_dump( $img ); print '</pre>';
 
 
 
 
-/*
+/**
  * Queried Term Image Object.
  *
  * Return an object representing the image associated with the
@@ -107,14 +113,13 @@ function mytheme_append_the_term_images( $content ) {
  * apply_filters() will return it's second parameter.
  */
 $img = apply_filters( 'taxonomy-images-queried-term-image-object', 'PLEASE INSTALL PLUGIN' );
-
 print '<h2>taxonomy-images-queried-term-image-object</h2>';
 print '<pre>'; var_dump( $img ); print '</pre>';
 
 
 
 
-/*
+/**
  * Queried Term Image URL.
  *
  * Return a url to the image associated with the current queried
@@ -150,7 +155,7 @@ function mytheme_append_the_term_images( $content ) {
 
 
 
-/*
+/**
  * Queried Term Image Data.
  *
  * Return an array of data about the image associated with the current

admin.css → css/admin.css

@@ -1,57 +1,80 @@
+
 .taxonomy-images-modal .create-association .term-name {
 	font-style: italic;
 }
+
 .taxonomy-images-modal .create-association {
 	display: inline;
 }
+
 .taxonomy-images-modal .remove-association {
 	color: #bc0b0b;
 	cursor: pointer;
 	display: none;
 	text-decoration: underline;
 }
+
 .taxonomy-images-modal #tab-type_url,
 .taxonomy-images-modal .savesend input {
 	display: none !important;
 }
+
 .taxonomy-image-thumbnail {
 	display: block;
 	margin-bottom: 3px;
 	overflow: hidden;
 	text-align: center;
-	width: 77px;
-	height: 77px;
+	width: 75px;
+	height: 75px;
 }
+
+.taxonomy-image-thumbnail img {
+	width: 75px;
+	height: 75px;
+}
+
 .taxonomy-image-control .control {
-	background: url( controls.png );
+	background: url( ../controls.png );
 	background-repeat: no-repeat;
 	display: block;
 	float: left;
 	text-indent: -9999em;
 	width: 15px;
 	height: 15px;
 }
+
 .taxonomy-image-control .control:hover {
 	cursor: pointer;
 }
+
 .taxonomy-image-control .upload {
 	background-position: 0 0;
 }
+
 .taxonomy-image-control .upload:hover {
 	background-position: -15px 0;
 }
+
 .taxonomy-image-control .remove {
 	background-position: -30px 0;
 }
+
 .taxonomy-image-control .remove:hover {
 	background-position: -45px 0;
 }
+
 .taxonomy-image-control .library {
 	background-position: -60px 0;
 }
+
 .taxonomy-image-control .hide {
 	visibility: hidden;
 }
+
 .taxonomy-image-control .show {
 	visibility: visible;
 }
+
+body.taxonomy-images-modal {
+	background: #f1f1f1 !important;
+}

style.css → css/style.css

@@ -1,8 +1,10 @@
+
 .taxonomy-images-the-terms {
 	margin: 10px 0;
 	padding: 0;
 	zoom: 1;
 }
+
 .taxonomy-images-the-terms:before,
 .taxonomy-images-the-terms:after {
 	clear: both;
@@ -11,14 +13,16 @@
 	height: 0;
 	visibility: hidden;
 }
+
 .taxonomy-images-the-terms li,
 .taxonomy-images-the-terms a,
 .taxonomy-images-the-terms img {
-	float:left;
-	margin:0;
-	padding:0;
+	float: left;
+	margin: 0;
+	padding: 0;
 }
+
 .taxonomy-images-the-terms li {
-	list-style-type:none;
-	margin:0 10px 10px 0;
+	list-style-type: none;
+	margin: 0 10px 10px 0;
 }

deprecated.php

@@ -3,23 +3,25 @@
 /**
  * Deprecated Shortcode.
  *
- * @return    void
- * @access    private
+ * @deprecated  Deprecated since version 0.7
+ *
+ * @return  void
+ * @access  private
  */
-function taxonomy_images_plugin_shortcode_deprecated( $atts = array() ) { // DEPRECATED
+function taxonomy_images_plugin_shortcode_deprecated( $atts = array() ) {
 	$o = '';
 	$defaults = array(
 		'taxonomy' => 'category',
 		'size'     => 'detail',
 		'template' => 'list'
-		);
+	);
 
 	extract( shortcode_atts( $defaults, $atts ) );
 
 	/* No taxonomy defined return an html comment. */
 	if ( ! taxonomy_exists( $taxonomy ) ) {
 		$tax = strip_tags( trim( $taxonomy ) );
-		return '<!-- taxonomy_image_plugin error: Taxonomy "' . $taxonomy . '" is not defined.-->';
+		return '<!-- taxonomy_image_plugin error: Taxonomy "' . esc_html( $taxonomy ) . '" is not defined.-->';
 	}
 
 	$terms = get_terms( $taxonomy );
@@ -34,20 +36,19 @@ function taxonomy_images_plugin_shortcode_deprecated( $atts = array() ) { // DEP
 
 			$img = '';
 			if ( array_key_exists( $term->term_taxonomy_id, $associations ) ) {
-				$img = wp_get_attachment_image( $associations[$term->term_taxonomy_id], 'detail', false );
+				$img = wp_get_attachment_image( $associations[ $term->term_taxonomy_id ], 'detail', false );
 			}
 
-			if( $template === 'grid' ) {
-				$o.= "\n\t" . '<div class="taxonomy_image_plugin-' . $template . '">';
-				$o.= "\n\t\t" . '<a style="float:left;" title="' . $title_attr . '" href="' . $url . '">' . $img . '</a>';
-				$o.= "\n\t" . '</div>';
-			}
-			else {
-				$o.= "\n\t\t" . '<a title="' . $title_attr . '" href="' . $url . '">' . $img . '</a>';;
-				$o.= "\n\t\t" . '<h2 style="clear:none;margin-top:0;padding-top:0;line-height:1em;"><a href="' . $url . '">' . $title . '</a></h2>';
-				$o.= $description;
-				$o.= "\n\t" . '<div style="clear:both;height:1.5em"></div>';
-				$o.= "\n";
+			if ( 'grid' == $template ) {
+				$o .= "\n\t" . '<div class="taxonomy_image_plugin-' . $template . '">';
+				$o .= "\n\t\t" . '<a style="float: left;" title="' . $title_attr . '" href="' . $url . '">' . $img . '</a>';
+				$o .= "\n\t" . '</div>';
+			} else {
+				$o .= "\n\t\t" . '<a title="' . $title_attr . '" href="' . $url . '">' . $img . '</a>';;
+				$o .= "\n\t\t" . '<h2 style="clear: none; margin-top: 0; padding-top: 0; line-height: 1em;"><a href="' . $url . '">' . $title . '</a></h2>';
+				$o .= $description;
+				$o .= "\n\t" . '<div style="clear: both; height: 1.5em;"></div>';
+				$o .= "\n";
 			}
 		}
 	}
@@ -61,29 +62,34 @@ function taxonomy_images_plugin_shortcode_deprecated( $atts = array() ) { // DEP
  * of this plugin 0.5 and under. Please do not use any methods or
  * properties directly in your theme.
  *
- * @access     private        This class is deprecated. Do not use!!!
+ * @deprecated  Deprecated since version 0.5
+ * @access      private
  */
 class taxonomy_images_plugin {
+
 	public $settings = array();
+
 	public function __construct() {
 		$this->settings = taxonomy_image_plugin_get_associations();
 		add_action( 'taxonomy_image_plugin_print_image_html', array( &$this, 'print_image_html' ), 1, 3 );
 	}
+
 	public function get_thumb( $id ) {
 		return taxonomy_image_plugin_get_image_src( $id );
 	}
+
 	public function print_image_html( $size = 'medium', $term_tax_id = false, $title = true, $align = 'none' ) {
 		print $this->get_image_html( $size, $term_tax_id, $title, $align );
 	}
+
 	public function get_image_html( $size = 'medium', $term_tax_id = false, $title = true, $align = 'none' ) {
 		$o = '';
 		if ( false === $term_tax_id ) {
 			global $wp_query;
 			$obj = $wp_query->get_queried_object();
 			if ( isset( $obj->term_taxonomy_id ) ) {
 				$term_tax_id = $obj->term_taxonomy_id;
-			}
-			else {
+			} else {
 				return false;
 			}
 		}
@@ -99,5 +105,6 @@ public function get_image_html( $size = 'medium', $term_tax_id = false, $title =
 		}
 		return $o;
 	}
+
 }
 $taxonomy_images_plugin = new taxonomy_images_plugin();

includes/error.php

@@ -0,0 +1,39 @@
+<?php
+
+/**
+ * Taxonomy Images Error
+ *
+ * @package    Taxonomy Images
+ * @author     Ben Huson <ben@thewhiteroom.net>
+ * @copyright  Copyright (c) 2015, Ben Huson
+ * @license    GNU General Public License v2 or later http://www.gnu.org/licenses/gpl-2.0.html
+ * @since      1.0
+ */
+
+class Taxonomy_Images_Error {
+
+	/**
+	 * Error Constructor
+	 *
+	 * @param  string  $error_msg  Error message.
+	 */
+	public function __construct( $error_msg ) {
+
+		if ( $this->debug() ) {
+			trigger_error( $error_msg );
+		}
+
+	}
+
+	/**
+	 * Check if debugging is active.
+	 *
+	 * @return  boolean
+	 */
+	private function debug() {
+
+		return defined( 'WP_DEBUG' ) && WP_DEBUG && apply_filters( 'taxonomy_images_trigger_error', true );
+
+	}
+
+}