silverstripe / silverstripe-securityreport

src/Forms/GridFieldExportReportButton.php

Doc Comments +1 added lines, -1 removed lines

@@ -27,7 +27,7 @@
      * it sources the {@link List} from $gridField->getList() instead of $gridField->getManipulatedList()
      *
      * @param GridField $gridField
-     * @return array
+     * @return string
      */
     public function generateExportFileData($gridField)
     {

Indentation +63 added lines, -63 removed lines

@@ -20,78 +20,78 @@
 class GridFieldExportReportButton extends GridFieldExportButton
 {
 
-    /**
-     * Generate export fields for CSV.
-     *
-     * Replaces the definition in GridFieldExportButton, this is the same as original except
-     * it sources the {@link List} from $gridField->getList() instead of $gridField->getManipulatedList()
-     *
-     * @param GridField $gridField
-     * @return array
-     */
-    public function generateExportFileData($gridField)
-    {
-        $separator = $this->csvSeparator;
-        $csvColumns = ($this->exportColumns)
-            ? $this->exportColumns
-            : singleton($gridField->getModelClass())->summaryFields();
-        $fileData = '';
-        $columnData = array();
+	/**
+	 * Generate export fields for CSV.
+	 *
+	 * Replaces the definition in GridFieldExportButton, this is the same as original except
+	 * it sources the {@link List} from $gridField->getList() instead of $gridField->getManipulatedList()
+	 *
+	 * @param GridField $gridField
+	 * @return array
+	 */
+	public function generateExportFileData($gridField)
+	{
+		$separator = $this->csvSeparator;
+		$csvColumns = ($this->exportColumns)
+			? $this->exportColumns
+			: singleton($gridField->getModelClass())->summaryFields();
+		$fileData = '';
+		$columnData = array();
 
-        if ($this->csvHasHeader) {
-            $headers = array();
+		if ($this->csvHasHeader) {
+			$headers = array();
 
-            // determine the CSV headers. If a field is callable (e.g. anonymous function) then use the
-            // source name as the header instead
-            foreach ($csvColumns as $columnSource => $columnHeader) {
-                if (is_array($columnHeader) && array_key_exists('title', $columnHeader)) {
-                    $headers[] = $columnHeader['title'];
-                } else {
-                    $headers[] = (!is_string($columnHeader) && is_callable($columnHeader))
-                        ? $columnSource
-                        : $columnHeader;
-                }
-            }
+			// determine the CSV headers. If a field is callable (e.g. anonymous function) then use the
+			// source name as the header instead
+			foreach ($csvColumns as $columnSource => $columnHeader) {
+				if (is_array($columnHeader) && array_key_exists('title', $columnHeader)) {
+					$headers[] = $columnHeader['title'];
+				} else {
+					$headers[] = (!is_string($columnHeader) && is_callable($columnHeader))
+						? $columnSource
+						: $columnHeader;
+				}
+			}
 
-            $fileData .= "\"" . implode("\"{$separator}\"", array_values($headers)) . "\"";
-            $fileData .= "\n";
-        }
+			$fileData .= "\"" . implode("\"{$separator}\"", array_values($headers)) . "\"";
+			$fileData .= "\n";
+		}
 
-        // The is the only variation from the parent, using getList() instead of getManipulatedList()
-        $items = $gridField->getList();
+		// The is the only variation from the parent, using getList() instead of getManipulatedList()
+		$items = $gridField->getList();
 
-        // @todo should GridFieldComponents change behaviour based on whether others are available in the config?
-        foreach ($gridField->getConfig()->getComponents() as $component) {
-            if ($component instanceof GridFieldFilterHeader || $component instanceof GridFieldSortableHeader) {
-                $items = $component->getManipulatedData($gridField, $items);
-            }
-        }
+		// @todo should GridFieldComponents change behaviour based on whether others are available in the config?
+		foreach ($gridField->getConfig()->getComponents() as $component) {
+			if ($component instanceof GridFieldFilterHeader || $component instanceof GridFieldSortableHeader) {
+				$items = $component->getManipulatedData($gridField, $items);
+			}
+		}
 
-        foreach ($items->limit(null) as $item) {
-            $columnData = array();
+		foreach ($items->limit(null) as $item) {
+			$columnData = array();
 
-            foreach ($csvColumns as $columnSource => $columnHeader) {
-                if (!is_string($columnHeader) && is_callable($columnHeader)) {
-                    if ($item->hasMethod($columnSource)) {
-                        $relObj = $item->{$columnSource}();
-                    } else {
-                        $relObj = $item->relObject($columnSource);
-                    }
+			foreach ($csvColumns as $columnSource => $columnHeader) {
+				if (!is_string($columnHeader) && is_callable($columnHeader)) {
+					if ($item->hasMethod($columnSource)) {
+						$relObj = $item->{$columnSource}();
+					} else {
+						$relObj = $item->relObject($columnSource);
+					}
 
-                    $value = $columnHeader($relObj);
-                } else {
-                    $value = $gridField->getDataFieldValue($item, $columnSource);
-                }
+					$value = $columnHeader($relObj);
+				} else {
+					$value = $gridField->getDataFieldValue($item, $columnSource);
+				}
 
-                $value = str_replace(array("\r", "\n"), "\n", $value);
-                $columnData[] = '"' . str_replace('"', '\"', $value) . '"';
-            }
-            $fileData .= implode($separator, $columnData);
-            $fileData .= "\n";
+				$value = str_replace(array("\r", "\n"), "\n", $value);
+				$columnData[] = '"' . str_replace('"', '\"', $value) . '"';
+			}
+			$fileData .= implode($separator, $columnData);
+			$fileData .= "\n";
 
-            $item->destroy();
-        }
+			$item->destroy();
+		}
 
-        return $fileData;
-    }
+		return $fileData;
+	}
 }

Spacing +2 added lines, -2 removed lines

@@ -53,7 +53,7 @@ 
                 }
             }
 
