Completed
Pull Request — master (#139)
by
unknown
08:56
created

helpers.php ➔ write_wpghs_link()   B

Complexity

Conditions 7
Paths 15

Size

Total Lines 54
Code Lines 41

Duplication

Lines 16
Ratio 29.63 %

Code Coverage

Tests 0
CRAP Score 56

Importance

Changes 4
Bugs 0 Features 2
Metric Value
cc 7
eloc 41
c 4
b 0
f 2
nc 15
nop 1
dl 16
loc 54
ccs 0
cts 0
cp 0
crap 56
rs 7.8331

How to fix   Long Method   

Long Method

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:

1
<?php
2
/**
3
 * Theme helper functions.
4
 *
5
 * @package WordPress_GitHub_SYnc
6
 */
7
8
/**
9
 * Returns the HTML markup to view the current post on GitHub.
10
 *
11
 * @return string
12
 */
13
function get_the_github_view_link() {
14 1
	return '<a href="' . get_the_github_view_url() . '">' . apply_filters( 'wpghs_view_link_text', 'View this post on GitHub.' ) . '</a>';
15
}
16
add_shortcode( 'get_the_github_view_link', 'get_the_github_view_link' );
17
18
/**
19
 * Returns the URL to view the current post on GitHub.
20
 *
21
 * @return string
22
 */
23 2
function get_the_github_view_url() {
24
	$wpghs_post = new WordPress_GitHub_Sync_Post( get_the_ID(), WordPress_GitHub_Sync::$instance->api() );
25 2
26
	return $wpghs_post->github_view_url();
27
}
28
add_shortcode( 'get_the_github_view_url', 'get_the_github_view_url' );
29
30
/**
31
 * Returns the HTML markup to edit the current post on GitHub.
32
 *
33
 * @return string
34 1
 */
35
function get_the_github_edit_link() {
36
	return '<a href="' . get_the_github_edit_url() . '">' . apply_filters( 'wpghs_edit_link_text', 'Edit this post on GitHub.' ) . '</a>';
37
}
38
add_shortcode( 'get_the_github_edit_link', 'get_the_github_edit_link' );
39
40
/**
41
 * Returns the URL to edit the current post on GitHub.
42
 *
43 2
 * @return string
44
 */
45 2
function get_the_github_edit_url() {
46
	$wpghs_post = new WordPress_GitHub_Sync_Post( get_the_ID(), WordPress_GitHub_Sync::$instance->api() );
47
48
	return $wpghs_post->github_edit_url();
49
}
50
add_shortcode( 'get_the_github_edit_url', 'get_the_github_edit_url' );
51
52
53
/**
54
 * EXAMPLE FROM https://codex.wordpress.org/Shortcode_API
55
 * // [bartag foo="foo-value"]
56
 * function bartag_func( $atts ) {
57
 *	 $a = shortcode_atts( array(
58
 *		 'foo' => 'something',
59
 *		 'bar' => 'something else',
60
 *	 ), $atts );
61
 * 
62
 *	 return "foo = {$a['foo']}";
63
 * }
64
 * add_shortcode( 'bartag', 'bartag_func' );
65
 */
66
67
/**
68
 * Function with attributes
69
 *   - type: 'link' (default) to return a HTML anchor tag with text, or 'url' for bare URL.
70
 *   - target: 'view' (default) or 'edit' to return the respective link/url.
71
 *   - text: text to be included in the link. Ignored if type='url'.
72
 * 
73
 * Returns either a HTML formatted anchor tag or the bare URL of the current post on GitHub.
74
 *
75
 * @return string
76
 */
77
function write_wpghs_link( $atts ) {
78
79
	$args = shortcode_atts(
80
		array(
81
			'type'   => 'link',
82
			'target' => 'view',
83
			'text'   => '',
84
		),
85
		$atts
86
	);
87
	$type   = esc_attr( $args['type'] );
88
	$target = esc_attr( $args['target'] );
89
	$text   = esc_attr( $args['text'] );
90
91
	$output = '';
92
93
	switch( $target ) {
0 ignored issues
show
introduced by
Space after opening control structure is required
Loading history...
introduced by
No space before opening parenthesis is prohibited
Loading history...
94 View Code Duplication
		case 'view': 
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
95
			$getter = get_the_github_view_url();
96
			if(!empty( $text )) {
0 ignored issues
show
introduced by
Space after opening control structure is required
Loading history...
introduced by
No space before opening parenthesis is prohibited
Loading history...
introduced by
No space after opening parenthesis is prohibited
Loading history...
introduced by
Expected 1 space before "!"; 0 found
Loading history...
introduced by
Expected 1 space after "!"; 0 found
Loading history...
introduced by
No space before closing parenthesis is prohibited
Loading history...
97
				$linktext = $text;
98
			} else {
99
				$linktext = 'View this post on GitHub';
100
			}
101
			break;
102 View Code Duplication
		case 'edit': 
0 ignored issues
show
Duplication introduced by
This code seems to be duplicated across your project.

Duplicated code is one of the most pungent code smells. If you need to duplicate the same code in three or more different places, we strongly encourage you to look into extracting the code into a single class or operation.

You can also find more detailed suggestions in the “Code” section of your repository.

Loading history...
103
			$getter = get_the_github_edit_url();
104
			if( !empty( $text ) ) {
0 ignored issues
show
introduced by
Space after opening control structure is required
Loading history...
introduced by
No space before opening parenthesis is prohibited
Loading history...
introduced by
Expected 1 space after "!"; 0 found
Loading history...
105
				$linktext = $text;
106
			} else {
107
				$linktext = 'Edit this post on GitHub';
108
			}
109
			break;
110
		default:
111
			$getter = get_the_github_view_url();
112
			$linktext = 'View this post on GitHub';
113
			break;
114
	}
115
116
	switch( $type ) {
0 ignored issues
show
introduced by
Space after opening control structure is required
Loading history...
introduced by
No space before opening parenthesis is prohibited
Loading history...
117
		case 'link': 
118
			$output .= '<a href="' . $getter . '">' . $linktext . '</a>';
119
			break;
120
		case 'url': 
121
			$output .= $getter;
122
			break;
123
		default:
124
			$output .= '<a href="' . $getter . '">' . $linktext . '</a>';
125
			break;
126
	}
127
128
	return $output;
129
130
}
131
add_shortcode( 'wpghs', 'write_wpghs_link' );
132