Defined (1)

The class is defined in the following location(s).

/lib/tags.php  

class nggTags { 
 
    /** 
     * Copy tags 
     */ 
    static function copy_tags($src_pid, $dest_pid) { 
        $tags = wp_get_object_terms( $src_pid, 'ngg_tag', 'fields=ids' ); 
        $tags = array_map('intval', $tags); 
        wp_set_object_terms( $dest_pid, $tags, 'ngg_tag', true ); 
 
        return implode(', ', $tags); 
    } 
 
    /** 
     * Rename tags 
     */ 
    static function rename_tags($old = '', $new = '') { 
 
        $return_value = array( 
            'status' => 'ok',  
            'message' => '' 
 ); 
 
        if ( trim( str_replace(', ', '', stripslashes($new)) ) == '' ) { 
            $return_value['message'] = __('No new tag specified!', 'nggallery'); 
            $return_value['status'] = 'error'; 
            return $return_value; 
        } 
 
        // String to array 
        $old_tags = explode(', ', $old); 
        $new_tags = explode(', ', $new); 
 
        // Remove empty element and trim 
        $old_tags = array_filter($old_tags, 'nggtags_delete_empty_element'); 
        $new_tags = array_filter($new_tags, 'nggtags_delete_empty_element'); 
 
        // If old/new tag are empty => exit ! 
        if ( empty($old_tags) || empty($new_tags) ) { 
            $return_value['message'] = __('No new/old valid tag specified!', 'nggallery'); 
            $return_value['status'] = 'error'; 
            return $return_value; 
        } 
 
        $counter = 0; 
        if( count($old_tags) == count($new_tags) ) { // Rename only 
            foreach ( (array) $old_tags as $i => $old_tag ) { 
                $new_name = $new_tags[$i]; 
 
                // Get term by name 
                $term = get_term_by('name', $old_tag, 'ngg_tag'); 
                if ( !$term ) { 
                    continue; 
                } 
 
                // Get objects from term ID 
                $objects_id = get_objects_in_term( $term->term_id, 'ngg_tag', array('fields' => 'all_with_object_id')); 
 
                // Delete old term 
                wp_delete_term( $term->term_id, 'ngg_tag' ); 
 
                // Set objects to new term ! (Append no replace) 
                foreach ( (array) $objects_id as $object_id ) { 
                    wp_set_object_terms( $object_id, $new_name, 'ngg_tag', true ); 
                } 
 
                // Clean cache 
                clean_object_term_cache( $objects_id, 'ngg_tag'); 
                clean_term_cache($term->term_id, 'ngg_tag'); 
 
                // Increment 
                $counter++; 
            } 
 
            if ( $counter == 0 ) { 
                $return_value['message'] = __('No tag renamed.', 'nggallery'); 
            } else { 
                $return_value['message'] = sprintf(__('Renamed tag(s) «%1$s» to «%2$s»', 'nggallery'), $old, $new); 
            } 
        } 
        elseif ( count($new_tags) == 1 ) { // Merge 
            // Set new tag 
            $new_tag = $new_tags[0]; 
            if ( empty($new_tag) ) { 
                $return_value['message'] = __('No valid new tag.', 'nggallery'); 
                $return_value['status'] = 'error'; 
                return $return_value; 
            } 
 
            // Get terms ID from old terms names 
            $terms_id = array(); 
            foreach ( (array) $old_tags as $old_tag ) { 
                $term = get_term_by('name', addslashes($old_tag), 'ngg_tag'); 
                $terms_id[] = (int) $term->term_id; 
            } 
 
            // Get objects from terms ID 
            $objects_id = get_objects_in_term( $terms_id, 'ngg_tag', array('fields' => 'all_with_object_id')); 
 
            // No objects ? exit ! 
            if ( !$objects_id ) { 
                $return_value['message'] = __('No objects (post/page) found for specified old tags.', 'nggallery'); 
                $return_value['status'] = 'error'; 
                return $return_value; 
            } 
 
            // Delete old terms 
            foreach ( (array) $terms_id as $term_id ) { 
                wp_delete_term( $term_id, 'ngg_tag' ); 
            } 
 
            // Set objects to new term ! (Append no replace) 
            foreach ( (array) $objects_id as $object_id ) { 
                wp_set_object_terms( $object_id, $new_tag, 'ngg_tag', true ); 
                $counter++; 
            } 
 
            // Test if term is also a category 
            if ( term_exists($new_tag, 'category') ) { 
                // Edit the slug to use the new term 
                $slug = sanitize_title($new_tag); 
                nggTags::edit_tag_slug( $new_tag, $slug ); 
                unset($slug); 
            } 
 
            // Clean cache 
            clean_object_term_cache( $objects_id, 'ngg_tag'); 
            clean_term_cache($terms_id, 'ngg_tag'); 
 
            if ( $counter == 0 ) { 
                $return_value['message'] = __('No tag merged.', 'nggallery'); 
            } else { 
                $return_value['message'] = sprintf(__('Merge tag(s) «%1$s» to «%2$s». %3$s objects edited.', 'nggallery'), $old, $new, $counter); 
            } 
        } else { // Error 
            $return_value['message'] = sprintf(__('Error. No enough tags for rename. Too for merge. Choose !', 'nggallery'), $old); 
            $return_value['status'] = 'error'; 
        } 
 
        return $return_value; 
    } 
 
