wedocs.php

<?php
/*
Plugin Name: DO NOT UPDATE - weDocs
Plugin URI: http://wedevs.com/
Description: A documentation plugin for WordPress
Version: 0.1
Author: Tareq Hasan
Author URI: https://tareq.co/
License: GPL2
Text Domain: wedocs
Domain Path: /languages
*/

/**
 * Copyright (c) 2016 Tareq Hasan (email: tareq@wedevs.com). All rights reserved.
 *
 * Released under the GPL license
 * http://www.opensource.org/licenses/gpl-license.php
 *
 * This is an add-on for WordPress
 * http://wordpress.org/
 *
 * **********************************************************************
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU General Public License as published by
 * the Free Software Foundation; either version 2 of the License, or
 * (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * GNU General Public License for more details.
 *
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 * **********************************************************************
 */

// don't call the file directly
if ( !defined( 'ABSPATH' ) ) exit;

/**
 * WeDocs class
 *
 * @class WeDocs The class that holds the entire WeDocs plugin
 */
class WeDocs {

    public $plugin_url;
    public $plugin_path;
    public $theme_dir_path;

    private $post_type = 'docs';

    /**
     * Initializes the WeDocs() class
     *
     * Checks for an existing WeDocs() instance
     * and if it doesn't find one, creates it.
     */
    public static function init() {
        static $instance = false;

        if ( ! $instance ) {
            $instance = new WeDocs();

            $instance->plugin_init();
        }

        return $instance;
    }

    function plugin_init() {
        $this->theme_dir_path = apply_filters( 'wedocs_theme_dir_path', 'wedocs/' );

        $this->file_includes();

        // Localize our plugin
        add_action( 'init', array( $this, 'localization_setup' ) );

        // custom post types and taxonomies
        add_action( 'init', array( $this, 'register_post_type' ) );
        add_action( 'init', array( $this, 'register_taxonomy' ) );
        add_action( 'init', array( $this, 'register_faq_categories_taxonomy' ) );

        // filter the search result
        add_action( 'pre_get_posts', array( $this, 'docs_search_filter' ) );

        // registeer our widget
        add_action( 'widgets_init', array( $this, 'register_widget' ) );

        // override the theme template
        add_filter( 'template_include', array( $this, 'template_loader' ), 20 );

        // Loads frontend scripts and styles
        add_action( 'wp_enqueue_scripts', array( $this, 'enqueue_scripts' ) );
    }

    /**
     * Load the required files
     *
     * @return void
     */
    function file_includes() {
        include_once dirname( __FILE__ ) . '/includes/functions.php';
        include_once dirname( __FILE__ ) . '/includes/class-walker-docs.php';
        include_once dirname( __FILE__ ) . '/includes/class-search-widget.php';

        if ( is_admin() ) {
            include_once dirname( __FILE__ ) . '/includes/admin/class-admin.php';
        } else {
            include_once dirname( __FILE__ ) . '/includes/class-shortcode.php';
        }

        if ( defined( 'DOING_AJAX' ) && DOING_AJAX ) {
            include_once dirname( __FILE__ ) . '/includes/class-ajax.php';
        }
    }

    /**
     * Initialize plugin for localization
     *
     * @uses load_plugin_textdomain()
     */
    public function localization_setup() {
        load_plugin_textdomain( 'wedocs', false, dirname( plugin_basename( __FILE__ ) ) . '/languages/' );
    }

    /**
     * Enqueue admin scripts
     *
     * Allows plugin assets to be loaded.
     *
     * @uses wp_enqueue_script()
     * @uses wp_localize_script()
     * @uses wp_enqueue_style
     */
    public function enqueue_scripts() {

        /**
         * All styles goes here
         */
        wp_enqueue_style( 'wedocs-styles', plugins_url( 'assets/css/frontend.css', __FILE__ ), false, date( 'Ymd' ) );

        /**
         * All scripts goes here
         */
        wp_enqueue_script( 'wedocs-scripts', plugins_url( 'assets/js/frontend.js', __FILE__ ), array( 'jquery' ), false, true );
        wp_localize_script( 'wedocs-scripts', 'weDocs', array(
            'ajaxurl' => admin_url( 'admin-ajax.php' ),
            'nonce'   => wp_create_nonce( 'wedocs-ajax' )
        ) );
    }