-            $fileData .= "\"" . implode("\"{$separator}\"", array_values($headers)) . "\"";
+            $fileData .= "\"".implode("\"{$separator}\"", array_values($headers))."\"";
             $fileData .= "\n";
         }
 
@@ -84,7 +84,7 @@ 
                 }
 
                 $value = str_replace(array("\r", "\n"), "\n", $value);
-                $columnData[] = '"' . str_replace('"', '\"', $value) . '"';
+                $columnData[] = '"'.str_replace('"', '\"', $value).'"';
             }
             $fileData .= implode($separator, $columnData);
             $fileData .= "\n";

src/Forms/GridFieldPrintReportButton.php

Indentation +46 added lines, -46 removed lines

@@ -22,59 +22,59 @@
 class GridFieldPrintReportButton extends GridFieldPrintButton
 {
 
-    /**
-     * Export core
-     *
-     * Replaces definition in GridFieldPrintButton
-     * same as original except sources data from $gridField->getList() instead of $gridField->getManipulatedList()
-     *
-     * @param GridField
-     * @return ArrayData
-     */
-    public function generatePrintData(GridField $gridField)
-    {
-        $printColumns = $this->getPrintColumnsForGridField($gridField);
-        $header = null;
+	/**
+	 * Export core
+	 *
+	 * Replaces definition in GridFieldPrintButton
+	 * same as original except sources data from $gridField->getList() instead of $gridField->getManipulatedList()
+	 *
+	 * @param GridField
+	 * @return ArrayData
+	 */
+	public function generatePrintData(GridField $gridField)
+	{
+		$printColumns = $this->getPrintColumnsForGridField($gridField);
+		$header = null;
 
-        if ($this->printHasHeader) {
-            $header = new ArrayList();
-            foreach ($printColumns as $field => $label) {
-                $header->push(new ArrayData(array(
-                    "CellString" => $label,
-                )));
-            }
-        }
+		if ($this->printHasHeader) {
+			$header = new ArrayList();
+			foreach ($printColumns as $field => $label) {
+				$header->push(new ArrayData(array(
+					"CellString" => $label,
+				)));
+			}
+		}
 
-        // The is the only variation from the parent class, using getList() instead of getManipulatedList()
-        $items = $gridField->getList();
+		// The is the only variation from the parent class, using getList() instead of getManipulatedList()
+		$items = $gridField->getList();
 
-        $itemRows = new ArrayList();
+		$itemRows = new ArrayList();
 
-        foreach ($items as $item) {
-            $itemRow = new ArrayList();
+		foreach ($items as $item) {
+			$itemRow = new ArrayList();
 
-            foreach ($printColumns as $field => $label) {
-                $value = $gridField->getDataFieldValue($item, $field);
-                $itemRow->push(new ArrayData(array(
-                    "CellString" => $value,
-                )));
-            }
+			foreach ($printColumns as $field => $label) {
+				$value = $gridField->getDataFieldValue($item, $field);
+				$itemRow->push(new ArrayData(array(
+					"CellString" => $value,
+				)));
+			}
 
-            $itemRows->push(new ArrayData(array(
-                "ItemRow" => $itemRow
-            )));
+			$itemRows->push(new ArrayData(array(
+				"ItemRow" => $itemRow
+			)));
 
-            $item->destroy();
-        }
+			$item->destroy();
+		}
 
-        $ret = new ArrayData(array(
-            "Title" => $this->getTitle($gridField),
-            "Header" => $header,
-            "ItemRows" => $itemRows,
-            "Datetime" => DBDatetime::now(),
-            "Member" => Security::getCurrentUser(),
-        ));
+		$ret = new ArrayData(array(
+			"Title" => $this->getTitle($gridField),
+			"Header" => $header,
+			"ItemRows" => $itemRows,
+			"Datetime" => DBDatetime::now(),
+			"Member" => Security::getCurrentUser(),
+		));
 
-        return $ret;
-    }
+		return $ret;
+	}
 }

