ModuleProductGroup

Complexity

Total Complexity

26

Size/Duplication

Total Lines	159
Duplicated Lines	0 %

Coupling/Cohesion

Components	0
Dependencies	3

Importance

Changes

0

7 Methods

Rating	Name	Duplication	Size	Complexity
A	i18n_singular_name()	0	4	1
A	i18n_plural_name()	0	4	1
A	getCMSFields()	0	6	1
C	currentInitialProducts()	0	44	13
A	getClassNameSQL()	0	4	1
A	currentClassNameSQL()	0	4	1
C	DefaultEcommerceProductTags()	0	38	8

<?php

/**
 * extension of Product Group
 *
 *
 *
 **/


class ModuleProductGroup extends ProductGroupWithTags

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

{

    /**
     * Standard SS variable.
     */
    private static $singular_name = "Module";

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

    public function i18n_singular_name()
    {
        return _t("ProductGroup.MODULEPRODUCTGROUP", "Module");
    }

    /**
     * Standard SS variable.
     */
    private static $plural_name = "Modules";

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

    public function i18n_plural_name()
    {
        return _t("ProductGroup.MODULEPRODUCTGROUPS", "Modules");
    }


    private static $default_child = 'ModuleProduct';

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

    private static $icon = "ecommerce_software/images/treeicons/ModuleProductGroup";

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

    /**
     * standard SS method
     */
    public function getCMSFields()

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

    {
        $fields = parent::getCMSFields();
        $fields->removeByName("Tags");
        return $fields;
    }

    /**
     * returns the inital (all) products, based on the all the eligile products
     * for the page.
     *
     * This is THE pivotal method that probably changes for classes that
     * extend ProductGroup as here you can determine what products or other buyables are shown.
     *
     * The return from this method will then be sorted and filtered to product the final product list
     *
     * @param string $extraFilter Additional SQL filters to apply to the Product retrieval

Should the type for parameter $extraFilter not be string|null?

     * @param boolean $recursive

There is no parameter named $recursive. Was it maybe removed?

     * @return DataObjectSet | Null
     **/
    public function currentInitialProducts($extraFilter = null, $alternativeFilterKey = '')
    {
        $this->allProducts = parent::currentInitialProducts($extraFilter, $alternativeFilterKey);
        if ($extraFilter) {

The expression $extraFilter of type string|null is loosely compared to true; this is ambiguous if the string can be empty. You might want to explicitly use !== null instead.

            if ($extraFilter instanceof DataObjectSet) {

The class DataObjectSet does not exist. Did you forget a USE statement, or did you not list all dependencies?

                $tags = $extraFilter;
                //do nothing
            } elseif ($extraFilter instanceof DataObject) {
                $tags = new ArrayList(array($extraFilter));
            } elseif (is_array($extraFilter) || intval($extraFilter) == $extraFilter) {
                $tags = EcommerceProductTag::get()
                    ->filter(array("ID" => $extraFilter));
            } else {
                user_error("Error in tags", E_USER_NOTICE);
            }
            $idArray = array();
            if ($tags->count()) {
                $stage = '';
                if (Versioned::current_stage() == "Live") {
                    $stage = "_Live";
                }
                if ($tags->count()) {
                    foreach ($tags as $tag) {
                        $rows = DB::query("
							SELECT \"ProductID\"
							FROM \"EcommerceProductTag_Products\"
								INNER JOIN \"ModuleProduct{$stage}\"
									ON \"ModuleProduct{$stage}\".\"ID\" = \"EcommerceProductTag_Products\".\"ProductID\"
							WHERE \"EcommerceProductTag_Products\".\"EcommerceProductTagID\" IN (".implode(",", $tags->column("ID")).")

The variable $tags does not seem to be defined for all execution paths leading up to this point.

						");
                        if ($rows) {
                            foreach ($rows as $row) {
                                $idArray[$row["ProductID"]] = $row["ProductID"];
                            }
                        }
                    }
                    if (count($idArray)) {
                        $this->allProducts = $this->allProducts->filter(array("ID" => $idArray));
                    }
                }
            }
        }
        return $this->allProducts;
    }

    /**
     * Returns the class we are working with for the initial product selection
     * @return String
     */
    protected function getClassNameSQL()
    {
        return "ModuleProduct";
    }



    /**
     * returns the CLASSNAME part of the final selection of products.
     * @return String
     */
    protected function currentClassNameSQL()
    {
        return "ModuleProduct";
    }


    /**
     * @param String $tagCode - code of the current tag.
     * @return Object - DataObjectSet - Tags that are related to ModuleProducts
     */
    public function DefaultEcommerceProductTags($tagCode = "")
    {
        $stage = '';
        if (Versioned::current_stage() == "Live") {
            $stage = "_Live";
        }
        $idArray = array();
        $productIDs[0] = 0;

$productIDs was never initialized. Although not strictly required by PHP, it is generally a good practice to add $productIDs = array(); before regardless.

        $rows = DB::query("
			SELECT \"EcommerceProductTagID\"
			FROM \"EcommerceProductTag_Products\"
				INNER JOIN \"ModuleProduct{$stage}\"
					ON \"ModuleProduct{$stage}\".\"ID\" = \"EcommerceProductTag_Products\".\"ProductID\"
				INNER JOIN \"SiteTree{$stage}\"
					ON \"ModuleProduct{$stage}\".\"ID\" = \"SiteTree{$stage}\".\"ID\"
			WHERE \"SiteTree{$stage}\".ShowInSearch = 1
		");
        if ($rows) {
            foreach ($rows as $row) {
                $idArray[$row["EcommerceProductTagID"]] = $row["EcommerceProductTagID"];
            }
        }
        if (count($idArray)) {
            $tags = EcommerceProductTag::get()
                ->filter(array("ID" => $idArray));
            if ($tags->count()) {
                foreach ($tags as $tag) {
                    $tag->Link = $this->Link("show")."/".$tag->Code."/";
                    if ($tag->Code == $tagCode) {
                        $tag->LinkingMode = "current";
                    } else {
                        $tag->LinkingMode = "link";
                    }
                }
            }
            return $tags;
        }
    }
}


class ModuleProductGroup_Controller extends ProductGroupWithTags_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.

{
    public function init()
    {
        parent::init();
        Requirements::javascript("ecommerce_software/javascript/ModuleProductGroup.js");
        Requirements::themedCSS("ModuleProduct", "ecommerce_software");
    }


    /**
     * Return the products for this group.
     *
     * @return DataObjectSet(Products)

The doc-type DataObjectSet(Products) could not be parsed: Expected "|" or "end of type", but got "(" at position 13. (view supported doc-types)

     **/
    public function Products()

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

    {
        if ($this->tag) {
            $toShow = $this->tag;
            Requirements::customScript("ModuleProductGroup.set_urlFiltered(true)", "set_urlFiltered");
        } else {
            $toShow = null;
        }
        return $this->ProductsShowable($toShow);
    }


    /**
     * Tags available in the template
     */
    public function Tags()

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

    {
        $tagCode = "";
        if ($this->tag) {
            $tagCode = $this->tag->Code;
        }
        return $this->DefaultEcommerceProductTags($tagCode);
    }



    /**
     * Site search form
     */
    public function ModuleSearchForm()
    {
        $searchText =  _t('ModuleProductGroup.KEYWORDS', 'keywords');

        if ($this->request) {
            $searchText = $this->request->getVar('Search');
        }

        $fields = new FieldList(
            new TextField('Search', _t('ModuleProductGroup.KEYWORDS', 'keywords'), $searchText)
        );
        $actions = new FieldList(
            new FormAction('modulesearchformresults',  _t('ModuleSearchForm.FILTER', 'Filter'))
        );
        $form = new SearchForm($this, 'ModuleSearchForm', $fields, $actions);
        $form->classesToSearch(array("SiteTree"));
        return $form;
    }

    /**
     * Process and render search results.
     *
     * @param array $data The raw request data submitted by user
     * @param SearchForm $form The form instance that was submitted
     * @param SS_HTTPRequest $request Request generated for this action
     */
    public function modulesearchformresults($data, $form, $request)

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

    {
        $data = array(
            'Results' => $form->getResults(),
            'Query' => $form->getSearchQuery(),
            'Title' => _t('SearchForm.SearchResults', 'Search Results')
        );
        //search tags
        //search authors
        if ($data["Results"]) {
            foreach ($data["Results"] as $key => $resultItem) {
                if (!($resultItem instanceof ModuleProduct)) {
                    ($data["Results"]->remove($resultItem));
                }
            }
        } else {
            $data["Results"] = new ArrayList();
        }
        $search = Convert::raw2sql($data["Query"]);
        if (strlen($search) > 2) {
            $additionalProducts = ModuleProduct::get()->filterAny(array("Code:PartialMatch" => $search, "MenuTitle:PartialMatch" => $search));
            if ($additionalProducts) {
                foreach ($additionalProducts as $moduleProduct) {
                    $data["Results"]->push($moduleProduct);

It seems like you code against a concrete implementation and not the interface SS_List as the method push() does only exist in the following implementations of said interface: ArrayList, DataList, FieldList, HasManyList, ManyManyList, Member_GroupSet, PolymorphicHasManyList, RelationList, UnsavedRelationList.

                }
            }
            $tags = EcommerceProductTag::get()->filterAny(array("Title:PartialMatch" => $search, "Synonyms:PartialMatch" => $search, "Explanation:PartialMatch" => $search));
            if ($tags->count()) {

This code seems to be duplicated across your project.

                foreach ($tags as $tag) {
                    $rows = DB::query("SELECT ProductID FROM EcommerceProductTag_Products WHERE EcommerceProductTagID = ".$tag->ID);
                    if ($rows) {
                        foreach ($rows as $row) {
                            $item = ModuleProduct::get()->byID($row["ProductID"]);
                            if ($item) {
                                $data["Results"]->push($item);

It seems like you code against a concrete implementation and not the interface SS_List as the method push() does only exist in the following implementations of said interface: ArrayList, DataList, FieldList, HasManyList, ManyManyList, Member_GroupSet, PolymorphicHasManyList, RelationList, UnsavedRelationList.

                            }
                        }
                    }
                }
            }
            $authors = Member::get()
                ->filterAny(
                    array(
                        "ScreenName:PartialMatch" => $search,
                        "FirstName:PartialMatch" => $search,
                        "Surname:PartialMatch" => $search)
                );
            if ($authors->count()) {

This code seems to be duplicated across your project.

                foreach ($authors as $author) {
                    $rows = DB::query("SELECT \"ModuleProductID\" FROM \"ModuleProduct_Authors\" WHERE \"MemberID\" = ".$author->ID);
                    if ($rows) {
                        foreach ($rows as $row) {
                            $item = ModuleProduct::get()->byID($row["ModuleProductID"]);
                            if ($item) {
                                $data["Results"]->push($item);

It seems like you code against a concrete implementation and not the interface SS_List as the method push() does only exist in the following implementations of said interface: ArrayList, DataList, FieldList, HasManyList, ManyManyList, Member_GroupSet, PolymorphicHasManyList, RelationList, UnsavedRelationList.

                            }
                        }
                    }
                }
            }
        }
        if ($data["Results"] && $data["Results"] instanceof DataObjectSet) {

The class DataObjectSet does not exist. Did you forget a USE statement, or did you not list all dependencies?

            $data["Results"]->removeDuplicates();
        }
        if (Director::is_ajax()) {
            return Convert::array2json(array("ModuleProducts" => $data["Results"]->column("ID")));
        }
        return $this->customise(array("Products" => $data["Results"]));
    }

    /**
     * Admin ONLY action
     * to view a list of all developers
     * that have not been contacted yet
     */
    public function introemails()

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

    {
        $i = 0;
        $member = Member::currentUser();
        $dos = new ArrayList();
        if ($member && $member->inGroup("ADMIN")) {
            $modules = ModuleProduct::get()
                ->filter(array("ShowInSearch" => 1, "ShowInMenus" => 1));
            foreach ($modules as $module) {
                if (!$module->HasEmail() && !$module->HasMemberContact()) {
                    $i++;
                    if ($i < 10) {
                        $dos->push($module);
                    } else {
                        break;
                    }
                }
            }
            return $this->customise(array("Products" => $dos));
        }
        Security::permissionFailure($this, "You need to log in as an Administrator.");
    }
}