gravityview / GravityView

includes/class-common.php

Doc Comments +4 added lines, -4 removed lines

@@ -209,7 +209,7 @@ 
 	 * Return array of fields' id and label, for a given Form ID
 	 *
 	 * @access public
-	 * @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
@@ -850,7 +850,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 = '' ) {
@@ -1503,9 +1503,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 ) {
 

future/_mocks.php

Doc Comments +4 added lines

@@ -10,6 +10,7 @@ 
  * @internal
  * @since 2.0
  *
+ * @param \GravityView_View_Data $_this
  * @return array|false The old array data, or false on error.
  */
 function GravityView_View_Data_add_view( $view_id, $atts, $_this ) {
@@ -62,6 +63,8 @@ 
  * @internal
  * @since 2.0
  *
+ * @param integer $form_id
+ * @param integer $count
  * @return array The old associative array data as returned by
  *  \GravityView_frontend::get_view_entries(), the paging parameters
  *  and a total count of all entries.
@@ -155,6 +158,7 @@ 
  * @internal
  * @since 2.0
  *
+ * @param string $format
  * @return null|string The value of a field in an entry.
  */
 function GravityView_API_field_value( $entry, $field_settings, $format ) {

future/includes/class-gv-entry-gravityforms.php

Doc Comments +1 added lines, -1 removed lines

@@ -102,7 +102,7 @@
 	 *
 	 * @param array $entry The array ID.
 	 *
-	 * @return \GV\Entry|null An instance of this entry or null if not found.
+	 * @return null|GF_Entry An instance of this entry or null if not found.
 	 */
 	public static function from_entry( $entry ) {
 		if ( empty( $entry['id'] ) ) {

future/includes/class-gv-extension.php

Doc Comments +2 added lines, -2 removed lines

@@ -207,7 +207,7 @@ 
 	 * - Checks PHP version numbers
 	 * - Sets self::$is_compatible[__CLASS__] to boolean value
 	 *
-	 * @return boolean Is the extension supported?
+	 * @return boolean|null Is the extension supported?
 	 */
 	protected function is_extension_supported() {
 
@@ -329,7 +329,7 @@ 
 	/**
 	 * Add a notice to be displayed in the admin.
 	 *
-	 * @param array $notice Array with `class` and `message` keys. The message is not escaped.
+	 * @param string $notice Array with `class` and `message` keys. The message is not escaped.
 	 *
 	 * @return void
 	 */

future/includes/class-gv-field-gravityforms.php

Doc Comments +1 added lines, -1 removed lines

@@ -54,7 +54,7 @@
 	 * @param \GV\GF_Form $form The Gravity Form form.
 	 * @param int $field_id The Gravity Form field ID for the $form.
 	 *
-	 * @return \GV\Field|null The requested field or null if not found.
+	 * @return null|GF_Field The requested field or null if not found.
 	 */
 	public static function by_id( $form, $field_id ) {
 

future/includes/class-gv-form-gravityforms.php

Doc Comments +1 added lines, -3 removed lines

@@ -132,10 +132,8 @@
 	/**
 	 * Get a \GV\Field by Form and Field ID for this data source.
 	 *
-	 * @param \GV\GF_Form $form The Gravity Form form ID.
-	 * @param int $field_id The Gravity Form field ID for the $form_id.
 	 *
-	 * @return \GV\Field|null The requested field or null if not found.
+	 * @return null|GF_Field The requested field or null if not found.
 	 */
 	public static function get_field( /** varargs */ ) {
 		$args = func_get_args();

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

Doc Comments +4 added lines, -2 removed lines

@@ -350,7 +350,7 @@ 
 	 * Generate the status message box HTML based on the current status
 	 *
 	 * @since 1.7.4
-	 * @param $message
+	 * @param string $message
 	 * @param string $class
 	 *
 	 * @return string
@@ -470,6 +470,9 @@ 
 		$this->settings->update( $settings );
 	}
 
+	/**
+	 * @param boolean $echo
+	 */
 	public function settings_edd_license_activation( $field, $echo ) {
 		$script_debug = ( defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG ) ? '' : '.min';
 
@@ -569,7 +572,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.php

Doc Comments +1 added lines, -1 removed lines

@@ -64,7 +64,7 @@
 	 * Set an setting.
 	 *
 	 * @param mixed $key The key in this setting to retrieve.
-	 * @param mixed $default A default in case the key is not set. 
+	 * @param false|null $default A default in case the key is not set. 
 	 *
 	 * @api
 	 * @since 2.0

future/includes/class-gv-shortcode-gravityview.php

Doc Comments -1 removed lines

@@ -174,7 +174,6 @@
 	 * @param \GV\View $view The View.
 	 * @param \GV\Entry_Collection $entries The calculated entries.
 	 * @param array $atts The shortcode attributes (with defaults).
-	 * @param array $view_atts A quirky compatibility parameter where we get the unaltered view atts.
 	 *
 	 * @return string The output.
 	 */