src/Subsites/SubsiteMemberReportExtension.php

Indentation +31 added lines, -31 removed lines

@@ -13,37 +13,37 @@
 class SubsiteMemberReportExtension extends DataExtension
 {
     
-    /**
-     * Set cast of additional field
-     *
-     * @var array
-     * @config
-     */
-    private static $casting = array(
-        'SubsiteDescription' => 'Text'
-    );
+	/**
+	 * Set cast of additional field
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $casting = array(
+		'SubsiteDescription' => 'Text'
+	);
     
-    /**
-     * Default permission to filter for
-     *
-     * @var string
-     * @config
-     */
-    private static $subsite_description_permission = 'SITETREE_EDIT_ALL';
+	/**
+	 * Default permission to filter for
+	 *
+	 * @var string
+	 * @config
+	 */
+	private static $subsite_description_permission = 'SITETREE_EDIT_ALL';
     
-    /**
-     * Describes the subsites this user has SITETREE_EDIT_ALL access to
-     *
-     * @return string
-     */
-    public function getSubsiteDescription()
-    {
-        $subsites = Subsite::accessible_sites(
-            $this->owner->config()->get('subsite_description_permission'),
-            true,
-            "Main site",
-            $this->owner
-        );
-        return implode(', ', $subsites->column('Title'));
-    }
+	/**
+	 * Describes the subsites this user has SITETREE_EDIT_ALL access to
+	 *
+	 * @return string
+	 */
+	public function getSubsiteDescription()
+	{
+		$subsites = Subsite::accessible_sites(
+			$this->owner->config()->get('subsite_description_permission'),
+			true,
+			"Main site",
+			$this->owner
+		);
+		return implode(', ', $subsites->column('Title'));
+	}
 }

src/UserSecurityReport.php

Spacing +2 added lines, -2 removed lines

@@ -46,7 +46,7 @@ 
      */
     public function title()
     {
-        return _t(__CLASS__ . '.REPORTTITLE', 'Users, Groups and Permissions');
+        return _t(__CLASS__.'.REPORTTITLE', 'Users, Groups and Permissions');
     }
 
     /**
@@ -59,7 +59,7 @@ 
         return str_replace(
             array('http', 'https', '://'),
             '',
-            Director::protocolAndHost() . ' - ' . date('d/m/Y H:i:s')
+            Director::protocolAndHost().' - '.date('d/m/Y H:i:s')
         );
     }
 

Indentation +116 added lines, -116 removed lines

@@ -22,130 +22,130 @@
 class UserSecurityReport extends Report
 {
 
-    /**
-     * Columns in the report
-     *
-     * @var array
-     * @config
-     */
-    private static $columns = array(
-        'ID' => 'User ID',
-        'FirstName' => 'First Name',
-        'Surname' => 'Surname',
-        'Email' => 'Email',
-        'Created' => 'Date Created',
-        'LastLoggedIn' => 'Last Logged In',
-        'GroupsDescription' => 'Groups',
-        'PermissionsDescription' => 'Permissions',
-    );
+	/**
+	 * Columns in the report
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $columns = array(
+		'ID' => 'User ID',
+		'FirstName' => 'First Name',
+		'Surname' => 'Surname',
+		'Email' => 'Email',
+		'Created' => 'Date Created',
+		'LastLoggedIn' => 'Last Logged In',
+		'GroupsDescription' => 'Groups',
+		'PermissionsDescription' => 'Permissions',
+	);
     
-    protected $dataClass = Member::class;
+	protected $dataClass = Member::class;
 
-    /**
-     * Returns the report title
-     *
-     * @return string
-     */
-    public function title()
-    {
-        return _t(__CLASS__ . '.REPORTTITLE', 'Users, Groups and Permissions');
-    }
+	/**
+	 * Returns the report title
+	 *
+	 * @return string
+	 */
+	public function title()
+	{
+		return _t(__CLASS__ . '.REPORTTITLE', 'Users, Groups and Permissions');
+	}
 