    /**
     * Register the post type
     *
     * @return void
     */
    function register_post_type() {

        $labels = array(
            'name'                => _x( 'Docs', 'Post Type General Name', 'wedocs' ),
            'singular_name'       => _x( 'Doc', 'Post Type Singular Name', 'wedocs' ),
            'menu_name'           => __( 'Documentation', 'wedocs' ),
            'parent_item_colon'   => __( 'Parent Doc', 'wedocs' ),
            'all_items'           => __( 'All Documentations', 'wedocs' ),
            'view_item'           => __( 'View Documentation', 'wedocs' ),
            'add_new_item'        => __( 'Add Documentation', 'wedocs' ),
            'add_new'             => __( 'Add New', 'wedocs' ),
            'edit_item'           => __( 'Edit Documentation', 'wedocs' ),
            'update_item'         => __( 'Update Documentation', 'wedocs' ),
            'search_items'        => __( 'Search Documentation', 'wedocs' ),
            'not_found'           => __( 'Not documentation found', 'wedocs' ),
            'not_found_in_trash'  => __( 'Not found in Trash', 'wedocs' ),
        );
        $rewrite = array(
            'slug'                => 'docs',
            'with_front'          => true,
            'pages'               => true,
            'feeds'               => true,
        );
        $args = array(
            'labels'              => $labels,
            'supports'            => array( 'title', 'editor', 'thumbnail', 'revisions', ),
            'hierarchical'        => true,
            'public'              => true,
            'show_ui'             => true,
            'show_in_menu'        => false,
            'show_in_nav_menus'   => true,
            'show_in_admin_bar'   => true,
            'menu_position'       => 5,
            'menu_icon'           => 'dashicons-portfolio',
            'can_export'          => true,
            'has_archive'         => true,
            'exclude_from_search' => false,
            'publicly_queryable'  => true,
            'rewrite'             => $rewrite,
            'capability_type'     => 'page',
        );

        register_post_type( $this->post_type, $args );
    }

    /**
     * Register doc tags taxonomy
     *
     * @return void
     */
    function register_taxonomy() {

        $labels = array(
            'name'                       => _x( 'Tags', 'Taxonomy General Name', 'wedocs' ),
            'singular_name'              => _x( 'Tag', 'Taxonomy Singular Name', 'wedocs' ),
            'menu_name'                  => __( 'Tags', 'wedocs' ),
            'all_items'                  => __( 'All Tags', 'wedocs' ),
            'parent_item'                => __( 'Parent Tag', 'wedocs' ),
            'parent_item_colon'          => __( 'Parent Tag:', 'wedocs' ),
            'new_item_name'              => __( 'New Tag Tag', 'wedocs' ),
            'add_new_item'               => __( 'Add New Item', 'wedocs' ),
            'edit_item'                  => __( 'Edit Tag', 'wedocs' ),
            'update_item'                => __( 'Update Tag', 'wedocs' ),
            'view_item'                  => __( 'View Tag', 'wedocs' ),
            'separate_items_with_commas' => __( 'Separate items with commas', 'wedocs' ),
            'add_or_remove_items'        => __( 'Add or remove items', 'wedocs' ),
            'choose_from_most_used'      => __( 'Choose from the most used', 'wedocs' ),
            'popular_items'              => __( 'Popular Tags', 'wedocs' ),
            'search_items'               => __( 'Search Tags', 'wedocs' ),
            'not_found'                  => __( 'Not Found', 'wedocs' ),
            'no_terms'                   => __( 'No items', 'wedocs' ),
            'items_list'                 => __( 'Tags list', 'wedocs' ),
            'items_list_navigation'      => __( 'Tags list navigation', 'wedocs' ),
        );

        $rewrite = array(
            'slug'                       => 'doc-tag',
            'with_front'                 => true,
            'hierarchical'               => false,
        );

        $args = array(
            'labels'                     => $labels,
            'hierarchical'               => false,
            'public'                     => true,
            'show_ui'                    => true,
            'show_admin_column'          => true,
            'show_in_nav_menus'          => true,
            'show_tagcloud'              => true,
            'rewrite'                    => $rewrite
        );

        register_taxonomy( 'doc_tag', array( 'docs' ), $args );
    }

