MarkdownText::MarkdownAsJS() - Code Metrics - Inspection of "Merge branch 'feature/markdown-as-json'" - robbieaverill/silverstripe-markdowntextareafield - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 063230...c40392 )

by Robbie

created 2016-04-21 04:47 UTC

MarkdownText::MarkdownAsJS() A

↳ Parent: MarkdownText

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	1
Bugs	0	Features	1

Metric	Value
c	1
b	0
f	1
dl	0
loc	4
rs	10
cc	1
eloc	2
nc	1
nop	0

<?php
/**
 * Represents a large text field that contains HTML and Markdown content.
 * Markdown gets processed automatically to HTML in templates
 */
class MarkdownText extends HTMLText
namespace YourVendor;

class YourClass { }
{
    /**
     * Define the casting for field names and types
     * @var array
     */
    public static $casting = array(
        'MarkdownAsHTML'        =>  'MarkdownText',
        'MarkdownExtraAsHTML'   =>  'MarkdownText',
    );

    /**
     * Returns Markdown content as HTML for templates
     * @return string HTML
     */
    public function forTemplate()
    {
        return $this->MarkdownAsHTML();
    }

    /**
     * Return Markdown content as HTML
     * @return string HTML
     */
    public function MarkdownAsHTML()
    {
        $parser = new MarkdownParser($this->value);
        return $parser->parse();
    }

    /**
     * Return MarkdownExtra content as HTML
     * @return string HTML
     */
    public function MarkdownExtraAsHTML()
    {
        $parser = new MarkdownParser($this->value);
        return $parser->parseExtra();
    }

    /**
     * Return Markdown content as JSON encoded HTML
     * @return string JSON
     */
    public function MarkdownAsJS()
    {
        return Convert::raw2json($this->MarkdownAsHTML());
    }

    /**
     * Return MarkdownExtra content as JSON encoded HTML
     * @return string JSON
     */
    public function MarkdownExtraAsJS()
    {
        return Convert::raw2json($this->MarkdownExtraAsHTML());
    }

    /**
     * Return an instance of the MarkdownTextareaField
     * @param  string $title

     * @param  array  $params

     * @return MarkdownTextareaField
     */
    public function scaffoldFormField($title = null, $params = null)
    {
        return new MarkdownTextareaField($this->name, $title);
    }
}


1			<?php
2			/**
3			* Represents a large text field that contains HTML and Markdown content.
4			* Markdown gets processed automatically to HTML in templates
5			*/
6			class MarkdownText extends HTMLText
			0 ignored issues – show Coding Style Compatibility introduced 2016-03-17 18:28 UTC by Report Bug Copy Issue Report PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions. You can fix this by adding a namespace to your class: namespace YourVendor; class YourClass { } When choosing a vendor namespace, try to pick something that is not too generic to avoid conflicts with other libraries. Loading history...
7			{
8			/**
9			* Define the casting for field names and types
10			* @var array
11			*/
12			public static $casting = array(
13			'MarkdownAsHTML' => 'MarkdownText',
14			'MarkdownExtraAsHTML' => 'MarkdownText',
15			);
16
17			/**
18			* Returns Markdown content as HTML for templates
19			* @return string HTML
20			*/
21			public function forTemplate()
22			{
23			return $this->MarkdownAsHTML();
24			}
25
26			/**
27			* Return Markdown content as HTML
28			* @return string HTML
29			*/
30			public function MarkdownAsHTML()
31			{
32			$parser = new MarkdownParser($this->value);
33			return $parser->parse();
34			}
35
36			/**
37			* Return MarkdownExtra content as HTML
38			* @return string HTML
39			*/
40			public function MarkdownExtraAsHTML()
41			{
42			$parser = new MarkdownParser($this->value);
43			return $parser->parseExtra();
44			}
45
46			/**
47			* Return Markdown content as JSON encoded HTML
48			* @return string JSON
49			*/
50			public function MarkdownAsJS()
51			{
52			return Convert::raw2json($this->MarkdownAsHTML());
53			}
54
55			/**
56			* Return MarkdownExtra content as JSON encoded HTML
57			* @return string JSON
58			*/
59			public function MarkdownExtraAsJS()
60			{
61			return Convert::raw2json($this->MarkdownExtraAsHTML());
62			}
63
64			/**
65			* Return an instance of the MarkdownTextareaField
66			* @param string $title
			0 ignored issues – show Documentation introduced 2016-03-17 18:28 UTC by Report Bug Copy Issue Report Should the type for parameter `$title` not be `string\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
67			* @param array $params
			0 ignored issues – show Documentation introduced 2016-03-17 18:28 UTC by Report Bug Copy Issue Report Should the type for parameter `$params` not be `array\|null`? This check looks for `@param` annotations where the type inferred by our type inference engine differs from the declared type. It makes a suggestion as to what type it considers more descriptive. Most often this is a case of a parameter that can be null in addition to its declared types. Loading history...
68			* @return MarkdownTextareaField
69			*/
70			public function scaffoldFormField($title = null, $params = null)
71			{
72			return new MarkdownTextareaField($this->name, $title);
73			}
74			}
75

robbieaverill / silverstripe-markdowntextareafield

Push — master ( 063230...c40392 )

MarkdownText::MarkdownAsJS() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like