-    /**
-     * Builds a report description which is the current hostname with the current date and time
-     *
-     * @return string e.g. localhost/sitename - 21/12/2112
-     */
-    public function description()
-    {
-        return str_replace(
-            array('http', 'https', '://'),
-            '',
-            Director::protocolAndHost() . ' - ' . date('d/m/Y H:i:s')
-        );
-    }
+	/**
+	 * Builds a report description which is the current hostname with the current date and time
+	 *
+	 * @return string e.g. localhost/sitename - 21/12/2112
+	 */
+	public function description()
+	{
+		return str_replace(
+			array('http', 'https', '://'),
+			'',
+			Director::protocolAndHost() . ' - ' . date('d/m/Y H:i:s')
+		);
+	}
 
-    /**
-     * Returns the column names of the report
-     *
-     * @return array
-     */
-    public function columns()
-    {
-        $columns = self::config()->columns;
-        if (!Security::config()->get('login_recording')) {
-            unset($columns['LastLoggedIn']);
-        }
-        return $columns;
-    }
+	/**
+	 * Returns the column names of the report
+	 *
+	 * @return array
+	 */
+	public function columns()
+	{
+		$columns = self::config()->columns;
+		if (!Security::config()->get('login_recording')) {
+			unset($columns['LastLoggedIn']);
+		}
+		return $columns;
+	}
 
-    /**
-     * Alias of columns(), to support the export to csv action
-     * in {@link GridFieldExportButton} generateExportFileData method.
-     * @return array
-     */
-    public function getColumns()
-    {
-        return $this->columns();
-    }
+	/**
+	 * Alias of columns(), to support the export to csv action
+	 * in {@link GridFieldExportButton} generateExportFileData method.
+	 * @return array
+	 */
+	public function getColumns()
+	{
+		return $this->columns();
+	}
 
-    /**
-     * @return array
-     */
-    public function summaryFields()
-    {
-        return $this->columns();
-    }
+	/**
+	 * @return array
+	 */
+	public function summaryFields()
+	{
+		return $this->columns();
+	}
 
-    /**
-     * Defines the sortable columns on the report gridfield
-     *
-     * @return array
-     */
-    public function sortColumns()
-    {
-        return array_keys($this->columns());
-    }
+	/**
+	 * Defines the sortable columns on the report gridfield
+	 *
+	 * @return array
+	 */
+	public function sortColumns()
+	{
+		return array_keys($this->columns());
+	}
 
-    /**
-     * Get the source records for the report gridfield
-     *
-     * @return DataList
-     */
-    public function sourceRecords()
-    {
-        // Get members sorted by ID
-        return Member::get()->sort('ID');
-    }
+	/**
+	 * Get the source records for the report gridfield
+	 *
+	 * @return DataList
+	 */
+	public function sourceRecords()
+	{
+		// Get members sorted by ID
+		return Member::get()->sort('ID');
+	}
 
-    /**
-     * Restrict access to this report to users with security admin access
-     *
-     * @param Member $member
-     * @return boolean
-     */
-    public function canView($member = null)
-    {
-        return (bool)Permission::checkMember($member, "CMS_ACCESS_SecurityAdmin");
-    }
+	/**
+	 * Restrict access to this report to users with security admin access
+	 *
+	 * @param Member $member
+	 * @return boolean
+	 */
+	public function canView($member = null)
+	{
+		return (bool)Permission::checkMember($member, "CMS_ACCESS_SecurityAdmin");
+	}
 
-    /**
-     * Return a field, such as a {@link GridField} that is
-     * used to show and manipulate data relating to this report.
-     *
-     * @return FormField subclass
-     */
-    public function getReportField()
-    {
-        /** @var GridField $gridField */
-        $gridField = parent::getReportField();
-        $gridField->setModelClass(self::class);
-        $gridConfig = $gridField->getConfig();
-        $gridConfig->removeComponentsByType([GridFieldPrintButton::class, GridFieldExportButton::class]);
-        $gridConfig->addComponents(
-            new GridFieldPrintReportButton('buttons-before-left'),
-            new GridFieldExportReportButton('buttons-before-left')
-        );
-        return $gridField;
-    }
+	/**
+	 * Return a field, such as a {@link GridField} that is
+	 * used to show and manipulate data relating to this report.
+	 *
+	 * @return FormField subclass
+	 */
+	public function getReportField()
+	{
+		/** @var GridField $gridField */
+		$gridField = parent::getReportField();
+		$gridField->setModelClass(self::class);
+		$gridConfig = $gridField->getConfig();
+		$gridConfig->removeComponentsByType([GridFieldPrintButton::class, GridFieldExportButton::class]);
+		$gridConfig->addComponents(
+			new GridFieldPrintReportButton('buttons-before-left'),
+			new GridFieldExportReportButton('buttons-before-left')
+		);
+		return $gridField;
+	}
 }

tests/SubsitesReportTest.php

Indentation +52 added lines, -52 removed lines

