helpers.php ➔ write_wpghs_link() - Code Metrics - Inspection of "added shortcodes for direct use in posts" - mAAdhaTTah/wordpress-github-sync - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Pull Request — master (#139)

unknown

created 2016-05-25 13:28 UTC

helpers.php ➔ write_wpghs_link() A

↳ Parent: Project

Complexity

Conditions	3
Paths	3

Size

Total Lines	23
Code Lines	16

Duplication

Lines	0
Ratio	0 %

Code Coverage

Tests	0
CRAP Score	12

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
cc	3
eloc	16
nc	3
nop	1
dl	0
loc	23
ccs	0
cts	0
cp	0
crap	12
rs	9.0856
c	1
b	0
f	1

<?php
/**
 * Theme helper functions.
 *
 * @package WordPress_GitHub_SYnc
 */

/**
 * Returns the HTML markup to view the current post on GitHub.
 *
 * @return string
 */
function get_the_github_view_link() {
	return '<a href="' . get_the_github_view_url() . '">' . apply_filters( 'wpghs_view_link_text', 'View this post on GitHub.' ) . '</a>';
}
add_shortcode( 'get_the_github_view_link', 'get_the_github_view_link' );

/**
 * Returns the URL to view the current post on GitHub.
 *
 * @return string
 */
function get_the_github_view_url() {
	$wpghs_post = new WordPress_GitHub_Sync_Post( get_the_ID(), WordPress_GitHub_Sync::$instance->api() );

	return $wpghs_post->github_view_url();
}
add_shortcode( 'get_the_github_view_url', 'get_the_github_view_url' );

/**
 * Returns the HTML markup to edit the current post on GitHub.
 *
 * @return string
 */
function get_the_github_edit_link() {
	return '<a href="' . get_the_github_edit_url() . '">' . apply_filters( 'wpghs_edit_link_text', 'Edit this post on GitHub.' ) . '</a>';
}
add_shortcode( 'get_the_github_edit_link', 'get_the_github_edit_link' );

/**
 * Returns the URL to edit the current post on GitHub.
 *
 * @return string
 */
function get_the_github_edit_url() {
	$wpghs_post = new WordPress_GitHub_Sync_Post( get_the_ID(), WordPress_GitHub_Sync::$instance->api() );

	return $wpghs_post->github_edit_url();
}
add_shortcode( 'get_the_github_edit_url', 'get_the_github_edit_url' );


/**
 * EXAMPLE FROM https://codex.wordpress.org/Shortcode_API
 * // [bartag foo="foo-value"]
 * function bartag_func( $atts ) {
 *     $a = shortcode_atts( array(
 *         'foo' => 'something',
 *         'bar' => 'something else',
 *     ), $atts );
 * 
 *     return "foo = {$a['foo']}";
 * }
 * add_shortcode( 'bartag', 'bartag_func' );
*/

/**
 * Function with attributes
 *   - type: 'link' to return a HTML anchor tag with text, or 'url' for bare URL.
 *   - text: text to be included in the link. Ignored if type='url'.
 * 
 * Returns either a HTML formatted anchor tag or the bare URL of the current post on GitHub.
 *
 * @return string
 */
function write_wpghs_link( $atts ) {

   extract(shortcode_atts(array(

       "type" => 'link',
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
       "text" => 'View this post on GitHub.'
<?php

$singleQuoted = 'Value';
$doubleQuoted = "\tSingle is $singleQuoted";

print $doubleQuoted;
   ), $atts));


   $output = '';


   switch($type) {

      case 'link':

         $output .= '<a href="' . get_the_github_view_url() . '">' . apply_filters( 'wpghs_view_link_text', $text ) . '</a>';

         break;

      case 'url':

         $output .= get_the_github_view_url();

         break;

      default:

         $output .= get_the_github_view_url();

   }


   return $output;


}
add_shortcode( 'wpghs', 'write_wpghs_link' );


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' to return a HTML anchor tag with text, or 'url' for bare URL.
70		* - text: text to be included in the link. Ignored if type='url'.
71		*
72		* Returns either a HTML formatted anchor tag or the bare URL of the current post on GitHub.
73		*
74		* @return string
75		*/
76		function write_wpghs_link( $atts ) {
77
78		extract(shortcode_atts(array(
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report extract() usage is highly discouraged, due to the complexity and unintended issues it might cause. Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected at least 1 tabs, found 0 Loading history...
79		"type" => 'link',
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style Comprehensibility introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report The string literal `type` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history...
80		"text" => 'View this post on GitHub.'
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style Comprehensibility introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report The string literal `text` does not require double quotes, as per coding-style, please use single quotes. PHP provides two ways to mark string literals. Either with single quotes `'literal'` or with double quotes `"literal"`. The difference between these is that string literals in double quotes may contain variables with are evaluated at run-time as well as escape sequences. String literals in single quotes on the other hand are evaluated very literally and the only two characters that needs escaping in the literal are the single quote itself (`\'`) and the backslash (`\\`). Every other character is displayed as is. Double quoted string literals may contain other variables or more complex escape sequences. <?php $singleQuoted = 'Value'; $doubleQuoted = "\tSingle is $singleQuoted"; print $doubleQuoted; will print an indented: `Single is Value` If your string literal does not contain variables or escape sequences, it should be defined using single quotes to make that fact clear. For more information on PHP string literals and available escape sequences see the PHP core documentation. Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Each line in an array declaration must end in a comma Loading history...
81		), $atts));
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history...
82
83		$output = '';
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history...
84
85		switch($type) {
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Space after opening control structure is required Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report No space before opening parenthesis is prohibited Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report No space after opening parenthesis is prohibited Loading history... introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report No space before closing parenthesis is prohibited Loading history...
86		case 'link':
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 1 tabs, found 1 Loading history...
87		$output .= '<a href="' . get_the_github_view_url() . '">' . apply_filters( 'wpghs_view_link_text', $text ) . '</a>';
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected at least 2 tabs, found 2 Loading history...
88		break;
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history...
89		case 'url':
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 2 tabs, found 1 Loading history...
90		$output .= get_the_github_view_url();
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected at least 3 tabs, found 2 Loading history...
91		break;
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history...
92		default:
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 2 tabs, found 1 Loading history...
93		$output .= get_the_github_view_url();
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected at least 3 tabs, found 2 Loading history...
94		}
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected 1 tabs, found 0 Loading history...
95
96		return $output;
		0 ignored issues – show Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Tabs must be used to indent lines; spaces are not allowed Loading history... Coding Style introduced 2016-05-25 13:22 UTC by Report Bug Copy Issue Report Line indented incorrectly; expected at least 1 tabs, found 0 Loading history...
97
98		}
99		add_shortcode( 'wpghs', 'write_wpghs_link' );
100

mAAdhaTTah / wordpress-github-sync

Pull Request — master (#139)

helpers.php ➔ write_wpghs_link() A

Complexity

Size

Duplication

Code Coverage

Importance

Duplication Side-by-Side

Filter issues like