	/**
	 * Register FAQ categories taxonomy.
	 *
	 * @author Vova Feldman
	 *
	 * @return void
	 */
	function register_faq_categories_taxonomy(){
		$labels = array(
			'name'                       => _x( 'Categories', 'Taxonomy General Name', 'freemius' ),
			'singular_name'              => _x( 'Category', 'Taxonomy Singular Name', 'freemius' ),
			'menu_name'                  => __( 'Categories', 'freemius' ),
			'all_items'                  => __( 'All Categories', 'freemius' ),
			'parent_item'                => __( 'Parent Category', 'freemius' ),
			'parent_item_colon'          => __( 'Parent Category:', 'freemius' ),
			'new_item_name'              => __( 'New Category Name', 'freemius' ),
			'add_new_item'               => __( 'Add New Category', 'freemius' ),
			'edit_item'                  => __( 'Edit Category', 'freemius' ),
			'update_item'                => __( 'Update Category', 'freemius' ),
			'separate_items_with_commas' => __( 'Separate categories with commas', 'freemius' ),
			'search_items'               => __( 'Search Categories', 'freemius' ),
			'add_or_remove_items'        => __( 'Add or remove categories', 'freemius' ),
			'choose_from_most_used'      => __( 'Choose from the most used categories', 'freemius' ),
			'not_found'                  => __( 'Not Found', 'freemius' ),
		);

		$rewrite = array(
			'slug'         => 'help/faq',
			'with_front'   => true,
			'hierarchical' => false,
		);


		$args = array(
			'labels'            => $labels,
			'hierarchical'      => true,
			'public'            => true,
			'show_ui'           => true,
			'show_admin_column' => true,
			'show_in_nav_menus' => true,
			'show_tagcloud'     => false,
			'rewrite'           => $rewrite
		);

		register_taxonomy( 'doc_category', array( 'docs' ), $args );
	}

    /**
     * Register the search widget
     *
     * @return void
     */
    public function register_widget() {
        register_widget( 'WeDocs_Search_Widget' );
    }

    /**
     * Get the plugin url.
     *
     * @access public
     * @return string
     */
    public function plugin_url() {
        if ( $this->plugin_url ) {
            return $this->plugin_url;
        }

        return $this->plugin_url = untrailingslashit( plugins_url( '/', __FILE__ ) );
    }


    /**
     * Get the plugin path.
     *
     * @access public
     * @return string
     */
    public function plugin_path() {
        if ( $this->plugin_path ) return $this->plugin_path;

        return $this->plugin_path = untrailingslashit( plugin_dir_path( __FILE__ ) );
    }

    /**
     * Get the template path.
     *
     * @access public
     * @return string
     */
    public function template_path() {
        return $this->plugin_path() . '/templates/';
    }

    /**
     * If the theme doesn't have any single doc handler, load that from
     * the plugin
     *
     * @param  string  $template
     *
     * @return string
     */
    function template_loader( $template ) {
        $find = array( $this->post_type . '.php' );
        $file = '';

        if ( is_single() && get_post_type() == $this->post_type ) {
            $file   = 'single-' . $this->post_type . '.php';
            $find[] = $file;
            $find[] = $this->theme_dir_path. $file;
        }

        if ( $file ) {

            $template = locate_template( $find );

            if ( ! $template ) {
                $template = $this->template_path() . $file;
            }
        }

        return $template;
    }

    /**
     * Handle the search filtering in search page
     *
     * @param  \WP_Query  $query
     *
     * @return \WP_Query
     */
    function docs_search_filter( $query ) {

        if ( ! is_admin() && is_search() && $query->is_main_query() ) {
            $param = isset( $_GET['search_in_doc'] ) ? sanitize_text_field( $_GET['search_in_doc'] ) : false;

            if ( $param ) {

                if ( $param != 'all' ) {
                    $parent_doc_id = intval( $param );
                    $post__in      = array( $parent_doc_id => $parent_doc_id );
                    $children_docs = wedocs_get_posts_children( $parent_doc_id, 'docs' );

                    if ( $children_docs ) {
                        $post__in = array_merge( $post__in, wp_list_pluck( $children_docs, 'ID' ) );
                    }

                    $query->set( 'post__in', $post__in );
                }
            }
        }

        return $query;
    }

	/**
	 * Flush rewrites.
	 */
	public static function activation() {
		wedocs()->register_post_type();
		wedocs()->register_taxonomy();
		wedocs()->register_faq_categories_taxonomy();

		$category_all = get_term_by( 'slug', 'all', 'doc_category' );

		// Create All category if not yet exist.
		if ( false === $category_all ) {
			wp_insert_term(
				__( 'All', 'wedocs' ),
				'doc_category',
				array(
					'slug' => 'all',
				)
			);
		}

	}


} // WeDocs

/**
 * Initialize the plugin
 *
 * @return \WeDocs
 */
function wedocs() {
    return WeDocs::init();
}

// kick it off
wedocs();

register_activation_hook( __FILE__, array( 'WeDocs', 'activation' ) );