@@ -18,67 +18,67 @@
 class SubsitesReportTest extends SapphireTest
 {
 
-    protected static $fixture_file = 'SubsitesReportTest.yml';
+	protected static $fixture_file = 'SubsitesReportTest.yml';
 
-    protected $records;
+	protected $records;
 
-    protected static $required_extensions = [
-        Member::class => [
-            MemberReportExtension::class,
-            SubsiteMemberReportExtension::class,
-        ],
-    ];
+	protected static $required_extensions = [
+		Member::class => [
+			MemberReportExtension::class,
+			SubsiteMemberReportExtension::class,
+		],
+	];
 
-    protected function setUp()
-    {
-        if (!class_exists(Subsite::class)) {
-            // Don't break the parent:setUp() when failing to create Subsite fixtures
-            static::$fixture_file = null;
-            parent::setUp();
-            $this->markTestSkipped("Please install Subsites to run this test");
-        }
+	protected function setUp()
+	{
+		if (!class_exists(Subsite::class)) {
+			// Don't break the parent:setUp() when failing to create Subsite fixtures
+			static::$fixture_file = null;
+			parent::setUp();
+			$this->markTestSkipped("Please install Subsites to run this test");
+		}
 
-        parent::setUp();
+		parent::setUp();
 
-        $reports = Report::get_reports();
-        $report = $reports[UserSecurityReport::class];
-        $this->records = $report->sourceRecords()->toArray();
-    }
+		$reports = Report::get_reports();
+		$report = $reports[UserSecurityReport::class];
+		$this->records = $report->sourceRecords()->toArray();
+	}
 
-    public function testSourceRecords()
-    {
-        $this->assertNotEmpty($this->records);
-    }
+	public function testSourceRecords()
+	{
+		$this->assertNotEmpty($this->records);
+	}
 
-    public function testGetMemberGroups()
-    {
+	public function testGetMemberGroups()
+	{
 
-        // Admin
-        $admin = $this->objFromFixture(Member::class, 'memberadmin');
-        $subsites = $admin->SubsiteDescription;
-        $this->assertContains('TestMainSite', $subsites);
-        $this->assertContains('TestSubsite1', $subsites);
-        $this->assertContains('TestSubsite2', $subsites);
+		// Admin
+		$admin = $this->objFromFixture(Member::class, 'memberadmin');
+		$subsites = $admin->SubsiteDescription;
+		$this->assertContains('TestMainSite', $subsites);
+		$this->assertContains('TestSubsite1', $subsites);
+		$this->assertContains('TestSubsite2', $subsites);
 
-        // Editor
-        $membereditor = $this->objFromFixture(Member::class, 'membereditor');
-        $subsites = $membereditor->SubsiteDescription;
-        $this->assertContains('TestMainSite', $subsites);
-        $this->assertContains('TestSubsite1', $subsites);
-        $this->assertContains('TestSubsite2', $subsites);
+		// Editor
+		$membereditor = $this->objFromFixture(Member::class, 'membereditor');
+		$subsites = $membereditor->SubsiteDescription;
+		$this->assertContains('TestMainSite', $subsites);
+		$this->assertContains('TestSubsite1', $subsites);
+		$this->assertContains('TestSubsite2', $subsites);
 
-        // First User
-        $membersubsite1 = $this->objFromFixture(Member::class, 'membersubsite1');
-        $subsites = $membersubsite1->SubsiteDescription;
-        $this->assertNotContains('TestMainSite', $subsites);
-        $this->assertContains('TestSubsite1', $subsites);
-        $this->assertNotContains('TestSubsite2', $subsites);
+		// First User
+		$membersubsite1 = $this->objFromFixture(Member::class, 'membersubsite1');
+		$subsites = $membersubsite1->SubsiteDescription;
+		$this->assertNotContains('TestMainSite', $subsites);
+		$this->assertContains('TestSubsite1', $subsites);
+		$this->assertNotContains('TestSubsite2', $subsites);
 
-        // Second user
-        $memberallsubsites = $this->objFromFixture(Member::class, 'memberallsubsites');
-        $subsites = $memberallsubsites->SubsiteDescription;
-        $this->assertNotContains('TestMainSite', $subsites);
-        $this->assertContains('TestSubsite1', $subsites);
-        $this->assertContains('TestSubsite2', $subsites);
-    }
+		// Second user
+		$memberallsubsites = $this->objFromFixture(Member::class, 'memberallsubsites');
+		$subsites = $memberallsubsites->SubsiteDescription;
+		$this->assertNotContains('TestMainSite', $subsites);
+		$this->assertContains('TestSubsite1', $subsites);
+		$this->assertContains('TestSubsite2', $subsites);
+	}
 }

