StockistSearchPage_Controller

Complexity

Total Complexity

41

Size/Duplication

Total Lines	306
Duplicated Lines	0 %

Coupling/Cohesion

Components	2
Dependencies	7

Importance

Changes

0

16 Methods

Rating	Name	Duplication	Size	Complexity
A	init()	0	6	1
A	index()	0	11	1
A	MyAddAddressFinderForm()	0	4	1
B	locationsForCurrentCountry()	0	25	6
A	AlphaList()	0	16	4
A	Countries()	0	8	2
A	IsSearchPage()	0	4	1
A	IsStockistPage()	0	4	1
A	showsearches()	0	21	4
A	showtype()	0	5	1
A	MyStockistCountryTitle()	0	8	2
B	listofstockistscsv()	0	45	4
C	getChildrenAsHTMLRows()	0	32	7
A	listofstockists()	0	6	1
A	createListOfStockists()	0	17	1
A	updatemap()	0	12	4

<?php

class StockistSearchPage extends Page

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * @inherited
     */
    private static $icon = 'mysite/images/treeicons/StockistSearchPage';

The property $icon is not used and could be removed.

    /**
     * @inherited
     */
    private static $db = array(

The property $db is not used and could be removed.

        "DefaultZoom" => "Int"
    );

    /**
     * @inherited
     */
    private static $default_child = 'StockistCountryPage';

The property $default_child is not used and could be removed.

    /**
     * @inherited
     */
    private static $allowed_children = array('StockistCountryPage');

The property $allowed_children is not used and could be removed.

    /**
     * @inherited
     */
    private static $defaults = array('DefaultZoom' => 0);

The property $defaults is not used and could be removed.

    /**
     * @inherited
     */
    private static $can_be_root = true;

The property $can_be_root is not used and could be removed.

    /**
     * @inherited
     */
    private static $description = 'Stockist Search Page - Main page for Stockists';

The property $description is not used and could be removed.

    /**
     * Standard SS variable.
     */
    private static $singular_name = "Stockist Search Page";

The property $singular_name is not used and could be removed.

    public function i18n_singular_name()
    {
        return "Stockist Search Page";
    }

    /**
     * Standard SS variable.
     */
    private static $plural_name = "Stockist Search Pages";

The property $plural_name is not used and could be removed.

    public function i18n_plural_name()
    {
        return "Stockist Search Pages";
    }

    /**
     * @inherited
     */
   public function getCMSFields()

The return type could not be reliably inferred; please add a @return annotation.

   {
       $fields = parent::getCMSFields();
       $fields->removeByName("Map");
       $fields->addFieldToTab(
            "Root.SearchHistory", new LiteralField("SearchHistoryLink", "<a href=\"".$this->Link("showsearches")."\">What did people search for?</a>")
        );
       $fields->addFieldToTab('Root.Map', $defaultZoomField = new NumericField('DefaultZoom'));
       $defaultZoomField->setRightTitle('Set between 1 and 20.  One is the whole world and twenty is highest zoom level for map. Leave at zero for auto-zoom.');
       return $fields;
   }

    /**
     *
     * can only create one
     */
    public function canCreate($member = null)
    {
        return StockistSearchPage::get()
            ->filter(array("ClassName" => "StockistSearchPage"))
            ->count() ? false : true;
    }


    /**
     * returns a list of continents
     * @return DataList
     */
    public function AllContintents()
    {
        if ($root = $this->StockistSearchPage()) {
            return StockistCountryPage::get()->filter(array("ParentID" => $root->ID))->sort(array("Title" => "ASC"));
        }
    }

    /**
     * this is only provided on a country level
     * @return DataList | Null

Should the return type not be DataList|null?

     */
    public function AllPhysicalStockists()
    {
        return null;
    }

    /**
     * this is only provided on a country level
     * @return DataList | Null

Should the return type not be DataList|null?

     */
    public function AllOnlineStockists()
    {
        return null;
    }

    /**
     * @return Boolean
     */
    public function HasPhysicalStockistsANDOnlineStockists()
    {
        $a = $this->AllPhysicalStockists();
        $b = $this->AllOnlineStockists();
        if ($a && $b) {
            if ($a->count() && $b->count()) {
                return true;
            }
        }
        return false;
    }
}

class StockistSearchPage_Controller extends Page_Controller

PSR1 recommends that each class should be in its own file to aid autoloaders.

