GridFieldSiteTree_PageHolderExtension::AllChildrenIncludingDeleted() - Code Metrics - christopherdarling/silverstripe-gridfieldsitetree - Measure and Improve Code Quality continuously with Scrutinizer

AllChildrenIncludingDeleted() A
last analyzed 2016-07-09 10:46 UTC

↳ Parent: GridFieldSiteTree_PageHolderExtension

Complexity

Conditions	1
Paths	1

Size

Total Lines	4
Code Lines	2

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

/*
 * @author Christopher Darling (www.christopherdarling.co.uk)
 */
class GridFieldSiteTree_PageHolderExtension extends DataExtension
namespace YourVendor;

class YourClass { }
{

    /**
     * Prevent children pages from showing up in the SiteTree TreeView
     **/
    public function AllChildrenIncludingDeleted()
    {
        return false;
    }

    /*
     * Create a GridField to display the pages.
     *
     * @see CMSMain::ListViewForm() heavily based on this code.
     * @param string $name
     * @param string $title

     * @param SS_List $dataList

     * @return GridField
     */
    public function getGridFieldSiteTreeField($name, $title=null, SS_List $dataList = null)
    {
        $gf = GridField::create(
            $name,
            $title,
            $dataList,
            $config = GridFieldConfig::create()
        );

        $config->addComponents(
            new GridFieldSortableHeader(),
            $columns = new GridFieldDataColumns(),
            new GridFieldPaginator(15)
        );

        $fields = array(
            'getTreeTitle' => _t('SiteTree.PAGETITLE', 'Page Title'),
            'singular_name' => _t('SiteTree.PAGETYPE'),
            'LastEdited' => _t('SiteTree.LASTUPDATED', 'Last Updated'),
        );
        $columns->setDisplayFields($fields);
        $columns->setFieldCasting(array(
            'Created' => 'Datetime->Ago',
            'LastEdited' => 'Datetime->Ago',
            'getTreeTitle' => 'HTMLText'
        ));

        $config->getComponentByType('GridFieldSortableHeader')->setFieldSorting(array('getTreeTitle' => 'Title'));
interface User
{
    /** @return string */
    public function getPassword();
}

class MyUser implements User
{
    public function getPassword()
    {
        // return something
    }

    public function getDisplayName()
    {
        // return some name.
    }
}

class AuthSystem
{
    public function authenticate(User $user)
    {
        $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName()));
        // do something.
    }
}

        $controller = $this;
        $columns->setFieldFormatting(array(
            'getTreeTitle' => function ($value, &$item) use ($controller) {
                return '<a class="action-detail" href="' . singleton('CMSPageEditController')->Link('show') . '/' . $item->ID . '">' . $item->TreeTitle . '</a>';
            }
        ));

        return $gf;
    }
}


1			<?php
2
3			/*
4			* @author Christopher Darling (www.christopherdarling.co.uk)
5			*/
6			class GridFieldSiteTree_PageHolderExtension extends DataExtension
			0 ignored issues – show Coding Style Compatibility introduced 2016-02-16 21:55 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			/**
10			* Prevent children pages from showing up in the SiteTree TreeView
11			**/
12			public function AllChildrenIncludingDeleted()
13			{
14			return false;
15			}
16
17			/*
18			* Create a GridField to display the pages.
19			*
20			* @see CMSMain::ListViewForm() heavily based on this code.
21			* @param string $name
22			* @param string $title
			0 ignored issues – show Documentation introduced 2016-02-16 21:55 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...
23			* @param SS_List $dataList
			0 ignored issues – show Documentation introduced 2016-02-16 21:55 UTC by Report Bug Copy Issue Report Should the type for parameter `$dataList` not be `null\|SS_List`? 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...
24			* @return GridField
25			*/
26			public function getGridFieldSiteTreeField($name, $title=null, SS_List $dataList = null)
27			{
28			$gf = GridField::create(
29			$name,
30			$title,
31			$dataList,
32			$config = GridFieldConfig::create()
33			);
34
35			$config->addComponents(
36			new GridFieldSortableHeader(),
37			$columns = new GridFieldDataColumns(),
38			new GridFieldPaginator(15)
39			);
40
41			$fields = array(
42			'getTreeTitle' => _t('SiteTree.PAGETITLE', 'Page Title'),
43			'singular_name' => _t('SiteTree.PAGETYPE'),
44			'LastEdited' => _t('SiteTree.LASTUPDATED', 'Last Updated'),
45			);
46			$columns->setDisplayFields($fields);
47			$columns->setFieldCasting(array(
48			'Created' => 'Datetime->Ago',
49			'LastEdited' => 'Datetime->Ago',
50			'getTreeTitle' => 'HTMLText'
51			));
52
53			$config->getComponentByType('GridFieldSortableHeader')->setFieldSorting(array('getTreeTitle' => 'Title'));
			0 ignored issues – show Bug introduced 2016-02-16 21:55 UTC by Report Bug Copy Issue Report It seems like you code against a concrete implementation and not the interface `GridFieldComponent` as the method `setFieldSorting()` does only exist in the following implementations of said interface: `GridFieldSortableHeader`. Let’s take a look at an example: interface User { /** @return string / public function getPassword(); } class MyUser implements User { public function getPassword() { // return something } public function getDisplayName() { // return some name. } } class AuthSystem { public function authenticate(User $user) { $this->logger->info(sprintf('Authenticating %s.', $user->getDisplayName())); // do something. } } In the above example, the authenticate() method works fine as long as you just pass instances of MyUser. However, if you now also want to pass a different implementation of User which does not have a getDisplayName() method, the code will break. Available Fixes Change the type-hint for the parameter: class AuthSystem { public function authenticate(MyUser $user) { / ... / } } Add an additional type-check: class AuthSystem { public function authenticate(User $user) { if ($user instanceof MyUser) { $this->logger->info(/* ... /); } // or alternatively if ( ! $user instanceof MyUser) { throw new \LogicException( '$user must be an instance of MyUser, ' .'other instances are not supported.' ); } } } Note:* PHP Analyzer uses reverse abstract interpretation to narrow down the types inside the if block in such a case. Add the method to the interface: interface User { /** @return string / public function getPassword(); /* @return string */ public function getDisplayName(); } Loading history...
54
55			$controller = $this;
56			$columns->setFieldFormatting(array(
57			'getTreeTitle' => function ($value, &$item) use ($controller) {
58			return '<a class="action-detail" href="' . singleton('CMSPageEditController')->Link('show') . '/' . $item->ID . '">' . $item->TreeTitle . '</a>';
59			}
60			));
61
62			return $gf;
63			}
64			}
65

christopherdarling / silverstripe-gridfieldsitetree

AllChildrenIncludingDeleted() A last analyzed 2016-07-09 10:46 UTC

Complexity

Size

Duplication

Importance

Available Fixes

Duplication Side-by-Side

Filter issues like

AllChildrenIncludingDeleted() A
last analyzed 2016-07-09 10:46 UTC