tests/UserSecurityReportTest.php

Indentation +76 added lines, -76 removed lines

@@ -21,80 +21,80 @@
 class UserSecurityReportTest extends SapphireTest
 {
 
-    protected static $fixture_file = 'UserSecurityReportTest.yml';
-
-    protected $records;
-    protected $report;
-
-    protected static $required_extensions = [
-        Member::class => [
-            MemberReportExtension::class,
-        ],
-    ];
-
-    protected static $illegal_extensions = [
-        Group::class => [
-            GroupSubsites::class,
-        ],
-    ];
-
-    /**
-     * Utility method for all tests to use.
-     *
-     * @return ArrayList
-     * @todo pre-fill the report with fixture-defined users
-     */
-    protected function setUp()
-    {
-        parent::setUp();
-        $reports = Report::get_reports();
-        $report = $reports[UserSecurityReport::class];
-        $this->report = $report;
-        $this->records = $report->sourceRecords()->toArray();
-    }
-
-    public function testSourceRecords()
-    {
-        $this->assertNotEmpty($this->records);
-    }
-
-    public function testGetMemberGroups()
-    {
-        //getMemberGroups(&$member) returns string
-        $member = $this->objFromFixture(Member::class, 'member-has-0-groups');
-        $groups = $member->GroupsDescription;
-        $this->assertEquals('Not in a Security Group', $groups);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-1-groups');
-        $groups = $member->GroupsDescription;
-        $this->assertEquals('Group Test 01', $groups);
-    }
-
-    public function testGetMemberPermissions()
-    {
-        $member = $this->objFromFixture(Member::class, 'member-has-0-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('No Permissions', $perms);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-1-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('Full administrative rights', $perms);
-
-        $member = $this->objFromFixture(Member::class, 'member-has-n-permissions');
-        $perms = $member->PermissionsDescription;
-        $this->assertEquals('Full administrative rights, Edit any page', $perms);
-    }
-
-    public function testLoginLoggingColumnShowsOnlyWhenApplicable()
-    {
-        $original = Config::inst()->get(Security::class, 'login_recording');
-
-        Config::modify()->set(Security::class, 'login_recording', true);
-        $this->assertContains('LastLoggedIn', array_keys($this->report->columns()));
-
-        Config::modify()->set(Security::class, 'login_recording', false);
-        $this->assertNotContains('LastLoggedIn', array_keys($this->report->columns()));
-
-        Config::modify()->set(Security::class, 'login_recording', $original);
-    }
+	protected static $fixture_file = 'UserSecurityReportTest.yml';
+
+	protected $records;
+	protected $report;
+
+	protected static $required_extensions = [
+		Member::class => [
+			MemberReportExtension::class,
+		],
+	];
+
+	protected static $illegal_extensions = [
+		Group::class => [
+			GroupSubsites::class,
+		],
+	];
+
+	/**
+	 * Utility method for all tests to use.
+	 *
+	 * @return ArrayList
+	 * @todo pre-fill the report with fixture-defined users
+	 */
+	protected function setUp()
+	{
+		parent::setUp();
+		$reports = Report::get_reports();
+		$report = $reports[UserSecurityReport::class];
+		$this->report = $report;
+		$this->records = $report->sourceRecords()->toArray();
+	}
+
+	public function testSourceRecords()
+	{
+		$this->assertNotEmpty($this->records);
+	}
+
+	public function testGetMemberGroups()
+	{
+		//getMemberGroups(&$member) returns string
+		$member = $this->objFromFixture(Member::class, 'member-has-0-groups');
+		$groups = $member->GroupsDescription;
+		$this->assertEquals('Not in a Security Group', $groups);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-1-groups');
+		$groups = $member->GroupsDescription;
+		$this->assertEquals('Group Test 01', $groups);
+	}
+
+	public function testGetMemberPermissions()
+	{
+		$member = $this->objFromFixture(Member::class, 'member-has-0-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('No Permissions', $perms);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-1-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('Full administrative rights', $perms);
+
+		$member = $this->objFromFixture(Member::class, 'member-has-n-permissions');
+		$perms = $member->PermissionsDescription;
+		$this->assertEquals('Full administrative rights, Edit any page', $perms);
+	}
+
+	public function testLoginLoggingColumnShowsOnlyWhenApplicable()
+	{
+		$original = Config::inst()->get(Security::class, 'login_recording');
+
+		Config::modify()->set(Security::class, 'login_recording', true);
+		$this->assertContains('LastLoggedIn', array_keys($this->report->columns()));
+
+		Config::modify()->set(Security::class, 'login_recording', false);
+		$this->assertNotContains('LastLoggedIn', array_keys($this->report->columns()));
+
+		Config::modify()->set(Security::class, 'login_recording', $original);
+	}
 }

src/MemberReportExtension.php

Indentation +92 added lines, -92 removed lines

@@ -14,106 +14,106 @@
  */
 class MemberReportExtension extends DataExtension
 {
-    /**
-     * Set cast of additional fields
-     *
-     * @var array
-     * @config
-     */
-    private static $casting = array(
-        'GroupsDescription' => 'Text',
-        'PermissionsDescription' => 'Text'
-    );
+	/**
+	 * Set cast of additional fields
+	 *
+	 * @var array
+	 * @config
+	 */
+	private static $casting = array(
+		'GroupsDescription' => 'Text',
+		'PermissionsDescription' => 'Text'
+	);
 
-    /**
-     * Retrieves the most recent successful LoginAttempt
-     *
-     * @return DBDatetime|string
-     */
-    public function getLastLoggedIn()
-    {
-        $lastTime = LoginAttempt::get()
-            ->filter([
-                'MemberID' => $this->owner->ID,
-                'Status' => 'Success',
-            ])
-            ->sort('Created', 'DESC')
-            ->first();
+	/**
+	 * Retrieves the most recent successful LoginAttempt
+	 *
+	 * @return DBDatetime|string
+	 */
+	public function getLastLoggedIn()
+	{
+		$lastTime = LoginAttempt::get()
+			->filter([
+				'MemberID' => $this->owner->ID,
+				'Status' => 'Success',
+			])
+			->sort('Created', 'DESC')
+			->first();
 
-        if ($lastTime) {
-            return $lastTime->dbObject('Created')->format(DBDatetime::ISO_DATETIME);
-        }
-        return _t(__CLASS__ . '.NEVER', 'Never');
-    }
+		if ($lastTime) {
+			return $lastTime->dbObject('Created')->format(DBDatetime::ISO_DATETIME);
+		}
+		return _t(__CLASS__ . '.NEVER', 'Never');
+	}
 
-    /**
-     * Builds a comma separated list of member group names for a given Member.
-     *
-     * @return string
-     */
-    public function getGroupsDescription()
-    {
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(true);
-        }
+	/**
+	 * Builds a comma separated list of member group names for a given Member.
+	 *
+	 * @return string
+	 */
+	public function getGroupsDescription()
+	{
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(true);
+		}
 
-        // Get the member's groups, if any
-        $groups = $this->owner->Groups();
-        if ($groups->Count()) {
-            // Collect the group names
-            $groupNames = array();
-            foreach ($groups as $group) {
-                /** @var Group $group */
-                $groupNames[] = html_entity_decode($group->getTreeTitle());
-            }
-            // return a csv string of the group names, sans-markup
-            $result = preg_replace("#</?[^>]>#", '', implode(', ', $groupNames));
-        } else {
-            // If no groups then return a status label
-            $result = _t(__CLASS__ . '.NOGROUPS', 'Not in a Security Group');
-        }
+		// Get the member's groups, if any
+		$groups = $this->owner->Groups();
+		if ($groups->Count()) {
+			// Collect the group names
+			$groupNames = array();
+			foreach ($groups as $group) {
+				/** @var Group $group */
+				$groupNames[] = html_entity_decode($group->getTreeTitle());
+			}
+			// return a csv string of the group names, sans-markup
+			$result = preg_replace("#</?[^>]>#", '', implode(', ', $groupNames));
+		} else {
+			// If no groups then return a status label
+			$result = _t(__CLASS__ . '.NOGROUPS', 'Not in a Security Group');
+		}
 
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(false);
-        }
-        return $result;
-    }
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(false);
+		}
+		return $result;
+	}
 
