SEO_Metadata_SiteTree_DataExtension::MarkupFacebook() - Code Metrics - Inspection of "Removed superfluous markup functions" - Graphiques-Digitale/silverstripe-seo-metadata - Measure and Improve Code Quality continuously with Scrutinizer

Completed

Push — master ( 019a60...ed4f70 )

by Andrew

created 2016-07-17 15:52 UTC

MarkupFacebook() A

↳ Parent: SEO_Metadata_SiteTree_DataExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	7
Code Lines	2

Duplication

Lines	7
Ratio	100 %

Importance

Changes	5
Bugs	0	Features	0

Metric	Value
c	5
b	0
f	0
dl	7
loc	7
rs	9.4285
cc	1
eloc	2
nc	1
nop	3

<?php

/**
 * Extends SiteTree with basic metadata fields, as well as the main `Metadata()` method.
 *
 * @package silverstripe-seo
 * @subpackage metadata
 * @author Andrew Gerber <[email protected]>
 * @version 1.0.0
 *
 */
class SEO_Metadata_SiteTree_DataExtension extends DataExtension
namespace YourVendor;

class YourClass { }
{


    /* Overload Model
    ------------------------------------------------------------------------------*/

    private static $db = array(

        'MetaTitle' => 'Varchar(128)',
        'MetaDescription' => 'Text', // redundant, but included for backwards-compatibility
        'ExtraMeta' => 'HTMLText', // redundant, but included for backwards-compatibility
    );


    /* Overload Methods
    ------------------------------------------------------------------------------*/

    // CMS Fields
    public function updateCMSFields(FieldList $fields)
    {

        // Variables
        $config = SiteConfig::current_site_config();
        $owner = $this->owner;

        // Remove framework default metadata group
        $fields->removeByName(array('Metadata'));

        //// Metadata
        $tab = 'Root.Metadata.SEO';

        // Canonical
        if ($config->CanonicalEnabled()) {
            $fields->addFieldsToTab($tab, array(
                ReadonlyField::create('ReadonlyMetaCanonical', 'link rel="canonical"', $owner->AbsoluteLink())
            ));
        }

        // Title
        if ($config->TitleEnabled()) {
            $fields->addFieldsToTab($tab, array(
                TextField::create('MetaTitle', 'meta title')
                    ->setAttribute('placeholder', $owner->GenerateTitle())
            ));
        }

        // Description
        $fields->addFieldsToTab($tab, array(
            TextareaField::create('MetaDescription', 'meta description')
                ->setAttribute('placeholder', $owner->GenerateDescriptionFromContent())
        ));

        // ExtraMeta
        if ($config->ExtraMetaEnabled()) {
            $fields->addFieldsToTab($tab, array(
                TextareaField::create('ExtraMeta', 'Custom Metadata')
            ));
        }

        //// Full Output

        $tab = 'Root.Metadata.FullOutput';

        // monospaced, HTML SEO output
        $fields->addFieldsToTab($tab, array(
            LiteralField::create('HeaderMetadata', '<pre class="bold">$Metadata()</pre>'),
            LiteralField::create('LiteralMetadata', '<pre>' . nl2br(htmlentities(trim($owner->Metadata()), ENT_QUOTES)) . '</pre>')
        ));

    }

    /**
     * Main function to format & output metadata as an HTML string.
     *
     * Use the `updateMetadata($config, $owner, $metadata)` update hook when extending `DataExtension`s.
     *
     * @return string
     */
    public function Metadata()
    {

        // variables
        $config = SiteConfig::current_site_config();
        $owner = $this->owner;

        // begin SEO
        $metadata = PHP_EOL . $owner->MarkupComment('SEO');

        // metadata
        $metadata .= $owner->MarkupComment('Metadata');

        // charset
        if ($config->CharsetEnabled()) {
            $metadata .= '<meta charset="' . $config->Charset() . '" />' . PHP_EOL;
        }

        // canonical
        if ($config->CanonicalEnabled()) {
            $metadata .= $owner->MarkupLink('canonical', $owner->AbsoluteLink());
        }

        // title
        if ($config->TitleEnabled()) {

            // ternary operation
            // @todo Check what is going here ?!
            $title = ($owner->MetaTitle) ? $owner->MetaTitle : $owner->GenerateTitle();
            //
            $metadata .= '<title>' . htmlentities($title, ENT_QUOTES, $config->Charset()) . '</title>' . PHP_EOL;

        }

        // description
        $metadata .= $owner->MarkupMeta('description', $owner->GenerateDescription(), true, $config->Charset());

        //// ExtraMeta

        if ($config->ExtraMetaEnabled()) {
            if ($extraMeta = $owner->ExtraMeta != '') {
$myVar = 'Value';
$higher = false;

if (rand(1, 6) > 3) {
    $higher = true;
} else {
    $higher = false;
}
                $metadata .= $owner->MarkupComment('Extra Metadata');
                $metadata .= $owner->ExtraMeta . PHP_EOL;
            }
        }

        //// extension update hook
        $owner->extend('updateMetadata', $config, $owner, $metadata);

        // end
        $metadata .= $owner->MarkupComment('END SEO');

        // return
        return $metadata;

    }


