gravityview / GravityView

future/includes/class-gv-utils.php

Doc Comments +2 added lines, -2 removed lines

@@ -52,7 +52,7 @@ 
 	 * @param string $name The key name (will be prefixed).
 	 * @param mixed $default The default value if not found (Default: null)
 	 *
-	 * @return mixed The value or $default if not found.
+	 * @return string The value or $default if not found.
 	 */
 	public static function _SERVER( $name, $default = null ) {
 		return self::get( $_SERVER, $name, $default );
@@ -126,7 +126,7 @@ 
 	 *
 	 * @param mixed $value The value to return from the closure.
 	 *
-	 * @return Closure The closure with the $value bound.
+	 * @return \Closure The closure with the $value bound.
 	 */
 	public static function _return( $value ) {
 		return function() use ( $value ) { return $value; };

includes/widgets/class-gravityview-widget-gravityforms.php

Doc Comments +1 added lines, -1 removed lines

@@ -73,7 +73,7 @@
 	 *
 	 * @param array $allowlist Array of widgets to show before a search is performed, if the setting is enabled.
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	function add_to_allowlist( $allowlist ) {
 

future/lib/EDD_SL_Plugin_Updater.php

Doc Comments +1 added lines, -1 removed lines

@@ -97,7 +97,7 @@
 	 * @uses api_request()
 	 *
 	 * @param array   $_transient_data Update array build by WordPress.
-	 * @return array Modified update array with custom plugin data.
+	 * @return stdClass Modified update array with custom plugin data.
 	 */
 	public function check_update( $_transient_data ) {
 

future/includes/class-gv-license-handler.php

Doc Comments +3 added lines, -1 removed lines

@@ -510,6 +510,9 @@ 
 		$this->settings->set( $settings );
 	}
 
+	/**
+	 * @param boolean $echo
+	 */
 	public function settings_edd_license_activation( $field, $echo ) {
 
 		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
@@ -617,7 +620,6 @@ 
 	 * Check the GravityView license information
 	 *
 	 * @since 1.19.3
-	 * @param bool $force Whether to force checking license, even if AJAX
 	 *
 	 * @return void
 	 */

future/includes/class-gv-settings-addon.php

Doc Comments +1 added lines, -1 removed lines

@@ -140,7 +140,7 @@
 	 *
 	 * @param array $items Styles to exclude from no-conflict
 	 *
-	 * @return array
+	 * @return string[]
 	 */
 	public function register_no_conflict( $items ) {
 

includes/class-admin-approve-entries.php

Doc Comments +1 added lines, -1 removed lines

@@ -278,7 +278,7 @@
 	 * Capture bulk actions - gf_entries table
 	 *
 	 * @uses  GravityView_frontend::get_search_criteria() Convert the $_POST search request into a properly formatted request.
-	 * @return void|boolean
+	 * @return false|null
 	 */
 	public function process_bulk_action() {
 

includes/class-api.php

Doc Comments +4 added lines, -1 removed lines

@@ -232,7 +232,6 @@ 
 	 * @deprecated Use \GV\Field_Template::render() or the more low-level \GV\Field::get_value()
 	 *
 	 * @param array $entry
-	 * @param array $field
 	 * @return null|string
 	 */
 	public static function field_value( $entry, $field_settings, $format = 'html' ) {
@@ -851,6 +850,9 @@ 
 	return $value;
 }
 
+/**
+ * @param GV\Template_Context $context
+ */
 function gv_directory_link( $post = NULL, $add_pagination = true, $context = null ) {
 	return GravityView_API::directory_link( $post, $add_pagination, $context );
 }
@@ -1359,6 +1361,7 @@ 
  * @param  array $passed_args Associative array with field data. `field` and `form` are required.
  * @since  2.0
  * @param  \GV\Template_Context The template context.
+ * @param GV\Template_Context $context
  * @return string Field output. If empty value and hide empty is true, return empty.
  */
 function gravityview_field_output( $passed_args, $context = null ) {

includes/class-common.php

Doc Comments +5 added lines, -5 removed lines

@@ -281,7 +281,7 @@ 
 	/**
 	 * Return array of fields' id and label, for a given Form ID
 	 *
-	 * @param string|array $form_id (default: '') or $form object
+	 * @param string|array $form (default: '') or $form object
 	 * @param bool $add_default_properties
 	 * @param bool $include_parent_field
 	 * @return array
@@ -1034,7 +1034,7 @@ 
 	 *
 	 * @param array $form Gravity Forms form array
 	 * @param string $field_id ID of the field. If an input, full input ID (like `1.3`)
-	 * @param string|array $field_value Raw value of the field.
+	 * @param string $field_value Raw value of the field.
 	 * @return string
 	 */
 	public static function get_field_label( $form = array(), $field_id = '', $field_value = '' ) {
@@ -1555,7 +1555,7 @@ 
 	 *
 	 * Do the same than parse_str without max_input_vars limitation:
 	 * Parses $string as if it were the query string passed via a URL and sets variables in the current scope.
-	 * @param $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
+	 * @param string $string string string to parse (not altered like in the original parse_str(), use the second parameter!)
 	 * @param $result array  If the second parameter is present, variables are stored in this variable as array elements
 	 * @return bool true or false if $string is an empty string
 	 * @since  1.5.3
@@ -1791,9 +1791,9 @@ 
 	 * @param string $message            Message body (required)
 	 * @param string $from_name          Displayed name of the sender
 	 * @param string $message_format     If "html", sent text as `text/html`. Otherwise, `text/plain`. Default: "html".
-	 * @param string|array $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
+	 * @param string $attachments  Optional. Files to attach. {@see wp_mail()} for usage. Default: "".
 	 * @param array|false $entry         Gravity Forms entry array, related to the email. Default: false.
-	 * @param array|false $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
+	 * @param boolean $notification  Gravity Forms notification that triggered the email. {@see GFCommon::send_notification}. Default:false.
 	 */
 	public static function send_email( $from, $to, $bcc, $reply_to, $subject, $message, $from_name = '', $message_format = 'html', $attachments = '', $entry = false, $notification = false ) {
 

includes/class-frontend-views.php

Doc Comments +3 added lines, -4 removed lines

@@ -227,7 +227,7 @@ 
 	 *
 	 *
 	 *
-	 * @param null $view_id
+	 * @param string $view_id
 	 */
 	public function set_context_view_id( $view_id = null ) {
 		$multiple_views = $this->getGvOutputData() && $this->getGvOutputData()->has_multiple_views();
@@ -922,7 +922,7 @@ 
 	 *
 	 *
 	 * @uses  gravityview_get_entries()
-	 * @param array $args\n
+	 * @param array $args
 	 *   - $id - View id
 	 *   - $page_size - Page
 	 *   - $sort_field - form field id to sort
@@ -1051,7 +1051,6 @@ 
 	 * @since 1.19.5
 	 *
 	 * @param $args
-	 * @param int $form_id
 	 */
 	public static function get_search_criteria_paging( $args ) {
 
@@ -1553,7 +1552,7 @@ 
 	/**
 	 * Checks if field (column) is sortable
 	 *
-	 * @param string $field Field settings
+	 * @param string $field_id Field settings
 	 * @param array $form Gravity Forms form array
 	 *
 	 * @since 1.7