GFPDFHelperHelper_Abstract_Form

Abstract class to abstract some of the Gravity Forms functionality.

Defined (1)

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

/src/helper/abstract/Helper_Abstract_Form.php  
  1. abstract class Helper_Abstract_Form { 
  2.  
  3. /** 
  4. * Get the form plugins current version 
  5. * @return string 
  6. * @since 4.0 
  7. */ 
  8. abstract public function get_version(); 
  9.  
  10. /** 
  11. * Get form plugin's path 
  12. * @return string 
  13. * @since 4.0 
  14. */ 
  15. abstract public function get_plugin_path(); 
  16.  
  17. /** 
  18. * Get form plugin's URL 
  19. * @return string 
  20. * @since 4.0 
  21. */ 
  22. abstract public function get_plugin_url(); 
  23.  
  24. /** 
  25. * Get form plugin's form array 
  26. * @param integer $form_id 
  27. * @return mixed 
  28. * @since 4.0 
  29. */ 
  30. abstract public function get_form( $form_id ); 
  31.  
  32. /** 
  33. * Get form plugin's current forms array 
  34. * @return mixed 
  35. * @since 4.0 
  36. */ 
  37. abstract public function get_forms(); 
  38.  
  39. /** 
  40. * Get form plugin's form array 
  41. * @param array|object $form The form object to be updated 
  42. * @return mixed 
  43. * @since 4.0 
  44. */ 
  45. abstract public function update_form( $form ); 
  46.  
  47. /** 
  48. * Get the entry based on the ID 
  49. * @param integer $entry_id 
  50. * @return mixed 
  51. * @since 4.0 
  52. */ 
  53. abstract public function get_entry( $entry_id ); 
  54.  
  55. /** 
  56. * Get multiple entries from multiple forms based on search criteria 
  57. * @param integer|array $form_ids The ID's of the form or an array of ideas. 
  58. * @param array $search_criteria An array containing the search criteria 
  59. * @param array $sorting An array containing the sort criteria 
  60. * @param array $paging Use to limit the number of entries returned 
  61. * @return mixed 
  62. * @since 4.0 
  63. */ 
  64. abstract public function get_entries( $form_ids, $search_criteria = [], $sorting = null, $paging = null ); 
  65.  
  66. /** 
  67. * Update the current entry object 
  68. * @param object $entry The entry to be updated 
  69. * @return mixed 
  70. * @since 4.0 
  71. */ 
  72. abstract public function update_entry( $entry ); 
  73.  
  74. /** 
  75. * Get all custom form plugin capabilities added to WordPress, if any 
  76. * @return array 
  77. * @since 4.0 
  78. */ 
  79. abstract public function get_capabilities(); 
  80.  
  81. /** 
  82. * Check if the user has the capability passed 
  83. * @param string $capability 
  84. * @param integer $user_id 
  85. * @return boolean True if successful, false if failed 
  86. * @since 4.0 
  87. */ 
  88. abstract public function has_capability( $capability, $user_id = null ); 
  89.  
  90. /** 
  91. * Replace all the tag fields (that represent the field data) in the string 
  92. * @param string $string The string to process 
  93. * @param array $form The Gravity Form array 
  94. * @param array $entry The Gravity Form Entry Array 
  95. * @return string 
  96. * @since 4.0 
  97. */ 
  98. abstract public function process_tags( $string, $form, $entry );