    /* Helper Methods
    ------------------------------------------------------------------------------*/

    /**
     * Returns a given string as a HTML comment.
     *
     * @var string $comment
     *
     * @return string
     */
    public function MarkupComment($comment)
    {

        // return
        return '<!-- ' . $comment . ' -->' . PHP_EOL;

    }

    /**
     * Returns markup for a HTML meta element.
     *
     * @var string $name
     * @var string $content
     * @var bool $encode
     *
     * @return string
     */
    public function MarkupMeta($name, $content, $encode = false)
    {

        // return
        return '<meta name="' . $name . '" content="' . $this->encodeContent($content, $encode) . '" />' . PHP_EOL;

    }

    /**
     * Returns markup for a HTML link element.
     *
     * @param string $rel
     * @param string $href
     * @param string $type
     * @param string $sizes
     *
     * @return string
     */
    public function MarkupLink($rel, $href, $type = '', $sizes = '')
    {
        // start fragment
        $return = '<link rel="' . $rel . '" href="' . $href . '"';
        // if type
        if ($type) {
            $return .= ' type="' . $type . '"';
        }
        // if sizes
        if ($sizes) {
            $return .= ' sizes="' . $sizes . '"';
        }
        // end fragment
        $return .= ' />' . PHP_EOL;
        // return
        return $return;
    }


    /* Meta Methods
    ------------------------------------------------------------------------------*/

    /**
     * Generates HTML title based on configuration settings.
     *
     * @return bool|string
     */
    public function GenerateTitle()
    {

        // return SEO title or false
        return SiteConfig::current_site_config()->GenerateTitle($this->owner->Title);

    }

    /**
     * Returns description from the page `MetaDescription`, or the first paragraph of the `Content` attribute.
     *
     * @return bool|string
     */
    public function GenerateDescription()
    {

        if ($this->owner->MetaDescription) {
            return $this->owner->MetaDescription;
        } else {
            return $this->owner->GenerateDescriptionFromContent();
        }

    }

    /**
     * Generates description from the first paragraph of the `Content` attribute.
     *
     * @return bool|string
     */
    public function GenerateDescriptionFromContent()
    {

        if ($content = trim($this->owner->Content)) {

            // pillage first paragraph from page content
            if (preg_match('/<p>(.*?)<\/p>/i', $content, $match)) {
                // is HTML
                $content = $match[0];
            } else {
                // is plain text
                $content = explode("\n", $content);
                $content = $content[0];
            }

            // decode (no harm done) & return
            return trim(html_entity_decode(strip_tags($content)));

        } else {
            // none
            return false;
        }

    }

    /**
     * Returns a plain or HTML-encoded string according to the current charset & encoding settings.
     *
     * @param string $content
     * @param bool $encode
     *
     * @return string
     */
    public function encodeContent($content, $encode = true) {
        if ($encode) {
            return htmlentities($content, ENT_QUOTES, $this->owner->Charset);
        } else {
            return $content;
        }
    }

}


1			<?php
2
3			/**
4			* Extends SiteTree with basic metadata fields, as well as the main `Metadata()` method.
5			*
6			* @package silverstripe-seo
7			* @subpackage metadata
8			* @author Andrew Gerber <[email protected]>
9			* @version 1.0.0
10			*
11			*/
12			class SEO_Metadata_SiteTree_DataExtension extends DataExtension
			0 ignored issues – show Coding Style Compatibility introduced 2016-07-17 09:43 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...