-    /**
-     * Builds a comma separated list of human-readbale permissions for a given Member.
-     *
-     * @return string
-     */
-    public function getPermissionsDescription()
-    {
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(true);
-        }
+	/**
+	 * Builds a comma separated list of human-readbale permissions for a given Member.
+	 *
+	 * @return string
+	 */
+	public function getPermissionsDescription()
+	{
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(true);
+		}
 
-        $permissionsUsr = Permission::permissions_for_member($this->owner->ID);
-        $permissionsSrc = Permission::get_codes(true);
-        sort($permissionsUsr);
+		$permissionsUsr = Permission::permissions_for_member($this->owner->ID);
+		$permissionsSrc = Permission::get_codes(true);
+		sort($permissionsUsr);
 
-        $permissionNames = array();
-        foreach ($permissionsUsr as $code) {
-            $code = strtoupper($code);
-            foreach ($permissionsSrc as $k => $v) {
-                if (isset($v[$code])) {
-                    $name = empty($v[$code]['name'])
-                        ? _t(__CLASS__ . '.UNKNOWN', 'Unknown')
-                        : $v[$code]['name'];
-                    $permissionNames[] = $name;
-                }
-            }
-        }
+		$permissionNames = array();
+		foreach ($permissionsUsr as $code) {
+			$code = strtoupper($code);
+			foreach ($permissionsSrc as $k => $v) {
+				if (isset($v[$code])) {
+					$name = empty($v[$code]['name'])
+						? _t(__CLASS__ . '.UNKNOWN', 'Unknown')
+						: $v[$code]['name'];
+					$permissionNames[] = $name;
+				}
+			}
+		}
 
