NF_Abstracts_ModelFactory

Class NF_Abstracts_ModelFactory.

Defined (1)

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

/includes/Abstracts/ModelFactory.php  
  1. class NF_Abstracts_ModelFactory 
  2. { 
  3.     /** 
  4.      * Database Object 
  5.      * 
  6.      * @var 
  7.      */ 
  8.     protected $_db; 
  9.  
  10.     /** 
  11.      * The last set object. 
  12.      *   Used to create context between two objects in a chain. 
  13.      * 
  14.      * @var object 
  15.      */ 
  16.     protected $_object; 
  17.  
  18.     /** 
  19.      * Form 
  20.      */ 
  21.      protected $_form; 
  22.  
  23.     /** 
  24.      * Fields 
  25.      * 
  26.      * An array of field model objects. 
  27.      * 
  28.      * @var array 
  29.      */ 
  30.     protected $_fields = array(); 
  31.  
  32.     /** 
  33.      * Actions 
  34.      * 
  35.      * An array of action model objects. 
  36.      * 
  37.      * @var array 
  38.      */ 
  39.     protected $_actions = array(); 
  40.  
  41.     /** 
  42.      * Objects 
  43.      * 
  44.      * An array of generic model objects. 
  45.      * 
  46.      * @var array 
  47.      */ 
  48.     protected $_objects = array(); 
  49.  
  50.     //----------------------------------------------------- 
  51.     // Public Methods 
  52.     //----------------------------------------------------- 
  53.  
  54.     /** 
  55.      * NF_Abstracts_ModelFactory constructor. 
  56.      * @param $db 
  57.      * @param $id 
  58.      */ 
  59.     public function __construct( $db, $id ) 
  60.     { 
  61.         $this->_db = $db; 
  62.  
  63.         $this->_object = $this->_form = new NF_Database_Models_Form( $this->_db, $id ); 
  64.  
  65.         $form_cache = get_option( 'nf_form_' . $id, false ); 
  66.  
  67.         if( $form_cache ) { 
  68.             $this->_object->update_settings( $form_cache[ 'settings' ] ); 
  69.         } 
  70.  
  71.         return $this; 
  72.     } 
  73.  
  74.     /** 
  75.      * Returns the parent object set by the constructor for chained methods. 
  76.      * 
  77.      * @return object 
  78.      */ 
  79.     public function get() 
  80.     { 
  81.         $object = $this->_object; 
  82.         $this->_object = $this->_form; 
  83.         return $object; 
  84.     } 
  85.  
  86.     /** 
  87.      * Get Forms 
  88.      * 
  89.      * Returns an array of Form Model Objects. 
  90.      * 
  91.      * @param array $where 
  92.      * @return array|bool 
  93.      */ 
  94.     public function get_forms( array $where = array() ) 
  95.     { 
  96.         if( 'form' != $this->_object->get_type() ) return FALSE; 
  97.  
  98.         return $this->_object->find( NULL, $where ); 
  99.     } 
  100.  
  101.     /** 
  102.      * Export Form 
  103.      * 
  104.      * A wrapper for the Form Model export method. 
  105.      * 
  106.      * @param bool|FALSE $return 
  107.      * @return array 
  108.      */ 
  109.     public function export_form( $return = FALSE ) 
  110.     { 
  111.         $form_id = $this->_object->get_id(); 
  112.  
  113.         return NF_Database_Models_Form::export( $form_id, $return ); 
  114.     } 
  115.  
  116.     /** 
  117.      * Import Form 
  118.      * 
  119.      * A wrapper for the Form Model import method. 
  120.      * 
  121.      * @param $import 
  122.      */ 
  123.     public function import_form( $import, $id = FALSE, $is_conversion = FALSE ) 
  124.     { 
  125.         if( ! is_array( $import ) ) { 
  126.  
  127.             $data = WPN_Helper::utf8_decode( json_decode( html_entity_decode( $import ), true ) ); 
  128.  
  129.             if( ! is_array( $data ) ) { 
  130.                 $data = WPN_Helper::utf8_decode( json_decode(  $import , true ) ); 
  131.             } 
  132.  
  133.             if( ! is_array( $data ) ) { 
  134.                 $data = WPN_Helper::maybe_unserialize( $import ); 
  135.  
  136.                 if( ! is_array( $data ) ) { 
  137.                     return false; 
  138.                 } 
  139.             } 
  140.             $import = $data; 
  141.         } 
  142.  
  143.         return NF_Database_Models_Form::import( $import, $id, $is_conversion ); 
  144.     } 
  145.  
  146.     /** 
  147.      * FIELDS 
  148.      */ 
  149.  
  150.     /** 
  151.      * Sets the parent object for chained methods as a Field. 
  152.      * 
  153.      * @param string $id 
  154.      * @return $this 
  155.      */ 
  156.     public function field( $id = '' ) 
  157.     { 
  158.         $form_id = $this->_object->get_id(); 
  159.  
  160.         $this->_object = new NF_Database_Models_Field( $this->_db, $id, $form_id ); 
  161.  
  162.         return $this; 
  163.     } 
  164.  
  165.     /** 
  166.      * Returns a field object. 
  167.      * 
  168.      * @param $id 
  169.      * @return NF_Database_Models_Field 
  170.      */ 
  171.     public function get_field( $id ) 
  172.     { 
  173.         if( isset( $this->_fields[ $id ] ) ) { 
  174.             return $this->_fields[ $id ]; 
  175.         } 
  176.  
  177.         /** MISSING FORM ID FALLBACK */ 
  178.         /** 
  179.         if( ! $form_id ) { 
  180.             $form_id = $wpdb->get_var( $wpdb->prepare( 
  181.                 "SELECT parent_id from {$wpdb->prefix}nf3_fields WHERE id = %d", $id 
  182.  )); 
  183.             $this->_object = $this->_form = new NF_Database_Models_Form( $this->_db, $id ); 
  184.         } 
  185.         */ 
  186.  
  187.         if( ! $this->_fields ) { 
  188.             $this->get_fields(); 
  189.         } 
  190.  
  191.         if( ! isset( $this->_fields[ $id ] ) ) { 
  192.             $form_id = $this->_object->get_id(); 
  193.             $this->_fields[ $id ] = new NF_Database_Models_Field( $this->_db, $id, $form_id ); 
  194.         } 
  195.  
  196.         return $this->_fields[ $id ]; 
  197.     } 
  198.  
  199.     /** 
  200.      * Returns an array of field objects for the set form (object). 
  201.      * 
  202.      * @param array $where 
  203.      * @param bool|FALSE $fresh 
  204.      * @return array 
  205.      */ 
  206.     public function get_fields( $where = array(), $fresh = FALSE) 
  207.     { 
  208.  
  209.         $field_by_key = array(); 
  210.  
  211.         $form_id = $this->_object->get_id(); 
  212.  
  213.         if( $where || $fresh || ! $this->_fields ) { 
  214.  
  215.             $form_cache = get_option( 'nf_form_' . $form_id, false ); 
  216.  
  217.             if( ! $form_cache ) { 
  218.                 $model_shell = new NF_Database_Models_Field($this->_db, 0); 
  219.  
  220.                 $fields = $model_shell->find($form_id, $where); 
  221.  
  222.                 foreach ($fields as $field) { 
  223.                     $this->_fields[$field->get_id()] = $field; 
  224.                     $field_by_key[ $field->get_setting( 'key' ) ] = $field; 
  225.                 } 
  226.             } else { 
  227.                 foreach( $form_cache[ 'fields' ] as $cached_field ) { 
  228.                     $field = new NF_Database_Models_Field( $this->_db, $cached_field[ 'id' ], $form_id ); 
  229.                     $field->update_settings( $cached_field[ 'settings' ] ); 
  230.                     $this->_fields[$field->get_id()] = $field; 
  231.                     $field_by_key[ $field->get_setting( 'key' ) ] = $field; 
  232.                 } 
  233.             } 
  234.  
  235.             /** 
  236.              * If a filter is registered to modify field order, then use that filter. 
  237.              * If not, then usort??. 
  238.              */ 
  239.             $order = apply_filters( 'ninja_forms_get_fields_sorted', array(), $this->_fields, $field_by_key, $form_id ); 
  240.  
  241.             if ( ! empty( $order ) ) { 
  242.                 $this->_fields = $order; 
  243.             } 
  244.         } 
  245.  
  246.         /** 
  247.          * Broke the sub edit screen order when I have this enabled. 
  248.          */ 
  249.         // usort( $this->_fields, "NF_Abstracts_Field::sort_by_order" ); 
  250.  
  251.         return $this->_fields; 
  252.     } 
  253.  
  254.     /** 
  255.      * Import Field 
  256.      * 
  257.      * A wrapper for the Form Model import method. 
  258.      * 
  259.      * @param $import 
  260.      */ 
  261.     public function import_field( $settings, $field_id = '', $is_conversion = FALSE ) 
  262.     { 
  263.         $settings = maybe_unserialize( $settings ); 
  264.         NF_Database_Models_Field::import( $settings, $field_id, $is_conversion ); 
  265.     } 
  266.  
  267.  
  268.     /** 
  269.      * ACTIONS 
  270.      */ 
  271.  
  272.     /** 
  273.      * Sets the parent object for chained methods as an Action. 
  274.      * 
  275.      * @param string $id 
  276.      * @return $this 
  277.      */ 
  278.     public function action( $id ='' ) 
  279.     { 
  280.         $form_id = $this->_object->get_id(); 
  281.  
  282.         $this->_object = new NF_Database_Models_Action( $this->_db, $id, $form_id ); 
  283.  
  284.         return $this; 
  285.     } 
  286.  
  287.     /** 
  288.      * Returns an action object. 
  289.      * 
  290.      * @param $id 
  291.      * @return NF_Database_Models_Action 
  292.      */ 
  293.     public function get_action( $id ) 
  294.     { 
  295.         $form_id = $this->_object->get_id(); 
  296.  
  297.         return $this->_actions[ $id ] = new NF_Database_Models_Action( $this->_db, $id, $form_id ); 
  298.     } 
  299.  
  300.     /** 
  301.      * Returns an array of action objects for the set form (object). 
  302.      * 
  303.      * @param array $where 
  304.      * @param bool|FALSE $fresh 
  305.      * @return array 
  306.      */ 
  307.     public function get_actions( $where = array(), $fresh = FALSE) 
  308.     { 
  309.         if( $where || $fresh || ! $this->_actions ) { 
  310.  
  311.             $form_id = $this->_object->get_id(); 
  312.  
  313.             $model_shell = new NF_Database_Models_Action($this->_db, 0); 
  314.  
  315.             $actions = $model_shell->find($form_id, $where); 
  316.  
  317.             foreach ($actions as $action) { 
  318.                 $action->get_setting( 'type' ); // Pre-load the type of action for usort() 
  319.                 $this->_actions[$action->get_id()] = $action; 
  320.             } 
  321.         } 
  322.  
  323.         usort( $this->_actions, 'NF_Abstracts_Action::sort_actions' ); 
  324.  
  325.         return $this->_actions; 
  326.     } 
  327.  
  328.     /** 
  329.      * OBJECTS 
  330.      */ 
  331.  
  332.     /** 
  333.      * Sets the parent object for chained methods as an Object. 
  334.      * 
  335.      * @param string $id 
  336.      * @return $this 
  337.      */ 
  338.     public function object( $id = '' ) 
  339.     { 
  340.         $parent_id = $this->_object->get_id(); 
  341.         $parent_type = $this->_object->get_type(); 
  342.  
  343.         $this->_object = new NF_Database_Models_Object( $this->_db, $id, $parent_id, $parent_type ); 
  344.  
  345.         return $this; 
  346.     } 
  347.  
  348.     /** 
  349.      * Returns an object. 
  350.      * 
  351.      * @param $id 
  352.      * @return NF_Database_Models_Object 
  353.      */ 
  354.     public function get_object( $id ) 
  355.     { 
  356.         return $this->_objects[ $id ] = new NF_Database_Models_Object( $this->_db, $id ); 
  357.     } 
  358.  
  359.     /** 
  360.      * Returns an array of objects for the set object. 
  361.      * 
  362.      * @param array $where 
  363.      * @param bool|FALSE $fresh 
  364.      * @return array 
  365.      */ 
  366.     public function get_objects( $where = array(), $fresh = FALSE) 
  367.     { 
  368.         if( $where || $fresh || ! $this->_objects ) { 
  369.  
  370.             $form_id = $this->_object->get_id(); 
  371.  
  372.             $model_shell = new NF_Database_Models_Object( $this->_db, 0 ); 
  373.  
  374.             $objects = $model_shell->find( $form_id, $where ); 
  375.  
  376.             foreach( $objects as $object ) { 
  377.                 $this->_objects[ $object->get_id() ] = $object; 
  378.             } 
  379.         } 
  380.  
  381.         return $this->_objects; 
  382.     } 
  383.  
  384.     /** 
  385.      * SUBMISSIONS 
  386.      */ 
  387.  
  388.     /** 
  389.      * Submission 
  390.      * 
  391.      * Returns a single submission by ID,  
  392.      *   or an empty submission. 
  393.      * 
  394.      * @param string $id 
  395.      * @return $this 
  396.      */ 
  397.     public function sub( $id = '' ) 
  398.     { 
  399.         $form_id = $this->_object->get_id(); 
  400.  
  401.         $this->_object = new NF_Database_Models_Submission( $id, $form_id ); 
  402.  
  403.         return $this; 
  404.     } 
  405.  
  406.     /** 
  407.      * Get Submission 
  408.      * 
  409.      * Returns a single submission by ID. 
  410.      * 
  411.      * @param $id 
  412.      * @return NF_Database_Models_Submission 
  413.      */ 
  414.     public function get_sub( $id ) 
  415.     { 
  416.         $parent_id = $this->_object->get_id(); 
  417.  
  418.         return $this->_objects[ $id ] = new NF_Database_Models_Submission( $id, $parent_id ); 
  419.     } 
  420.  
  421.     /** 
  422.      * Get Submissions 
  423.      * 
  424.      * Returns an array of Submission Model Objects. 
  425.      * 
  426.      * @param array $where 
  427.      * @param bool|FALSE $fresh 
  428.      * @return array 
  429.      */ 
  430.     public function get_subs( $where = array(), $fresh = FALSE, $sub_ids = array() ) 
  431.     { 
  432.         if( $where || $fresh || $sub_ids || ! $this->_objects ) { 
  433.  
  434.             $form_id = $this->_object->get_id(); 
  435.  
  436.             $model_shell = new NF_Database_Models_Submission( 0 ); 
  437.  
  438.             $objects = $model_shell->find( $form_id, $where, $sub_ids ); 
  439.  
  440.             foreach( $objects as $object ) { 
  441.                 $this->_objects[ $object->get_id() ] = $object; 
  442.             } 
  443.         } 
  444.  
  445.         return $this->_objects; 
  446.     } 
  447.  
  448.     /** 
  449.      * Export Submissions 
  450.      * 
  451.      * A wrapper for the Submission Model export method. 
  452.      * 
  453.      * @param array $sub_ids 
  454.      * @param bool|FALSE $return 
  455.      * @return string 
  456.      */ 
  457.     public function export_subs( array $sub_ids = array(), $return = FALSE ) 
  458.     { 
  459.         $form_id = $this->_object->get_id(); 
  460.  
  461.         return NF_Database_Models_Submission::export( $form_id, $sub_ids, $return ); 
  462.     } 
  463.  
  464.     /** 
  465.      * GENERIC 
  466.      */ 
  467.  
  468.     /** 
  469.      * Get Model 
  470.      * 
  471.      * A generic method call for any object model type. 
  472.      * 
  473.      * @param $id 
  474.      * @param $type 
  475.      * @return bool|NF_Database_Models_Action|NF_Database_Models_Field|NF_Database_Models_Form|NF_Database_Models_Object 
  476.      */ 
  477.     public function get_model( $id, $type ) 
  478.     { 
  479.         global $wpdb; 
  480.  
  481.         switch( $type ) { 
  482.             case 'form': 
  483.                 return new NF_Database_Models_Form( $wpdb, $id ); 
  484.                 break; 
  485.             case 'field': 
  486.                 return new NF_Database_Models_Field( $wpdb, $id ); 
  487.                 break; 
  488.             case 'action': 
  489.                 return new NF_Database_Models_Action( $wpdb, $id ); 
  490.                 break; 
  491.             case 'object': 
  492.                 return new NF_Database_Models_Object( $wpdb, $id ); 
  493.                 break; 
  494.             default: 
  495.                 return FALSE; 
  496.         } 
  497.     } 
  498.  
  499. } // End Class NF_Abstracts_ModelFactory