    /** 
     * Delete tags 
     */ 
    static function delete_tags($delete) { 
        $return_value = array( 
            'status' => 'ok',  
            'message' => '' 
 ); 
 
        if ( trim( str_replace(', ', '', stripslashes($delete)) ) == '' ) { 
            $return_value['message'] = __('No tag specified!', 'nggallery'); 
            $return_value['status'] = 'error'; 
            return $return_value; 
        } 
 
        // In array + filter 
        $delete_tags = explode(', ', $delete); 
        $delete_tags = array_filter($delete_tags, 'nggtags_delete_empty_element'); 
 
        // Delete tags 
        $counter = 0; 
        foreach ( (array) $delete_tags as $tag ) { 
            $term = get_term_by('name', $tag, 'ngg_tag'); 
            $term_id = (int) $term->term_id; 
 
            if ( $term_id != 0 ) { 
                wp_delete_term( $term_id, 'ngg_tag'); 
                clean_term_cache( $term_id, 'ngg_tag'); 
                $counter++; 
            } 
        } 
 
        if ( $counter == 0 ) { 
            $return_value['message'] = __('No tag deleted.', 'nggallery'); 
        } else { 
            $return_value['message'] = sprintf(__('%1s tag(s) deleted.', 'nggallery'), $counter); 
        } 
    } 
 
    /** 
     * Edit tag slug given the name of the tag 
     */ 
    static function edit_tag_slug( $names = '', $slugs = '' ) { 
        $return_value = array( 
            'status' => 'ok',  
            'message' => '' 
 ); 
 
        if ( trim( str_replace(', ', '', stripslashes($slugs)) ) == '' ) { 
            $return_value['message'] = __('No new slug(s) specified!', 'nggallery'); 
            $return_value['status'] = 'error'; 
            return $return_value; 
        } 
 
        $match_names = explode(', ', $names); 
        $new_slugs = explode(', ', $slugs); 
 
        $match_names = array_filter($match_names, 'nggtags_delete_empty_element'); 
        $new_slugs = array_filter($new_slugs, 'nggtags_delete_empty_element'); 
 
        if ( count($match_names) != count($new_slugs) ) { 
            $return_value['message'] = __('Tags number and slugs number isn\'t the same!', 'nggallery'); 
            $return_value['status'] = 'error'; 
            return $return_value; 
        } else { 
            $counter = 0; 
            foreach ( (array) $match_names as $i => $match_name ) { 
                // Sanitize slug + Escape 
                $new_slug = sanitize_title($new_slugs[$i]); 
 
                // Get term by name 
                $term = get_term_by('name', $match_name, 'ngg_tag'); 
                if ( !$term ) { 
                    continue; 
                } 
 
                // Increment 
                $counter++; 
 
                // Update term 
                wp_update_term($term->term_id, 'ngg_tag', array('slug' => $new_slug)); 
 
                // Clean cache 
                clean_term_cache($term->term_id, 'ngg_tag'); 
            } 
        } 
 
        if ( $counter == 0 ) { 
            $return_value['message'] = __('No slug edited.', 'nggallery'); 
        } else { 
            $return_value['message'] = sprintf(__('%s slug(s) edited.', 'nggallery'), $counter); 
        } 
 
        return $return_value; 
    } 
 
    /** 
     * @param $taglist 
     * @return mixed|string 
     * Sanitize tag list suppressing spaces, sanitizing every tag and solving issues 
     * with unicode support. 
     * 20140605: '%' character does not pass through sanitize_title 
     * Note: this list cannot be handled with wpdb->prepare since single quotes 
     * will be escaped(!) 
     */ 
    public static function sanitize_taglist($taglist) 
    { 
        // extract it into a array 
        $taglist = explode(", ", $taglist); 
        //if we don't have a list, make an array with one item 
        if (!is_array($taglist)) 
            $taglist = array($taglist); 
        //suppress spaces in all terms on the list. 
        $taglist = array_map('trim', $taglist); 
        //and sanitize every term 
        $new_slugarray = array_map('sanitize_title', $taglist); 
        //recompose list of terms and make one simple string 
        $sluglist = implode("', '", $new_slugarray); 
        if (empty($sluglist)) return ""; 
        //Treat % as a literal in the database, for unicode support 
      //  $sluglist = str_replace("%", "%%", $sluglist); 
        return "'" . $sluglist . "'"; 
    } 
 
