GFPDFRouter

The Gravity PDF GFPDF Router class.

Defined (1)

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

/src/bootstrap.php  
  1. class Router implements Helper\Helper_Interface_Actions, Helper\Helper_Interface_Filters { 
  2.  
  3.     /** 
  4.      * Holds our log class 
  5.      * 
  6.      * @var \Monolog\Logger 
  7.      * 
  8.      * @since 4.0 
  9.      */ 
  10.     public $log; 
  11.  
  12.     /** 
  13.      * Holds the abstracted Gravity Forms API specific to Gravity PDF 
  14.      * 
  15.      * @var \GFPDF\Helper\Helper_Form 
  16.      * 
  17.      * @since 4.0 
  18.      */ 
  19.     public $gform; 
  20.  
  21.     /** 
  22.      * Holds our Helper_Notices object 
  23.      * which we can use to queue up admin messages for the user 
  24.      * 
  25.      * @var \GFPDF\Helper\Helper_Notices 
  26.      * 
  27.      * @since 4.0 
  28.      */ 
  29.     public $notices; 
  30.  
  31.     /** 
  32.      * Holds our Helper_Data object 
  33.      * which we can autoload with any data needed 
  34.      * 
  35.      * @var \GFPDF\Helper\Helper_Data 
  36.      * 
  37.      * @since 4.0 
  38.      */ 
  39.     public $data; 
  40.  
  41.     /** 
  42.      * Holds our Helper_Abstract_Options / Helper_Options_Fields object 
  43.      * Makes it easy to access global PDF settings and individual form PDF settings 
  44.      * 
  45.      * @var \GFPDF\Helper\Helper_Options_Fields 
  46.      * 
  47.      * @since 4.0 
  48.      */ 
  49.     public $options; 
  50.  
  51.     /** 
  52.      * Holds our Helper_Misc object 
  53.      * Makes it easy to access common methods throughout the plugin 
  54.      * 
  55.      * @var \GFPDF\Helper\Helper_Misc 
  56.      * 
  57.      * @since 4.0 
  58.      */ 
  59.     public $misc; 
  60.  
  61.     /** 
  62.      * Holds our Helper_Templates object 
  63.      * used to ease access to our PDF templates 
  64.      * 
  65.      * @var \GFPDF\Helper\Helper_Templates 
  66.      * 
  67.      * @since 4.0 
  68.      */ 
  69.     public $templates; 
  70.  
  71.     /** 
  72.      * Makes our MVC classes sudo-singletons by allowing easy access to the original objects 
  73.      * through `$singleton->get_class();` 
  74.      * 
  75.      * @var \GFPDF\Helper\Helper_Singleton 
  76.      * 
  77.      * @since 4.0 
  78.      */ 
  79.     public $singleton; 
  80.  
  81.     /** 
  82.      * Add user depreciation notice for any methods not included in current object 
  83.      * 
  84.      * @param string $name      The function name to be called 
  85.      * @param array  $arguments An enumerated array containing the parameters passed to the $name'ed method 
  86.      * 
  87.      * @since 4.0 
  88.      */ 
  89.     public function __call( $name, $arguments ) { 
  90.         trigger_error( sprintf( esc_html__( '"%s" has been deprecated as of Gravity PDF 4.0', 'gravity-forms-pdf-extended' ), $name ), E_USER_DEPRECATED ); 
  91.     } 
  92.  
  93.     /** 
  94.      * Add user depreciation notice for any methods not included in current object 
  95.      * 
  96.      * @param string $name      The function name to be called 
  97.      * @param array  $arguments An enumerated array containing the parameters passed to the $name'ed method 
  98.      * 
  99.      * @since  4.0 
  100.      */ 
  101.     public static function __callStatic( $name, $arguments ) { 
  102.         trigger_error( sprintf( esc_html__( '"%s" has been deprecated as of Gravity PDF 4.0', 'gravity-forms-pdf-extended' ), $name ), E_USER_DEPRECATED ); 
  103.     } 
  104.  
  105.     /** 
  106.      * Fired on the `after_setup_theme` action to initialise our plugin 
  107.      * 
  108.      * We do this on this hook instead of plugins_loaded so that users can tap into all our actions and filters 
  109.      * directly from their theme (usually the functions.php file). 
  110.      * 
  111.      * @since 4.0 
  112.      */ 
  113.     public static function initialise_plugin() { 
  114.  
  115.         global $gfpdf; 
  116.  
  117.         /** Initialise our Router class */ 
  118.         $gfpdf = new Router(); 
  119.         $gfpdf->init(); 
  120.  
  121.         /** Add backwards compatibility support */ 
  122.         $deprecated = new GFPDF_Core(); 
  123.         $deprecated->setup_constants(); 
  124.         $deprecated->setup_deprecated_paths(); 
  125.     } 
  126.  
  127.     /** 
  128.      * Setup our plugin functionality 
  129.      * Note: This method runs during the `after_setup_theme` action 
  130.      * 
  131.      * @since 4.0 
  132.      */ 
  133.     public function init() { 
  134.  
  135.         /** Set up our logger is not running via CLI (unit testing) */ 
  136.         $this->setup_logger(); 
  137.  
  138.         /** Set up our form object */ 
  139.         $this->gform = new Helper\Helper_Form(); 
  140.  
  141.         /** Set up our data access layer */ 
  142.         $this->data = new Helper\Helper_Data(); 
  143.         $this->data->init(); 
  144.  
  145.         /** Set up our misc object */ 
  146.         $this->misc = new Helper\Helper_Misc( $this->log, $this->gform, $this->data ); 
  147.  
  148.         /** Set up our notices */ 
  149.         $this->notices = new Helper\Helper_Notices(); 
  150.         $this->notices->init(); 
  151.  
  152.         /** Setup our template helper */ 
  153.         $this->templates = new Helper\Helper_Templates( $this->log, $this->data ); 
  154.  
  155.         /** Set up our options object - this is initialised on admin_init but other classes need to access its methods before this */ 
  156.         $this->options = new Helper\Helper_Options_Fields( 
  157.             $this->log,  
  158.             $this->gform,  
  159.             $this->data,  
  160.             $this->misc,  
  161.             $this->notices,  
  162.             $this->templates 
  163.  ); 
  164.  
  165.         /** Setup our Singleton object */ 
  166.         $this->singleton = new Helper\Helper_Singleton(); 
  167.  
  168.         /** Load modules */ 
  169.         $this->installer(); 
  170.         $this->welcome_screen(); 
  171.         $this->gf_settings(); 
  172.         $this->gf_form_settings(); 
  173.         $this->pdf(); 
  174.         $this->shortcodes(); 
  175.         $this->mergetags(); 
  176.         $this->actions(); 
  177.         $this->template_manager(); 
  178.  
  179.         /** Add localisation support */ 
  180.         $this->add_localization_support(); 
  181.  
  182.         /** 
  183.          * Run generic actions and filters needed to get the plugin functional 
  184.          * The controllers will set more specific actions / filters as needed 
  185.          */ 
  186.         $this->add_actions(); 
  187.         $this->add_filters(); 
  188.  
  189.         /** 
  190.          * Trigger action to signify Gravity PDF is now loaded 
  191.          * 
  192.          * See https://gravitypdf.com/documentation/v4/gfpdf_fully_loaded/ for more details about this action 
  193.          */ 
  194.         do_action( 'gfpdf_fully_loaded', $this ); 
  195.  
  196.     } 
  197.  
  198.     /** 
  199.      * Add required plugin actions 
  200.      * 
  201.      * @since 4.0 
  202.      * 
  203.      * @return void 
  204.      */ 
  205.     public function add_actions() { 
  206.  
  207.         add_action( 'init', [ $this, 'register_assets' ] ); 
  208.         add_action( 'admin_enqueue_scripts', [ $this, 'load_admin_assets' ] ); 
  209.  
  210.         /** Cache our Gravity PDF Settings and register our settings fields with the Options API */ 
  211.         add_action( 'init', [ $this, 'init_settings_api' ], 1 ); 
  212.         add_action( 'admin_init', [ $this, 'setup_settings_fields' ], 1 ); 
  213.     } 
  214.  
  215.     /** 
  216.      * Add required plugin filters 
  217.      * 
  218.      * @since 4.0 
  219.      * 
  220.      * @return void 
  221.      */ 
  222.     public function add_filters() { 
  223.  
  224.         /** Automatically handle GF noconflict mode */ 
  225.         add_filter( 'gform_noconflict_scripts', [ $this, 'auto_noconflict_scripts' ] ); 
  226.         add_filter( 'gform_noconflict_styles', [ $this, 'auto_noconflict_styles' ] ); 
  227.  
  228.         /** Enable Gravity Forms Logging */ 
  229.         add_filter( 'gform_logging_supported', [ $this, 'add_gf_logger' ] ); 
  230.  
  231.         /** Add quick links on the plugins page */ 
  232.         add_filter( 'plugin_action_links_' . PDF_PLUGIN_BASENAME, [ $this, 'plugin_action_links' ] ); 
  233.         add_filter( 'plugin_row_meta', [ $this, 'plugin_row_meta' ], 10, 2 ); 
  234.  
  235.         /** Add class when on Gravity PDF pages */ 
  236.         add_filter( 'admin_body_class', [ $this, 'add_body_class' ] ); 
  237.     } 
  238.  
  239.  
  240.     /** 
  241.      * Setup WordPress localization support 
  242.      * 
  243.      * @since 4.0 
  244.      */ 
  245.     private function add_localization_support() { 
  246.         load_plugin_textdomain( 'gravity-forms-pdf-extended', false, dirname( plugin_basename( __FILE__ ) ) . '/assets/languages/' ); 
  247.     } 
  248.  
  249.     /** 
  250.      * Initialise our logging class (we're using Monolog instead of Gravity Form's KLogger) 
  251.      * and set up appropriate handlers based on the logger settings 
  252.      * 
  253.      * @return void 
  254.      * 
  255.      * @since 4.0 
  256.      */ 
  257.     public function setup_logger() { 
  258.  
  259.         /** Initialise our logger */ 
  260.         $this->log = new Logger( 'gravitypdf' ); 
  261.  
  262.         /** Setup our Gravity Forms local file logger, if enabled */ 
  263.         $this->setup_gravityforms_logging(); 
  264.  
  265.         /** Check if we have a handler pushed and add our Introspection and Memory Peak usage processors */ 
  266.         if ( sizeof( $this->log->getHandlers() ) > 0 && substr( php_sapi_name(), 0, 3 ) !== 'cli' ) { 
  267.             $this->log->pushProcessor( new IntrospectionProcessor ); 
  268.             $this->log->pushProcessor( new MemoryPeakUsageProcessor ); 
  269.         } else { 
  270.             /** Disable logging if using CLI, or if Gravity Forms logging isn't enabled */ 
  271.             $this->log->pushHandler( new NullHandler( Logger::INFO ) ); /** throw logs away */ 
  272.         } 
  273.     } 
  274.  
  275.     /** 
  276.      * Setup Gravity Forms logging, if currently enabled by the user 
  277.      * 
  278.      * @return void 
  279.      * 
  280.      * @since 4.0 
  281.      */ 
  282.     private function setup_gravityforms_logging() { 
  283.  
  284.         /** Check if Gravity Forms logging is enabled and push stream logging */ 
  285.         if ( class_exists( 'GFLogging' ) ) { 
  286.  
  287.             /** 
  288.              * Get the current plugin logger settings and check if it's enabled 
  289.              * The new version of the logger uses the add-on storage method, while the old one stores it in gf_logging_settings 
  290.              * so we'll test which settings we should use and get the appropriate log level 
  291.              */ 
  292.             if ( ! get_option( 'gform_enable_logging' ) && ( ! defined( 'GF_LOGGING_VERSION' ) || version_compare( GF_LOGGING_VERSION, '1.1', '<' ) ) ) { 
  293.                 $settings = get_option( 'gf_logging_settings' ); 
  294.                 $log_level = (int) rgar( $settings, 'gravity-pdf' ); 
  295.                 $log_filename = GFFormsModel::get_upload_root() . 'logs/gravity-pdf.txt'; 
  296.             } else { 
  297.                 $gf_logger = GFLogging::get_instance(); 
  298.                 $gf_logger_settings = $gf_logger->get_plugin_settings(); 
  299.                 $log_level = ( isset( $gf_logger_settings['gravity-pdf']['log_level'] ) ) ? (int) $gf_logger_settings['gravity-pdf']['log_level'] : 0; 
  300.                 $log_filename = ( get_option( 'gform_enable_logging' ) ) ? $gf_logger->get_log_file_name( 'gravity-pdf' ) : $gf_logger::get_log_file_name( 'gravity-pdf' ); 
  301.             } 
  302.  
  303.             /** Enable logging if not equivalent to empty (0) and not level 6 (which is apprently off in GF world) */ 
  304.             if ( ! empty( $log_level ) && $log_level !== 6 ) { 
  305.  
  306.                 /** Convert Gravity Forms log levels to the appropriate Monolog level */ 
  307.                 $monolog_level = ( $log_level === 4 ) ? Logger::ERROR : Logger::INFO; 
  308.  
  309.                 /** Setup our stream and change the format to more-suit Gravity Forms */ 
  310.                 $formatter = new LineFormatter( "%datetime% - %level_name% --> %message% %context% %extra%<br>\n" ); 
  311.                 $stream = new StreamHandler( $log_filename, $monolog_level ); 
  312.                 $stream->setFormatter( $formatter ); 
  313.  
  314.                 /** Add our log file stream */ 
  315.                 $this->log->pushHandler( $stream ); 
  316.             } 
  317.         } 
  318.     } 
  319.  
  320.     /** 
  321.      * Show action links on the plugin screen. 
  322.      * 
  323.      * @param    mixed $links Plugin Action links 
  324.      * 
  325.      * @return    array 
  326.      * 
  327.      * @since 4.0 
  328.      */ 
  329.     public function plugin_action_links( $links ) { 
  330.  
  331.         $action_links = [ 
  332.             'settings' => '<a href="' . esc_url( $this->data->settings_url ) . '" title="' . esc_attr__( 'View Gravity PDF Settings', 'gravity-forms-pdf-extended' ) . '">' . esc_html__( 'Settings', 'gravity-forms-pdf-extended' ) . '</a>',  
  333.  ]; 
  334.  
  335.         return array_merge( $action_links, $links ); 
  336.     } 
  337.  
  338.     /** 
  339.      * Show row meta on the plugin screen. 
  340.      * 
  341.      * @param    mixed $links Plugin Row Meta 
  342.      * @param    mixed $file  Plugin Base file 
  343.      * 
  344.      * @return    array 
  345.      * 
  346.      * @since  4.0 
  347.      */ 
  348.     public function plugin_row_meta( $links, $file ) { 
  349.  
  350.         if ( $file == PDF_PLUGIN_BASENAME ) { 
  351.             $row_meta = [ 
  352.                 'docs' => '<a href="' . esc_url( 'https://gravitypdf.com/documentation/v4/five-minute-install/' ) . '" title="' . esc_attr__( 'View Gravity PDF Documentation', 'gravity-forms-pdf-extended' ) . '">' . esc_html__( 'Docs', 'gravity-forms-pdf-extended' ) . '</a>',  
  353.                 'support' => '<a href="' . esc_url( $this->data->settings_url . '&tab=help' ) . '" title="' . esc_attr__( 'Get Help and Support', 'gravity-forms-pdf-extended' ) . '">' . esc_html__( 'Support', 'gravity-forms-pdf-extended' ) . '</a>',  
  354.                 'shop' => '<a href="' . esc_url( 'https://gravitypdf.com/shop/' ) . '" title="' . esc_attr__( 'View Gravity PDF Theme Shop', 'gravity-forms-pdf-extended' ) . '">' . esc_html__( 'Theme Shop', 'gravity-forms-pdf-extended' ) . '</a>',  
  355.  ]; 
  356.  
  357.             return array_merge( $links, $row_meta ); 
  358.         } 
  359.  
  360.         return (array) $links; 
  361.     } 
  362.  
  363.     /** 
  364.      * If on a Gravity Form page add a new class 
  365.      * 
  366.      * @param array $classes 
  367.      * 
  368.      * @since 4.0 
  369.      * 
  370.      * @return string 
  371.      */ 
  372.     public function add_body_class( $classes ) { 
  373.  
  374.         if ( $this->misc->is_gfpdf_page() ) { 
  375.             $classes .= ' gfpdf-page'; 
  376.         } 
  377.  
  378.         return $classes; 
  379.     } 
  380.  
  381.     /** 
  382.      * Register all css and js which can be enqueued when needed 
  383.      * 
  384.      * @since 4.0 
  385.      * 
  386.      * @return void 
  387.      */ 
  388.     public function register_assets() { 
  389.         $this->register_styles(); 
  390.         $this->register_scripts(); 
  391.     } 
  392.  
  393.     /** 
  394.      * Register requrired CSS 
  395.      * 
  396.      * @since 4.0 
  397.      * 
  398.      * @return void 
  399.      */ 
  400.     private function register_styles() { 
  401.         $version = PDF_EXTENDED_VERSION; 
  402.  
  403.         wp_register_style( 'gfpdf_css_styles', PDF_PLUGIN_URL . 'dist/assets/css/gfpdf-styles.min.css', [ 'wp-color-picker', 'wp-jquery-ui-dialog' ], $version ); 
  404.         wp_register_style( 'gfpdf_css_admin_styles', PDF_PLUGIN_URL . 'dist/assets/css/gfpdf-admin-styles.min.css', [], $version ); 
  405.     } 
  406.  
  407.     /** 
  408.      * Register requrired JS 
  409.      * 
  410.      * @since 4.0 
  411.      * 
  412.      * @return void 
  413.      */ 
  414.     private function register_scripts() { 
  415.         $version = PDF_EXTENDED_VERSION; 
  416.  
  417.         $pdf_settings_dependancies = [ 
  418.             'wpdialogs',  
  419.             'jquery-ui-tooltip',  
  420.             'gform_forms',  
  421.             'gform_form_admin',  
  422.             'gform_chosen',  
  423.             'jquery-color',  
  424.             'wp-color-picker',  
  425.  ]; 
  426.  
  427.         wp_register_script( 'gfpdf_js_settings', PDF_PLUGIN_URL . 'dist/assets/js/gfpdf-settings.min.js', $pdf_settings_dependancies, $version ); 
  428.  
  429.         $pdf_backbone_dependancies = [ 
  430.             'gfpdf_js_settings',  
  431.             'backbone',  
  432.             'underscore',  
  433.             'gfpdf_js_backbone_model_binder',  
  434.             'wpdialogs',  
  435.  ]; 
  436.  
  437.         wp_register_script( 'gfpdf_js_backbone', PDF_PLUGIN_URL . 'dist/assets/js/gfpdf-backbone.min.js', $pdf_backbone_dependancies, $version ); /** @TODO - remove backbone and use React */ 
  438.         wp_register_script( 'gfpdf_js_backbone_model_binder', PDF_PLUGIN_URL . 'bower_components/backbone.modelbinder/Backbone.ModelBinder.min.js', [ 'backbone', 'underscore' ], $version ); 
  439.  
  440.         wp_register_script( 'gfpdf_js_vendors', PDF_PLUGIN_URL . 'dist/assets/js/vendor.bundle.min.js', [ 'jquery' ], $version ); 
  441.         wp_register_script( 'gfpdf_js_entrypoint', PDF_PLUGIN_URL . 'dist/assets/js/app.bundle.min.js', [ 'jquery', 'gfpdf_js_vendors' ], $version ); 
  442.         wp_register_script( 'gfpdf_js_entries', PDF_PLUGIN_URL . 'dist/assets/js/gfpdf-entries.min.js', [ 'jquery' ], $version ); 
  443.         wp_register_script( 'gfpdf_js_v3_migration', PDF_PLUGIN_URL . 'dist/assets/js/gfpdf-migration.min.js', [ 'gfpdf_js_settings' ], $version ); 
  444.  
  445.         /** Localise admin script */ 
  446.         wp_localize_script( 'gfpdf_js_entrypoint', 'GFPDF', $this->data->get_localised_script_data( $this->options, $this->gform ) ); 
  447.         wp_localize_script( 'gfpdf_js_settings', 'GFPDF', $this->data->get_localised_script_data( $this->options, $this->gform ) ); 
  448.     } 
  449.  
  450.  
  451.     /** 
  452.      * Load any assets that are needed 
  453.      * 
  454.      * @since 4.0.4 
  455.      * 
  456.      * @return void 
  457.      */ 
  458.     public function load_admin_assets() { 
  459.  
  460.         if ( $this->misc->is_gfpdf_page() ) { 
  461.             /** load styles */ 
  462.             wp_enqueue_style( 'gfpdf_css_styles' ); 
  463.             wp_enqueue_style( 'gform_chosen', \GFCommon::get_base_url() . '/css/chosen.min.css', [], \GFCommon::$version ); 
  464.  
  465.             /** load scripts */ 
  466.             wp_enqueue_script( 'gfpdf_js_settings' ); 
  467.  
  468.             /** add media uploader */ 
  469.             wp_enqueue_media(); 
  470.         } 
  471.  
  472.         wp_enqueue_script( 'gfpdf_js_entrypoint' ); 
  473.  
  474.         if ( $this->misc->is_gfpdf_settings_tab( 'help' ) || $this->misc->is_gfpdf_settings_tab( 'tools' ) ) { 
  475.             wp_enqueue_script( 'gfpdf_js_backbone' ); 
  476.         } 
  477.  
  478.         if ( is_admin() && rgget( 'page' ) == 'gf_entries' ) { 
  479.             wp_enqueue_script( 'gfpdf_js_entries' ); 
  480.             wp_enqueue_style( 'gfpdf_css_styles' ); 
  481.         } 
  482.  
  483.         if ( is_admin() ) { 
  484.             wp_enqueue_style( 'gfpdf_css_admin_styles' ); 
  485.         } 
  486.     } 
  487.  
  488.     /** 
  489.      * Auto no-conflict any preloaded scripts that begin with 'gfpdf_' 
  490.      * 
  491.      * @since 4.0 
  492.      * 
  493.      * @param array $items The current list of no-conflict scripts 
  494.      * 
  495.      * @return array 
  496.      */ 
  497.     public function auto_noconflict_scripts( $items ) { 
  498.  
  499.         $wp_scripts = wp_scripts(); 
  500.  
  501.         /** 
  502.          * Set defaults we will allow to load on GF pages which are needed for Gravity PDF 
  503.          * If any Gravity PDF modules requires WordPress-specific JS files you should add them to this list 
  504.          */ 
  505.         $default_scripts = [ 
  506.             'editor',  
  507.             'word-count',  
  508.             'quicktags',  
  509.             'wpdialogs-popup',  
  510.             'media-upload',  
  511.             'wplink',  
  512.             'backbone',  
  513.             'underscore',  
  514.             'media-editor',  
  515.             'media-models',  
  516.             'media-views',  
  517.             'plupload',  
  518.             'plupload-flash',  
  519.             'plupload-html4',  
  520.             'plupload-html5',  
  521.             'plupload-silverlight',  
  522.             'wp-plupload',  
  523.             'gform_placeholder',  
  524.             'jquery-ui-autocomplete',  
  525.             'thickbox',  
  526.  ]; 
  527.  
  528.         foreach ( $wp_scripts->queue as $object ) { 
  529.             if ( substr( $object, 0, 8 ) === 'gfpdf_js' ) { 
  530.                 $items[] = $object; 
  531.             } 
  532.         } 
  533.  
  534.         if ( $this->misc->is_gfpdf_page() ) { 
  535.             $items = array_merge( $default_scripts, $items ); 
  536.         } 
  537.  
  538.         /** See https://gravitypdf.com/documentation/v4/gfpdf_gf_noconflict_scripts/ for more details about this filter */ 
  539.  
  540.         return apply_filters( 'gfpdf_gf_noconflict_scripts', $items ); 
  541.     } 
  542.  
  543.     /** 
  544.      * Auto no-conflict any preloaded styles that begin with 'gfpdf_' 
  545.      * 
  546.      * @since 4.0 
  547.      * 
  548.      * @param array $items The current list of no-conflict styles 
  549.      * 
  550.      * @return array 
  551.      */ 
  552.     public function auto_noconflict_styles( $items ) { 
  553.  
  554.         $wp_styles = wp_styles(); 
  555.  
  556.         /** 
  557.          * Set defaults we will allow to load on GF pages which are needed for Gravity PDF 
  558.          * If any Gravity PDF modules requires WordPress-specific CSS files you should add them to this list 
  559.          */ 
  560.         $default_styles = [ 
  561.             'editor-buttons',  
  562.             'wp-jquery-ui-dialog',  
  563.             'media-views',  
  564.             'buttons',  
  565.             'thickbox',  
  566.             'gform_chosen',  
  567.  ]; 
  568.  
  569.         foreach ( $wp_styles->queue as $object ) { 
  570.             if ( substr( $object, 0, 9 ) === 'gfpdf_css' ) { 
  571.                 $items[] = $object; 
  572.             } 
  573.         } 
  574.  
  575.         if ( $this->misc->is_gfpdf_page() ) { 
  576.             $items = array_merge( $default_styles, $items ); 
  577.         } 
  578.  
  579.         /** See https://gravitypdf.com/documentation/v4/gfpdf_gf_noconflict_styles/ for more details about this filter */ 
  580.  
  581.         return apply_filters( 'gfpdf_gf_noconflict_styles', $items ); 
  582.     } 
  583.  
  584.     /** 
  585.      * Register our plugin with Gravity Form's Logger 
  586.      * 
  587.      * @param array $loggers 
  588.      * 
  589.      * @return array 
  590.      * 
  591.      * @since 4.0 
  592.      */ 
  593.     public function add_gf_logger( $loggers ) { 
  594.         $loggers['gravity-pdf'] = esc_html__( 'Gravity PDF', 'gravity-forms-pdf-extended' ); 
  595.  
  596.         return $loggers; 
  597.     } 
  598.  
  599.     /** 
  600.      * Bootstrap our settings API for use 
  601.      * 
  602.      * @return void 
  603.      * 
  604.      * @return 4.0 
  605.      */ 
  606.     public function init_settings_api() { 
  607.         /** load our options API */ 
  608.         $this->options->init(); 
  609.     } 
  610.  
  611.     /** 
  612.      * Register our admin settings 
  613.      * 
  614.      * @return void 
  615.      * 
  616.      * @return 4.0 
  617.      */ 
  618.     public function setup_settings_fields() { 
  619.         /** register our options settings */ 
  620.         $this->options->register_settings( $this->options->get_registered_fields() ); 
  621.     } 
  622.  
  623.     /** 
  624.      * Loads our Gravity PDF installer classes 
  625.      * 
  626.      * @since 4.0 
  627.      * 
  628.      * @return void 
  629.      */ 
  630.     public function installer() { 
  631.         $model = new Model\Model_Install( $this->gform, $this->log, $this->data, $this->misc, $this->notices ); 
  632.         $class = new Controller\Controller_Install( $model, $this->gform, $this->log, $this->notices, $this->data, $this->misc ); 
  633.         $class->init(); 
  634.  
  635.         /** set up required data */ 
  636.         $class->setup_defaults(); 
  637.  
  638.         /** Add to our singleton controller */ 
  639.         $this->singleton->add_class( $class ); 
  640.         $this->singleton->add_class( $model ); 
  641.     } 
  642.  
  643.     /** 
  644.      * Include Welcome Screen functionality for installation / upgrades 
  645.      * 
  646.      * @since 4.0 
  647.      * 
  648.      * @return void 
  649.      */ 
  650.     public function welcome_screen() { 
  651.  
  652.         $model = new Model\Model_Welcome_Screen( $this->log ); 
  653.         $view = new View\View_Welcome_Screen( [ 
  654.             'display_version' => PDF_EXTENDED_VERSION,  
  655.  ], $this->gform ); 
  656.  
  657.         $class = new Controller\Controller_Welcome_Screen( $model, $view, $this->log, $this->data, $this->options ); 
  658.         $class->init(); 
  659.  
  660.         /** Add to our singleton controller */ 
  661.         $this->singleton->add_class( $class ); 
  662.         $this->singleton->add_class( $model ); 
  663.         $this->singleton->add_class( $view ); 
  664.     } 
  665.  
  666.     /** 
  667.      * Include Settings Page functionality 
  668.      * 
  669.      * @since 4.0 
  670.      * 
  671.      * @return void 
  672.      */ 
  673.     public function gf_settings() { 
  674.  
  675.         $model = new Model\Model_Settings( 
  676.             $this->gform,  
  677.             $this->log,  
  678.             $this->notices,  
  679.             $this->options,  
  680.             $this->data,  
  681.             $this->misc,  
  682.             $this->templates 
  683.  ); 
  684.  
  685.         $view = new View\View_Settings( 
  686.             [],  
  687.             $this->gform,  
  688.             $this->log,  
  689.             $this->options,  
  690.             $this->data,  
  691.             $this->misc,  
  692.             $this->templates 
  693.  ); 
  694.  
  695.         $class = new Controller\Controller_Settings( $model, $view, $this->gform, $this->log, $this->notices, $this->data, $this->misc ); 
  696.         $class->init(); 
  697.  
  698.         /** Add to our singleton controller */ 
  699.         $this->singleton->add_class( $class ); 
  700.         $this->singleton->add_class( $model ); 
  701.         $this->singleton->add_class( $view ); 
  702.     } 
  703.  
  704.     /** 
  705.      * Include Form Settings (PDF) functionality 
  706.      * 
  707.      * @since 4.0 
  708.      * 
  709.      * @return void 
  710.      */ 
  711.     public function gf_form_settings() { 
  712.  
  713.         $model = new Model\Model_Form_Settings( 
  714.             $this->gform,  
  715.             $this->log,  
  716.             $this->data,  
  717.             $this->options,  
  718.             $this->misc,  
  719.             $this->notices,  
  720.             $this->templates 
  721.  ); 
  722.  
  723.         $view = new View\View_Form_Settings( [] ); 
  724.  
  725.         $class = new Controller\Controller_Form_Settings( 
  726.             $model,  
  727.             $view,  
  728.             $this->data,  
  729.             $this->options,  
  730.             $this->misc 
  731.  ); 
  732.  
  733.         $class->init(); 
  734.  
  735.         /** Add to our singleton controller */ 
  736.         $this->singleton->add_class( $class ); 
  737.         $this->singleton->add_class( $model ); 
  738.         $this->singleton->add_class( $view ); 
  739.     } 
  740.  
  741.     /** 
  742.      * Include PDF Display functionality 
  743.      * 
  744.      * @since 4.0 
  745.      * 
  746.      * @return void 
  747.      */ 
  748.     public function pdf() { 
  749.  
  750.         $model = new Model\Model_PDF( 
  751.             $this->gform,  
  752.             $this->log,  
  753.             $this->options,  
  754.             $this->data,  
  755.             $this->misc,  
  756.             $this->notices,  
  757.             $this->templates 
  758.  ); 
  759.  
  760.         $view = new View\View_PDF( 
  761.             [],  
  762.             $this->gform,  
  763.             $this->log,  
  764.             $this->options,  
  765.             $this->data,  
  766.             $this->misc,  
  767.             $this->templates 
  768.  ); 
  769.  
  770.         $class = new Controller\Controller_PDF( $model, $view, $this->gform, $this->log, $this->misc ); 
  771.         $class->init(); 
  772.  
  773.         /** Add to our singleton controller */ 
  774.         $this->singleton->add_class( $class ); 
  775.         $this->singleton->add_class( $model ); 
  776.         $this->singleton->add_class( $view ); 
  777.     } 
  778.  
  779.     /** 
  780.      * Include PDF Shortcodes functionality 
  781.      * 
  782.      * @since 4.0 
  783.      * 
  784.      * @return void 
  785.      */ 
  786.     public function shortcodes() { 
  787.  
  788.         $model = new Model\Model_Shortcodes( $this->gform, $this->log, $this->options, $this->misc ); 
  789.         $view = new View\View_Shortcodes( [] ); 
  790.  
  791.         $class = new Controller\Controller_Shortcodes( $model, $view, $this->log ); 
  792.         $class->init(); 
  793.  
  794.         /** Add to our singleton controller */ 
  795.         $this->singleton->add_class( $class ); 
  796.         $this->singleton->add_class( $model ); 
  797.         $this->singleton->add_class( $view ); 
  798.     } 
  799.  
  800.     /** 
  801.      * Include PDF Mergetag functionality 
  802.      * 
  803.      * @since 4.1 
  804.      * 
  805.      * @return void 
  806.      */ 
  807.     public function mergetags() { 
  808.  
  809.         $model = new Model\Model_Mergetags( $this->options, $this->singleton->get_class( 'Model_PDF' ), $this->log, $this->misc ); 
  810.  
  811.         $class = new Controller\Controller_Mergetags( $model ); 
  812.         $class->init(); 
  813.  
  814.         /** Add to our singleton controller */ 
  815.         $this->singleton->add_class( $class ); 
  816.         $this->singleton->add_class( $model ); 
  817.     } 
  818.  
  819.     /** 
  820.      * Include one-time actions functionality 
  821.      * 
  822.      * @since 4.0 
  823.      * 
  824.      * @return void 
  825.      */ 
  826.     public function actions() { 
  827.  
  828.         $model = new Model\Model_Actions( $this->data, $this->options, $this->notices ); 
  829.         $view = new View\View_Actions( [] ); 
  830.  
  831.         $class = new Controller\Controller_Actions( $model, $view, $this->gform, $this->log, $this->notices ); 
  832.         $class->init(); 
  833.  
  834.         /** Add to our singleton controller */ 
  835.         $this->singleton->add_class( $class ); 
  836.         $this->singleton->add_class( $model ); 
  837.         $this->singleton->add_class( $view ); 
  838.     } 
  839.  
  840.     /** 
  841.      * Include template manager functionality 
  842.      * 
  843.      * @since 4.0 
  844.      * 
  845.      * @return void 
  846.      */ 
  847.     public function template_manager() { 
  848.  
  849.         $model = new Model\Model_Templates( $this->templates, $this->log, $this->data, $this->misc ); 
  850.  
  851.         $class = new Controller\Controller_Templates( $model ); 
  852.         $class->init(); 
  853.  
  854.         /** Add to our singleton controller */ 
  855.         $this->singleton->add_class( $class ); 
  856.         $this->singleton->add_class( $model ); 
  857.     } 
  858.  
  859.     /** 
  860.      * Backwards compatibility with our early v3 templates 
  861.      * 
  862.      * @param $form_id 
  863.      * 
  864.      * @return array 
  865.      * 
  866.      * @since 4.0 
  867.      */ 
  868.     public function get_config_data( $form_id ) { 
  869.         return $this->get_default_config_data( $form_id ); 
  870.     } 
  871.  
  872.     /** 
  873.      * Add backwards compatbility with v3.x.x default PDF template files 
  874.      * This function will now pull the PDF configuration details from our query variables / or our backwards compatible URL params method 
  875.      * 
  876.      * @param integer $form_id The Gravity Form ID 
  877.      * 
  878.      * @return array The matched configuration being requested 
  879.      * 
  880.      * @since 4.0 
  881.      */ 
  882.     public function get_default_config_data( $form_id ) { 
  883.  
  884.         $pid = $GLOBALS['wp']->query_vars['pid']; 
  885.  
  886.         $settings = $this->options->get_pdf( $form_id, $pid ); 
  887.  
  888.         if ( is_wp_error( $settings ) ) { 
  889.  
  890.             $this->log->addError( 'Invalid PDF Settings.', [ 
  891.                 'form_id' => $form_id,  
  892.                 'pid' => $pid,  
  893.                 'WP_Error_Message' => $settings->get_error_message(),  
  894.                 'WP_Error_Code' => $settings->get_error_code(),  
  895.  ] ); 
  896.  
  897.             /** Reset the settings so it forces everything to false */ 
  898.             $settings = []; 
  899.         } 
  900.  
  901.         return [ 
  902.             'empty_field' => ( isset( $settings['show_empty'] ) && $settings['show_empty'] == 'Yes' ) ? true : false,  
  903.             'html_field' => ( isset( $settings['show_html'] ) && $settings['show_html'] == 'Yes' ) ? true : false,  
  904.             'page_names' => ( isset( $settings['show_page_names'] ) && $settings['show_page_names'] == 'Yes' ) ? true : false,  
  905.             'section_content' => ( isset( $settings['show_section_content'] ) && $settings['show_section_content'] == 'Yes' ) ? true : false,  
  906.  ]; 
  907.     } 
  908. }