Automattic / jetpack

projects/plugins/jetpack/modules/contact-form/grunion-contact-form.php

Doc Comments +48 added lines, -2 removed lines

@@ -352,6 +352,9 @@ 
 		return Grunion_Contact_Form::parse( $atts, do_blocks( $content ) );
 	}
 
+	/**
+	 * @param string $type
+	 */
 	public static function block_attributes_to_shortcode_attributes( $atts, $type ) {
 		$atts['type'] = $type;
 		if ( isset( $atts['className'] ) ) {
@@ -403,6 +406,10 @@ 
 		$atts = self::block_attributes_to_shortcode_attributes( $atts, 'checkbox-multiple' );
 		return Grunion_Contact_Form::parse_contact_field( $atts, $content );
 	}
+
+	/**
+	 * @param string $content
+	 */
 	public static function gutenblock_render_field_radio( $atts, $content ) {
 		$atts = self::block_attributes_to_shortcode_attributes( $atts, 'radio' );
 		return Grunion_Contact_Form::parse_contact_field( $atts, $content );
@@ -2045,7 +2052,6 @@ 
 	 *
 	 * @see ::style()
 	 * @internal
-	 * @param bool $style
 	 */
 	static function _style_on() {
 		return self::style( true );
@@ -2236,6 +2242,7 @@ 
 	 *
 	 * @param int                         $feedback_id
 	 * @param object Grunion_Contact_Form $form
+	 * @param Grunion_Contact_Form $form
 	 *
 	 * @return string $message
 	 */
@@ -2394,7 +2401,7 @@ 
 	 *
 	 * @param array       $attributes Key => Value pairs as parsed by shortcode_parse_atts()
 	 * @param string|null $content The shortcode's inner content: [contact-field]$content[/contact-field]
-	 * @return HTML for the contact form field
+	 * @return string for the contact form field
 	 */
 	static function parse_contact_field( $attributes, $content ) {
 		// Don't try to parse contact form fields if not inside a contact form
@@ -3523,6 +3530,9 @@ 
 
 	}
 
+	/**
+	 * @param string $type
+	 */
 	function render_input_field( $type, $id, $value, $class, $placeholder, $required ) {
 		return "<input
 					type='". esc_attr( $type ) ."'
@@ -3534,24 +3544,40 @@ 
 				/>\n";
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_email_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'email', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'email', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_telephone_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'telephone', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'tel', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_url_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'url', $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'url', $id, $value, $class, $placeholder, $required );
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_textarea_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 		$field = $this->render_label( 'textarea', 'contact-form-comment-' . $id, $label, $required, $required_field_text );
 		$field .= "<textarea
@@ -3566,6 +3592,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_radio_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3587,6 +3616,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = "<label class='grunion-field-label checkbox" . ( $this->is_error() ? ' form-error' : '' ) . "'>";
 			$field .= "\t\t<input type='checkbox' name='" . esc_attr( $id ) . "' value='" . esc_attr__( 'Yes', 'jetpack' ) . "' " . $class . checked( (bool) $value, true, false ) . ' ' . ( $required ? "required aria-required='true'" : '' ) . "/> \n";
@@ -3619,6 +3651,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_checkbox_multiple_field( $id, $label, $value, $class, $required, $required_field_text  ) {
 		$field = $this->render_label( '', $id, $label, $required, $required_field_text );
 		foreach ( (array) $this->get_attribute( 'options' ) as $optionIndex => $option ) {
@@ -3634,6 +3669,9 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 */
 	function render_select_field( $id, $label, $value, $class, $required, $required_field_text ) {
 		$field = $this->render_label( 'select', $id, $label, $required, $required_field_text );
 		$field  .= "\t<select name='" . esc_attr( $id ) . "' id='" . esc_attr( $id ) . "' " . $class . ( $required ? "required aria-required='true'" : '' ) . ">\n";
@@ -3651,6 +3689,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_date_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder ) {
 
 		$field = $this->render_label( 'date', $id, $label, $required, $required_field_text );
@@ -3681,6 +3723,10 @@ 
 		return $field;
 	}
 
+	/**
+	 * @param string $class
+	 * @param string $placeholder
+	 */
 	function render_default_field( $id, $label, $value, $class, $required, $required_field_text, $placeholder, $type ) {
 		$field = $this->render_label( $type, $id, $label, $required, $required_field_text );
 		$field .= $this->render_input_field( 'text', $id, $value, $class, $placeholder, $required );