    /** 
     * Get a list of the tags used by the images 
     */ 
    function find_all_tags() { 
        return get_terms('ngg_tag', ''); 
    } 
 
    /** 
     * 20131004: corrected to static to avoid error over strict standards 
     */ 
    static function find_tags( $args = '', $skip_cache = false ) { 
        $taxonomy = 'ngg_tag'; 
 
        if ( $skip_cache == true ) { 
            $terms = get_terms( $taxonomy, $args ); 
        } else { 
            $key = md5(serialize($args)); 
 
            // Get cache if exist 
            //-- 
            if ( $cache = wp_cache_get( 'ngg_get_tags', 'nggallery' ) ) { 
                if ( isset( $cache[$key] ) ) { 
                    return apply_filters('get_tags', $cache[$key], $args); 
                } 
            } 
 
            // Get tags 
            //-- 
            $terms = get_terms( $taxonomy, $args ); 
            if ( empty($terms) ) { 
                return array(); 
            } 
 
            $cache[$key] = $terms; 
            wp_cache_set( 'ngg_get_tags', $cache, 'nggallery' ); 
        } 
 
        $terms = apply_filters('get_tags', $terms, $args); 
        return $terms; 
    } 
 
    /** 
    * Get images corresponding to a list of tags 
    */ 
    /** 
     * nggTags::find_images_for_tags() 
     * 20140120: Mode DESC added. 
     * 20140611:Dropped use of wpdb->prepare since single quotes are scaped. 
     * @param mixed $taglist 
     * @param string $sorting could be 'ASC' or 'RAND' or 'DESC' 
     * @return array of images 
     */ 
    static function find_images_for_tags($taglist, $sorting = "ASC") { 
        // return the images based on the tag 
        global $wpdb; 
        $modes = array ('ASC', 'DESC', 'RAND'); 
        //Sanitize & standarize list 
        $sluglist = self::sanitize_taglist($taglist); 
 
        // first get all $term_ids with this tag 
        //Fix for WP 3.9 . See http://make.wordpress.org/core/2012/12/12/php-warning-missing-argument-2-for-wpdb-prepare/ 
        $prepared = "SELECT term_id FROM $wpdb->terms WHERE slug IN ($sluglist) ORDER BY term_id ASC "; 
        $term_ids = $wpdb->get_col( $prepared ); 
        //Get the objects related with the taxonomy defined by NextCellent 
        $picids = get_objects_in_term($term_ids, 'ngg_tag'); 
 
        //Now lookup in the database 
        $sorting = in_array($sorting, $modes)?$sorting:'ASC'; 
        $pictures = nggdb::find_images_in_list($picids, true, $sorting ); 
        return $pictures; 
    } 
 
    /** 
    * Return one image based on the tag. Required for a tag based album overview 
    */ 
    static function get_album_images($taglist) { 
        global $wpdb; 
 
        $taxonomy = 'ngg_tag'; 
 
        // extract it into a array 
        $taglist = explode(', ', $taglist); 
 
        if (!is_array($taglist)) { 
            $taglist = array($taglist); 
        } 
 
        $taglist = array_map('trim', $taglist); 
        $slugarray = array_map('sanitize_title', $taglist); 
        $slugarray = array_unique($slugarray); 
 
        $picarray = array(); 
 
        foreach($slugarray as $slug) { 
            // get random picture of tag 
            $tsql = "SELECT p.*, g.*, t.*, tt.* FROM $wpdb->term_relationships AS tr"; 
            $tsql .= " INNER JOIN $wpdb->nggpictures AS p ON (tr.object_id = p.pid)"; 
            $tsql .= " INNER JOIN $wpdb->nggallery AS g ON (g.gid = p.galleryid)"; 
            $tsql .= " INNER JOIN $wpdb->term_taxonomy AS tt ON (tr.term_taxonomy_id = tt.term_taxonomy_id)"; 
            $tsql .= " INNER JOIN $wpdb->terms AS t ON (tt.term_id = t.term_id)"; 
            $tsql .= " WHERE tt.taxonomy = '$taxonomy' AND t.slug = '$slug' ORDER BY rand() limit 1 "; 
            $pic_data = $wpdb->get_row($tsql, OBJECT); 
 
            if ($pic_data) $picarray[] = $pic_data; 
        } 
 
        return $picarray; 
    } 
}