PSR1 recommends that each class must be in a namespace of at least one level to avoid collisions.

{

    /**
     * @inherited
     */
    private static $allowed_actions = array(

The property $allowed_actions is not used and could be removed.

        "showsearches" => "ADMIN",
        "updatemap" => "ADMIN",
        "showtype" => true,
        "showcountries" => true,
        "listofstockists" => true,
        "listofstockistscsv" => true,
        'addresssearch' => true,
        'addresssearchmap' => true,
        'SearchByAddressForm' => true,
    );

    public function init()
    {
        parent::init();
        $this->myCurrentCountryCode = EcommerceCountry::get_country();
        $this->HasGeoInfo = true;
    }

    public function index()
    {
        $this->addMap(
            $action = "showpointbyid",
            $title = $this->Title.' - '.$this->MyStockistCountryTitle(),
            $lng = 0,
            $lat = 0,
            implode(',', $this->locationsForCurrentCountry()->column("ID"))
        );
        return array();
    }

    public function MyAddAddressFinderForm()

The return type could not be reliably inferred; please add a @return annotation.

    {
        return $this->AddressFinderForm(array("StockistPage"));
    }

    /**
     * returns all the locations (GoogleMapLocationsObject) relevant
     * to the current user's country for display on the map.
     * We get the country from:
     * ```php
     *     $countryCode = EcommerceCountry::get_country();
     * ```
     *
     * @return DataList of GoogleMapLocationsObject
     */
    protected function locationsForCurrentCountry()
    {
        $objects = null;

$objects is not used, you could remove the assignment.

        if ($this->myCurrentCountryCode) {
            $objects = GoogleMapLocationsObject::get()->filter(array("CountryNameCode" => $this->myCurrentCountryCode));
            if ($objects->count()) {
                return $objects;
            }
        }
        $stockistCountryPage = StockistCountryPage::get()
            ->filter(array('CountryCode' => $this->myCurrentCountryCode))
            ->first();
        if(! $stockistCountryPage) {

This if statement is empty and can be removed.

            //use the AdditionalCountries to work out other options ...
        }
        if($stockistCountryPage) {
            $list = $stockistCountryPage->AllChildLocations();
            if($list->count()) {
                return $list;
            }
        }

        //final backup
        return GoogleMapLocationsObject::get();
    }

    public function AlphaList()

The return type could not be reliably inferred; please add a @return annotation.

    {
        if ($objects = $this->locationsForCurrentCountry()) {
            $parents = $objects->column('ParentID');
            if (count($parents)) {
                $pages = StockistPage::get()->filter(
                    array(
                        "ID" => $parents
                    )
                );
                if ($pages->count() < 25) {
                    return $pages;
                }
            }
        }
    }

    /**
     * @return DataList
     */
    public function Countries()
    {
        $objects = StockistCountryPage::get()->filter(array("ParentID" => $this->ID))->sort(array("Title" => "ASC"));
        if ($objects->count() == 0) {
            return StockistCountryPage::get()->filter(array("ID" => $this->ID));
        }
        return $objects;
    }

    /**
     * for template
     * @return Boolean
     */
    public function IsSearchPage()
    {
        return true;
    }

    public function IsStockistPage()
    {
        return true;
    }

    public function showsearches()
    {
        if (Permission::check('ADMIN')) {
            $sql = "
                SELECT SearchedFor
                FROM \"GoogleMapSearchRecord\"
                ORDER BY Created DESC
                LIMIT 10000
            ";
            $rows = DB::query($sql);
            if ($rows) {
                $this->Content .= "<h2>previous searches</h2><ul>";
                foreach ($rows as $row) {
                    $this->Content .= "<li>".$row["SearchedFor"]."</li>";
                }
                $this->Content .= "</ul>";
            }
            return array();
        }
        Security::permissionFailure($this, "You need to be logged in as administrator to see this map");
    }

    /**
     *
     * @param HTTPRequest
     */
    public function showtype($request)

The return type could not be reliably inferred; please add a @return annotation.

    {
        $type = $request->param("ID");
        return $this->redirect($this->Link()."#".$this->Link("showtype/$type/"));
    }

    /**
     * we use this specfically so that we can change the country for
     * a page.
     * @return String
     */
    public function MyStockistCountryTitle()
    {
        if ($this->myCurrentCountryCode) {
            return EcommerceCountry::find_title($this->myCurrentCountryCode);
        } else {
            return $this->MyCountryTitle();
        }
    }


    ####################################
    # CSV
    ####################################

    /**
     *
     * download CSV action
     */
    public function listofstockistscsv()
    {
        $html = $this->createListOfStockists();
        $html = mb_convert_encoding($html, 'HTML-ENTITIES', "UTF-8");

        /*** a new dom object ***/
        $dom = new domDocument;

        /*** load the html into the object ***/
        $dom->loadHTML($html);

        /*** discard white space ***/
        $dom->preserveWhiteSpace = false;

        /*** the table by its tag name ***/
        $htmlTable = $dom->getElementsByTagName('table');
        $htmlRows = $htmlTable->item(0)->getElementsByTagName('tr');
        $rowArray = array();
        foreach ($htmlRows as $htmlRow) {
            $headerCells = array();
            $htmlHeaders = $htmlRow->getElementsByTagName('th');
            foreach ($htmlHeaders as $htmlHeader) {
                $headerCells [] = $htmlHeader->nodeValue;
            }
            $htmlCells = $htmlRow->getElementsByTagName('td');
            $rowCells = array();
            foreach ($htmlCells as $htmlCell) {
                $rowCells [] = $htmlCell->nodeValue;
            }
            $rowArray[] = '"'.implode('", "', array_merge($headerCells, $rowCells)).'"';
        }
        $csv = implode("\r\n", $rowArray);
        $filename_prefix = 'stockists';
        $filename = $filename_prefix."_".date("Y-m-d_H-i", time());

        //Generate the CSV file header
        header("Content-type: application/vnd.ms-excel");
        header("Content-Encoding: UTF-8");
        header("Content-type: text/csv; charset=UTF-8");
        header("Content-disposition: csv" . date("Y-m-d") . ".csv");
        header("Content-disposition: filename=".$filename.".csv");
        echo "\xEF\xBB\xBF"; // UTF-8 BOM
        //Print the contents of out to the generated file.
        print $csv;
    }


    /**
     *
     * create HTML row for table of stockists
     */
    private function getChildrenAsHTMLRows($parent)
    {
        $childGroups = DataObject::get("SiteTree", "ParentID = ".$parent->ID);
        $html = "";
        if ($childGroups) {
            foreach ($childGroups as $childGroup) {
                $html .= $this->getChildrenAsHTMLRows($childGroup);
            }
        }
        $childStockists = DataObject::get("StockistPage", "ParentID = ".$parent->ID);
        if ($childStockists) {
            foreach ($childStockists as $stockist) {
                $stockistParent = $stockist;
                $parentNames = array();
                $stockistParent = DataObject::get_by_id("SiteTree", $stockistParent->ParentID);
                while ($stockistParent && ($stockistParent->ParentID)) {
                    $parentNames[] = $stockistParent->Title;
                    $stockistParent = DataObject::get_by_id("SiteTree", $stockistParent->ParentID);
                }
                $html .= "<tr>";
                $html .= "<td>".Convert::raw2xml(implode(", ", ($parentNames)))."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->Type)."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->Title)."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->City)."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->WebAddress)."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->Email)."</td>";
                $html .= "<td>".Convert::raw2xml($stockist->Phone)."</td>";
                $html .= "</tr>";
            }
        }
        return $html;
    }



    /**
     *
     * view list of stockists on blank screen with download link
     */
    public function listofstockists()
    {
        $html = "<h4><a href=\"".$this->Link("listofstockistscsv")."\">download csv file for Excel</a></h4>";
        $html .= $this->createListOfStockists();
        return $html;
    }


    private function createListOfStockists()
    {
        $html = "
        <table border=\"1\">
            <tr>
                <th>Region / Type</th>
                <th>Type</th>
                <th>Name</th>
                <th>City</th>
                <th>WebAddress</th>
                <th>Email</th>
                <th>Phone</th>
            </tr>";
        $html .= $this->getChildrenAsHTMLRows($this->Parent());
        $html .=   "</table>";
        return $html;
    }


    public function updatemap()
    {
        $pages = StockistPage::get()
            ->filter(array("HasGeoInfo" => 0));
        if ($pages && $pages->count()) {
            foreach ($pages as $page) {
                $page->write();
                $page->publish('Stage', 'Live');
            }
        }
        die("locations updated");

The method updatemap() contains an exit expression.

    }
}