-        $result = $permissionNames
-            ? implode(', ', $permissionNames)
-            : _t(__CLASS__ . '.NOPERMISSIONS', 'No Permissions');
+		$result = $permissionNames
+			? implode(', ', $permissionNames)
+			: _t(__CLASS__ . '.NOPERMISSIONS', 'No Permissions');
 
-        if (class_exists(Subsite::class)) {
-            Subsite::disable_subsite_filter(false);
-        }
-        return $result;
-    }
+		if (class_exists(Subsite::class)) {
+			Subsite::disable_subsite_filter(false);
+		}
+		return $result;
+	}
 }

Spacing +4 added lines, -4 removed lines

@@ -43,7 +43,7 @@ 
         if ($lastTime) {
             return $lastTime->dbObject('Created')->format(DBDatetime::ISO_DATETIME);
         }
-        return _t(__CLASS__ . '.NEVER', 'Never');
+        return _t(__CLASS__.'.NEVER', 'Never');
     }
 
     /**
@@ -70,7 +70,7 @@ 
             $result = preg_replace("#</?[^>]>#", '', implode(', ', $groupNames));
         } else {
             // If no groups then return a status label
-            $result = _t(__CLASS__ . '.NOGROUPS', 'Not in a Security Group');
+            $result = _t(__CLASS__.'.NOGROUPS', 'Not in a Security Group');
         }
 
         if (class_exists(Subsite::class)) {
@@ -100,7 +100,7 @@ 
             foreach ($permissionsSrc as $k => $v) {
                 if (isset($v[$code])) {
                     $name = empty($v[$code]['name'])
-                        ? _t(__CLASS__ . '.UNKNOWN', 'Unknown')
+                        ? _t(__CLASS__.'.UNKNOWN', 'Unknown')
                         : $v[$code]['name'];
                     $permissionNames[] = $name;
                 }
@@ -109,7 +109,7 @@ 
 
         $result = $permissionNames
             ? implode(', ', $permissionNames)
-            : _t(__CLASS__ . '.NOPERMISSIONS', 'No Permissions');
+            : _t(__CLASS__.'.NOPERMISSIONS', 'No Permissions');
 
         if (class_exists(Subsite::class)) {
             Subsite::disable_subsite_filter(false);

tests/MemberReportExtensionTest.php

Indentation +29 added lines, -29 removed lines

@@ -9,33 +9,33 @@
 
 class MemberReportExtensionTest extends SapphireTest
 {
-    protected static $fixture_file = 'MemberReportExtensionTest.yml';
-
-    protected static $required_extensions = [
-        Member::class => [
-            MemberReportExtension::class,
-        ],
-    ];
-
-    protected function setUp()
-    {
-        DBDatetime::set_mock_now('2018-05-03 00:00:00');
-
-        parent::setUp();
-    }
-
-    public function testGetLastLoggedIn()
-    {
-        /** @var Member $member */
-        $member = $this->objFromFixture(Member::class, 'has_logged_in');
-        $result = $member->getLastLoggedIn();
-        $this->assertContains('2018-05-03', $result, 'Last logged in date is shown');
-    }
-
-    public function testGetLastLoggedInReturnsNever()
-    {
-        $member = new Member();
-        $member->write();
-        $this->assertSame('Never', $member->getLastLoggedIn());
-    }
+	protected static $fixture_file = 'MemberReportExtensionTest.yml';
+
+	protected static $required_extensions = [
+		Member::class => [
+			MemberReportExtension::class,
+		],
+	];
+
+	protected function setUp()
+	{
+		DBDatetime::set_mock_now('2018-05-03 00:00:00');
+
+		parent::setUp();
+	}
+
+	public function testGetLastLoggedIn()
+	{
+		/** @var Member $member */
+		$member = $this->objFromFixture(Member::class, 'has_logged_in');
+		$result = $member->getLastLoggedIn();
+		$this->assertContains('2018-05-03', $result, 'Last logged in date is shown');
+	}
+
+	public function testGetLastLoggedInReturnsNever()
+	{
+		$member = new Member();
+		$member->write();
+		$this->assertSame('Never', $member->getLastLoggedIn());
+	}
 }