13			{
14
15
16			/* Overload Model
17			------------------------------------------------------------------------------*/
18
19			private static $db = array(
			0 ignored issues – show Unused Code introduced 2016-07-17 09:43 UTC by Report Bug Copy Issue Report The property `$db` is not used and could be removed. This check marks private properties in classes that are never used. Those properties can be removed. Loading history...
20			'MetaTitle' => 'Varchar(128)',
21			'MetaDescription' => 'Text', // redundant, but included for backwards-compatibility
22			'ExtraMeta' => 'HTMLText', // redundant, but included for backwards-compatibility
23			);
24
25
26			/* Overload Methods
27			------------------------------------------------------------------------------*/
28
29			// CMS Fields
30			public function updateCMSFields(FieldList $fields)
31			{
32
33			// Variables
34			$config = SiteConfig::current_site_config();
35			$owner = $this->owner;
36
37			// Remove framework default metadata group
38			$fields->removeByName(array('Metadata'));
39
40			//// Metadata
41			$tab = 'Root.Metadata.SEO';
42
43			// Canonical
44			if ($config->CanonicalEnabled()) {
45			$fields->addFieldsToTab($tab, array(
46			ReadonlyField::create('ReadonlyMetaCanonical', 'link rel="canonical"', $owner->AbsoluteLink())
47			));
48			}
49
50			// Title
51			if ($config->TitleEnabled()) {
52			$fields->addFieldsToTab($tab, array(
53			TextField::create('MetaTitle', 'meta title')
54			->setAttribute('placeholder', $owner->GenerateTitle())
55			));
56			}
57
58			// Description
59			$fields->addFieldsToTab($tab, array(
60			TextareaField::create('MetaDescription', 'meta description')
61			->setAttribute('placeholder', $owner->GenerateDescriptionFromContent())
62			));
63
64			// ExtraMeta
65			if ($config->ExtraMetaEnabled()) {
66			$fields->addFieldsToTab($tab, array(
67			TextareaField::create('ExtraMeta', 'Custom Metadata')
68			));
69			}
70
71			//// Full Output
72
73			$tab = 'Root.Metadata.FullOutput';
74
75			// monospaced, HTML SEO output
76			$fields->addFieldsToTab($tab, array(
77			LiteralField::create('HeaderMetadata', '<pre class="bold">$Metadata()</pre>'),
78			LiteralField::create('LiteralMetadata', '<pre>' . nl2br(htmlentities(trim($owner->Metadata()), ENT_QUOTES)) . '</pre>')
79			));
80
81			}
82
83			/**
84			* Main function to format & output metadata as an HTML string.
85			*
86			* Use the `updateMetadata($config, $owner, $metadata)` update hook when extending `DataExtension`s.
87			*
88			* @return string
89			*/
90			public function Metadata()
91			{
92
93			// variables
94			$config = SiteConfig::current_site_config();
95			$owner = $this->owner;
96
97			// begin SEO
98			$metadata = PHP_EOL . $owner->MarkupComment('SEO');
99
100			// metadata
101			$metadata .= $owner->MarkupComment('Metadata');
102
103			// charset
104			if ($config->CharsetEnabled()) {
105			$metadata .= '<meta charset="' . $config->Charset() . '" />' . PHP_EOL;
106			}
107
108			// canonical
109			if ($config->CanonicalEnabled()) {
110			$metadata .= $owner->MarkupLink('canonical', $owner->AbsoluteLink());
111			}
112
113			// title
114			if ($config->TitleEnabled()) {
115
116			// ternary operation
117			// @todo Check what is going here ?!
118			$title = ($owner->MetaTitle) ? $owner->MetaTitle : $owner->GenerateTitle();
119			//
120			$metadata .= '<title>' . htmlentities($title, ENT_QUOTES, $config->Charset()) . '</title>' . PHP_EOL;
121
122			}
123
124			// description
125			$metadata .= $owner->MarkupMeta('description', $owner->GenerateDescription(), true, $config->Charset());
126
127			//// ExtraMeta
128
129			if ($config->ExtraMetaEnabled()) {
130			if ($extraMeta = $owner->ExtraMeta != '') {
			0 ignored issues – show Unused Code introduced 2016-07-17 09:43 UTC by Report Bug Copy Issue Report `$extraMeta` is not used, you could remove the assignment. This check looks for variable assignements that are either overwritten by other assignments or where the variable is not used subsequently. $myVar = 'Value'; $higher = false; if (rand(1, 6) > 3) { $higher = true; } else { $higher = false; } Both the `$myVar` assignment in line 1 and the `$higher` assignment in line 2 are dead. The first because `$myVar` is never used and the second because `$higher` is always overwritten for every possible time line. Loading history...
131			$metadata .= $owner->MarkupComment('Extra Metadata');
132			$metadata .= $owner->ExtraMeta . PHP_EOL;
133			}
134			}
135
136			//// extension update hook
137			$owner->extend('updateMetadata', $config, $owner, $metadata);
138
139			// end
140			$metadata .= $owner->MarkupComment('END SEO');
141
142			// return
143			return $metadata;
144
145			}
146
147
148			/* Helper Methods
149			------------------------------------------------------------------------------*/
150
151			/**
152			* Returns a given string as a HTML comment.
153			*
154			* @var string $comment
155			*
156			* @return string
157			*/
158			public function MarkupComment($comment)
159			{
160
161			// return
162			return '<!-- ' . $comment . ' -->' . PHP_EOL;
163
164			}
165
166			/**
167			* Returns markup for a HTML meta element.
168			*
169			* @var string $name
170			* @var string $content
171			* @var bool $encode
172			*
173			* @return string
174			*/
175			public function MarkupMeta($name, $content, $encode = false)
176			{
177
178			// return
179			return '<meta name="' . $name . '" content="' . $this->encodeContent($content, $encode) . '" />' . PHP_EOL;
180
181			}
182
183			/**
184			* Returns markup for a HTML link element.
185			*
186			* @param string $rel
187			* @param string $href
188			* @param string $type
189			* @param string $sizes
190			*
191			* @return string
192			*/
193			public function MarkupLink($rel, $href, $type = '', $sizes = '')
194			{
195			// start fragment
196			$return = '<link rel="' . $rel . '" href="' . $href . '"';
197			// if type
198			if ($type) {
199			$return .= ' type="' . $type . '"';
200			}
201			// if sizes
202			if ($sizes) {
203			$return .= ' sizes="' . $sizes . '"';
204			}
205			// end fragment
206			$return .= ' />' . PHP_EOL;
207			// return
208			return $return;
209			}
210
211
212			/* Meta Methods
213			------------------------------------------------------------------------------*/
214
215			/**
216			* Generates HTML title based on configuration settings.
217			*
218			* @return bool\|string
219			*/
220			public function GenerateTitle()
221			{
222
223			// return SEO title or false
224			return SiteConfig::current_site_config()->GenerateTitle($this->owner->Title);
225
226			}
227
228			/**
229			* Returns description from the page `MetaDescription`, or the first paragraph of the `Content` attribute.
230			*
231			* @return bool\|string
232			*/
233			public function GenerateDescription()
234			{
235
236			if ($this->owner->MetaDescription) {
237			return $this->owner->MetaDescription;
238			} else {
239			return $this->owner->GenerateDescriptionFromContent();
240			}
241
242			}
243
244			/**
245			* Generates description from the first paragraph of the `Content` attribute.
246			*
247			* @return bool\|string
248			*/
249			public function GenerateDescriptionFromContent()
250			{
251
252			if ($content = trim($this->owner->Content)) {
253
254			// pillage first paragraph from page content
255			if (preg_match('/<p>(.*?)<\/p>/i', $content, $match)) {
256			// is HTML
257			$content = $match[0];
258			} else {
259			// is plain text
260			$content = explode("\n", $content);
261			$content = $content[0];
262			}
263
264			// decode (no harm done) & return
265			return trim(html_entity_decode(strip_tags($content)));
266
267			} else {
268			// none
269			return false;
270			}
271
272			}
273
274			/**
275			* Returns a plain or HTML-encoded string according to the current charset & encoding settings.
276			*
277			* @param string $content
278			* @param bool $encode
279			*
280			* @return string
281			*/
282			public function encodeContent($content, $encode = true) {
283			if ($encode) {
284			return htmlentities($content, ENT_QUOTES, $this->owner->Charset);
285			} else {
286			return $content;
287			}
288			}
289
290			}
291

Graphiques-Digitale / silverstripe-seo-metadata

Push — master ( 019a60...ed4f70 )

MarkupFacebook() A

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like