Automattic /
jetpack
| Conditions | 9 |
| Paths | 98 |
| Total Lines | 76 |
| Lines | 0 |
| Ratio | 0 % |
| Changes | 0 | ||
Small methods make your code easier to understand, in particular if combined with a good name. Besides, if your method is small, finding a good name is usually much easier.
For example, if you find yourself adding comments to a method's body, this is usually a good sign to extract the commented part to a new method, and use the comment as a starting point when coming up with a good name for this new method.
Commonly applied refactorings include:
If many parameters/temporary variables are present:
| 1 | <?php |
||
| 97 | function render_amp_pin( $attr ) { |
||
| 98 | $info = null; |
||
| 99 | if ( preg_match( URL_PATTERN, $attr['url'], $matches ) ) { |
||
| 100 | $info = fetch_pin_info( $matches['pin_id'] ); |
||
| 101 | } |
||
| 102 | |||
| 103 | if ( is_array( $info ) ) { |
||
| 104 | $image = $info['images']['237x']; |
||
| 105 | $title = isset( $info['rich_metadata']['title'] ) ? $info['rich_metadata']['title'] : null; |
||
| 106 | $description = isset( $info['rich_metadata']['description'] ) ? $info['rich_metadata']['description'] : null; |
||
| 107 | |||
| 108 | // This placeholder will appear while waiting for the amp-pinterest component to initialize (or if it fails to initialize due to JS being disabled). |
||
| 109 | $placeholder = sprintf( |
||
| 110 | // The AMP_Img_Sanitizer will convert his to <amp-img> while also supplying `noscript > img` as fallback when JS is disabled. |
||
| 111 | '<a href="%s" placeholder><img src="%s" alt="%s" layout="fill" object-fit="contain" object-position="top left"></a>', |
||
| 112 | esc_url( $attr['url'] ), |
||
| 113 | esc_url( $image['url'] ), |
||
| 114 | esc_attr( $title ) |
||
| 115 | ); |
||
| 116 | |||
| 117 | $amp_padding = 5; // See <https://github.com/ampproject/amphtml/blob/b5dea36e0b8bd012585d50839766a084f99a3685/extensions/amp-pinterest/0.1/amp-pinterest.css#L269>. |
||
| 118 | $amp_fixed_width = 237; // See <https://github.com/ampproject/amphtml/blob/b5dea36e0b8bd012585d50839766a084f99a3685/extensions/amp-pinterest/0.1/amp-pinterest.css#L270>. |
||
| 119 | $pin_info_height = 60; // Minimum Obtained by measuring the height of the .-amp-pinterest-embed-pin-text element. |
||
| 120 | |||
| 121 | // Add height based on how much description there is. There are roughly 30 characters on a line of description text. |
||
| 122 | $has_description = false; |
||
| 123 | if ( ! empty( $info['description'] ) ) { |
||
| 124 | $desc_padding_top = 5; // See <https://github.com/ampproject/amphtml/blob/b5dea36e0b8bd012585d50839766a084f99a3685/extensions/amp-pinterest/0.1/amp-pinterest.css#L342>. |
||
| 125 | $pin_info_height += $desc_padding_top; |
||
| 126 | |||
| 127 | // Trim whitespace on description if there is any left, use to calculate the likely rows of text. |
||
| 128 | $description = trim( $info['description'] ); |
||
| 129 | if ( strlen( $description ) > 0 ) { |
||
| 130 | $has_description = true; |
||
| 131 | $desc_line_height = 17; // See <https://github.com/ampproject/amphtml/blob/b5dea36e0b8bd012585d50839766a084f99a3685/extensions/amp-pinterest/0.1/amp-pinterest.css#L341>. |
||
| 132 | $pin_info_height += ceil( strlen( $description ) / 30 ) * $desc_line_height; |
||
| 133 | } |
||
| 134 | } |
||
| 135 | |||
| 136 | if ( ! empty( $info['repin_count'] ) ) { |
||
| 137 | $pin_stats_height = 16; // See <https://github.com/ampproject/amphtml/blob/b5dea36e0b8bd012585d50839766a084f99a3685/extensions/amp-pinterest/0.1/amp-pinterest.css#L322>. |
||
| 138 | $pin_info_height += $pin_stats_height; |
||
| 139 | } |
||
| 140 | |||
| 141 | // When Pin description is empty, make sure title and description from rich metadata are supplied for accessibility and discoverability. |
||
| 142 | $title = $has_description ? '' : implode( "\n", array_filter( array( $title, $description ) ) ); |
||
| 143 | |||
| 144 | $amp_pinterest = sprintf( |
||
| 145 | '<amp-pinterest style="%1$s" data-do="embedPin" data-url="%2$s" width="%3$d" height="%4$d" title="%5$s">%6$s</amp-pinterest>', |
||
| 146 | esc_attr( 'line-height:1.5; font-size:21px' ), // Override styles from theme due to precise height calculations above. |
||
| 147 | esc_url( $attr['url'] ), |
||
| 148 | $amp_fixed_width + ( $amp_padding * 2 ), |
||
| 149 | $image['height'] + $pin_info_height + ( $amp_padding * 2 ), |
||
| 150 | esc_attr( $title ), |
||
| 151 | $placeholder |
||
| 152 | ); |
||
| 153 | } else { |
||
| 154 | // Fallback embed when info is not available. |
||
| 155 | $amp_pinterest = sprintf( |
||
| 156 | '<amp-pinterest data-do="embedPin" data-url="%1$s" width="%2$d" height="%3$d">%4$s</amp-pinterest>', |
||
| 157 | esc_url( $attr['url'] ), |
||
| 158 | 450, // Fallback width. |
||
| 159 | 750, // Fallback height. |
||
| 160 | sprintf( |
||
| 161 | '<a placeholder href="%s">%s</a>', |
||
| 162 | esc_url( $attr['url'] ), |
||
| 163 | esc_html( $attr['url'] ) |
||
| 164 | ) |
||
| 165 | ); |
||
| 166 | } |
||
| 167 | |||
| 168 | return sprintf( |
||
| 169 | '<div class="wp-block-jetpack-pinterest">%s</div>', |
||
| 170 | $amp_pinterest |
||
| 171 | ); |
||
| 172 | } |
||
| 173 | |||
| 190 |
Loading history...
This check compares calls to functions or methods with their respective definitions. If the call has more arguments than are defined, it raises an issue.
If a function is defined several times with a different number of parameters, the check may pick up the wrong definition and report false positives. One codebase where this has been known to happen is Wordpress.
In this case you can add the
@ignorePhpDoc annotation to the duplicate definition and it will be ignored.