RecipePage::getRelatedRecipes() - Code Metrics - dynamic/silverstripe-recipe-book - Measure and Improve Code Quality continuously with Scrutinizer

RecipePage::getRelatedRecipes() A
last analyzed 2022-05-24 20:12 UTC

↳ Parent: RecipePage

Complexity

Conditions	1
Paths	1

Size

Total Lines	16
Code Lines	10

Duplication

Lines	0
Ratio	0 %

Importance

Changes	2
Bugs	0	Features	0

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

<?php

namespace Dynamic\RecipeBook\Page;

use Dynamic\RecipeBook\Model\RecipeDirection;
use Dynamic\RecipeBook\Model\RecipeIngredient;
use Sheadawson\Linkable\Forms\EmbeddedObjectField;
use Sheadawson\Linkable\Models\EmbeddedObject;
use SilverStripe\Forms\DropdownField;
use SilverStripe\Forms\FieldGroup;
use SilverStripe\Forms\FieldList;
use SilverStripe\Forms\GridField\GridField;
use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
use SilverStripe\Forms\GridField\GridFieldEditButton;
use SilverStripe\Forms\NumericField;
use SilverStripe\Forms\ReadonlyField;
use SilverStripe\Forms\TextField;
use SilverStripe\Forms\GridField\GridFieldDeleteAction;
use SilverStripe\ORM\DataObject;
use SilverStripe\ORM\DB;
use SilverStripe\ORM\HasManyList;
use SilverStripe\ORM\ManyManyList;
use SilverStripe\Versioned\GridFieldArchiveAction;
use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
use Symbiote\GridFieldExtensions\GridFieldOrderableRows;

/**
 * Class RecipePage
 * @package Dynamic\RecipeBook\Page
 *
 * @property int $Servings
 * @property string $PrepTime
 * @property string $CookTime
 * @property string $Difficulty
 * @property int $VideoID
 * @method EmbeddedObject Video()
 * @method HasManyList Ingredients()
 * @method HasManyList Directions()
 * @method ManyManyList Categories()
 */
class RecipePage extends \Page
{
    /**
     * @var string
     */
    private static $singular_name = 'Recipe';


    /**
     * @var string
     */
    private static $plural_name = 'Recipes';


    /**
     * @var string
     */
    private static $table_name = 'RecipePage';


    /**
     * @var array
     */
    private static $db = [

        'Servings' => 'Varchar(20)',
        'PrepTime' => 'Varchar(255)',
        'CookTime' => 'Varchar(255)',
        'Difficulty' => 'Varchar(255)',
    ];

    /**
     * @var array
     */
    private static $has_many = [

        'Ingredients' => RecipeIngredient::class,
        'Directions' => RecipeDirection::class,
    ];

    /**
     * @var array
     */
    private static $many_many = [

        'Categories' => RecipeCategoryPage::class,
    ];

    /**
     * @var array
     */
    private static $many_many_extraFields = [

        'Categories' => [
            'SortOrder' => 'Int',
        ],
    ];

    /**
     * @var array
     */
    private static $defaults = [

        'ShowInMenu' => false,
        'RelatedLimit' => 2,
    ];

    /**
     * @var bool
     */
    private static $can_be_root = false;


    /**
     * @var bool
     */
    private static $show_in_sitetree = false;


    /**
     * @var array
     */
    private static $allowed_children = [];


    /**
     * @return FieldList
     */
    public function getCMSFields()
    {
        $this->beforeUpdateCMSFields(function (FieldList $fields) {

            $fields->addFieldsToTab(
                'Root.Main',
                [
                    $toggle = FieldGroup::create(

                        'RecipeStatistics',
                        [
                            TextField::create('Servings')
                                ->setTitle('Servings'),
                            TextField::create('PrepTime')
                                ->setTitle('Prep Time'),
                            TextField::create('CookTime')
                                ->setTitle('Cook Time'),
                            TextField::create('Difficulty')
                                ->setTitle('Difficulty'),
                        ]
                    )->setTitle('Info'),
                ],
                'Content'
            );

            if ($this->exists()) {
                $fields->addFieldToTab(
                    'Root.Ingredients',
                    $ingredients = GridField::create(
                        'Ingredients',
                        'Ingredients',
                        $this->Ingredients(),
                        $ingredientsConfig = GridFieldConfig_RelationEditor::create()
                    )
                );

                $fields->addFieldToTab(
                    'Root.Directions',
                    $directions = GridField::create(
                        'Directions',
                        'Directions',
                        $this->Directions(),
                        $directionsConfig = GridFieldConfig_RelationEditor::create()
                    )
                );

                $fields->addFieldsToTab(
                    'Root.Categories',
                    [
                        ReadonlyField::create('PrimaryCategoryDisplay')
                            ->setTitle('Primary Category')
                            ->setValue($this->getPrimaryCategory()->Title),
                        $categories = GridField::create(

                            'Categories',
                            'Additional Categories',
                            $this->Categories()->exclude('ID', $this->ParentID)->sort('SortOrder'),
                            $catConfig = GridFieldConfig_RelationEditor::create()
                        ),
                    ]
                );

                $ingredientsConfig
                    ->addComponent(new GridFieldOrderableRows('Sort'))
                    ->removeComponentsByType(GridFieldAddExistingAutocompleter::class);

                $directionsConfig
                    ->addComponent(new GridFieldOrderableRows('Sort'))
                    ->removeComponentsByType(GridFieldAddExistingAutocompleter::class);

                $catConfig
                    ->removeComponentsByType([
                        GridFieldAddExistingAutocompleter::class,
                        GridFieldArchiveAction::class,
                        GridFieldEditButton::class,
                    ])
                    ->addComponents(
                        new GridFieldOrderableRows('SortOrder'),
                        $list = new GridFieldAddExistingSearchButton()
                    );

                $list->setSearchList(RecipeCategoryPage::get()->exclude('ID', $this->ParentID));
            }
        });

        return parent::getCMSFields();
    }

    /**
     * @return RecipeCategory|DataObject|null
     */
    public function getPrimaryCategory()
    {
        return $this->Parent();
    }

    /**
     * @return \SilverStripe\ORM\DataList
     */
    public function getCategoryList()
    {
        $categories[] = $this->ParentID;


        foreach ($this->Categories() as $cat) {
            $categories[] = $cat->ID;
        }

        $records = RecipeCategoryPage::get()->byIDs($categories);

        return $records;
    }

    /**
     * @return \SilverStripe\ORM\DataList
     */
    public function getRelatedRecipes()
    {
        $categories = $this->getCategoryList()->column('ID');

        $recipes = RecipePage::get()
            ->exclude('ID', $this->ID)
            ->filterAny([
                'ParentID' => $categories,
                'Categories.ID' => $categories,
            ])
            ->limit(15);

        $random = DB::get_conn()->random();
        $records = $recipes->sort($random)->limit($this->RelatedLimit);


        return $records;
    }
}


1			<?php
2
3			namespace Dynamic\RecipeBook\Page;
4
5			use Dynamic\RecipeBook\Model\RecipeDirection;
6			use Dynamic\RecipeBook\Model\RecipeIngredient;
7			use Sheadawson\Linkable\Forms\EmbeddedObjectField;
8			use Sheadawson\Linkable\Models\EmbeddedObject;
9			use SilverStripe\Forms\DropdownField;
10			use SilverStripe\Forms\FieldGroup;
11			use SilverStripe\Forms\FieldList;
12			use SilverStripe\Forms\GridField\GridField;
13			use SilverStripe\Forms\GridField\GridFieldAddExistingAutocompleter;
14			use SilverStripe\Forms\GridField\GridFieldConfig_RecordEditor;
15			use SilverStripe\Forms\GridField\GridFieldConfig_RelationEditor;
16			use SilverStripe\Forms\GridField\GridFieldEditButton;
17			use SilverStripe\Forms\NumericField;
18			use SilverStripe\Forms\ReadonlyField;
19			use SilverStripe\Forms\TextField;
20			use SilverStripe\Forms\GridField\GridFieldDeleteAction;
21			use SilverStripe\ORM\DataObject;
22			use SilverStripe\ORM\DB;
23			use SilverStripe\ORM\HasManyList;
24			use SilverStripe\ORM\ManyManyList;
25			use SilverStripe\Versioned\GridFieldArchiveAction;
26			use Symbiote\GridFieldExtensions\GridFieldAddExistingSearchButton;
27			use Symbiote\GridFieldExtensions\GridFieldOrderableRows;
28
29			/**
30			* Class RecipePage
31			* @package Dynamic\RecipeBook\Page
32			*
33			* @property int $Servings
34			* @property string $PrepTime
35			* @property string $CookTime
36			* @property string $Difficulty
37			* @property int $VideoID
38			* @method EmbeddedObject Video()
39			* @method HasManyList Ingredients()
40			* @method HasManyList Directions()
41			* @method ManyManyList Categories()
42			*/
43			class RecipePage extends \Page
44			{
45			/**
46			* @var string
47			*/
48			private static $singular_name = 'Recipe';
			0 ignored issues – show introduced 2020-11-11 00:40 UTC by Report Bug Copy Issue Report The private property `$singular_name` is not used, and could be removed. Loading history...
49
50			/**
51			* @var string
52			*/
53			private static $plural_name = 'Recipes';
			0 ignored issues – show introduced 2020-11-11 00:40 UTC by Report Bug Copy Issue Report The private property `$plural_name` is not used, and could be removed. Loading history...
54
55			/**
56			* @var string
57			*/
58			private static $table_name = 'RecipePage';
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$table_name` is not used, and could be removed. Loading history...
59
60			/**
61			* @var array
62			*/
63			private static $db = [
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$db` is not used, and could be removed. Loading history...
64			'Servings' => 'Varchar(20)',
65			'PrepTime' => 'Varchar(255)',
66			'CookTime' => 'Varchar(255)',
67			'Difficulty' => 'Varchar(255)',
68			];
69
70			/**
71			* @var array
72			*/
73			private static $has_many = [
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$has_many` is not used, and could be removed. Loading history...
74			'Ingredients' => RecipeIngredient::class,
75			'Directions' => RecipeDirection::class,
76			];
77
78			/**
79			* @var array
80			*/
81			private static $many_many = [
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$many_many` is not used, and could be removed. Loading history...
82			'Categories' => RecipeCategoryPage::class,
83			];
84
85			/**
86			* @var array
87			*/
88			private static $many_many_extraFields = [
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$many_many_extraFields` is not used, and could be removed. Loading history...
89			'Categories' => [
90			'SortOrder' => 'Int',
91			],
92			];
93
94			/**
95			* @var array
96			*/
97			private static $defaults = [
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$defaults` is not used, and could be removed. Loading history...
98			'ShowInMenu' => false,
99			'RelatedLimit' => 2,
100			];
101
102			/**
103			* @var bool
104			*/
105			private static $can_be_root = false;
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$can_be_root` is not used, and could be removed. Loading history...
106
107			/**
108			* @var bool
109			*/
110			private static $show_in_sitetree = false;
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$show_in_sitetree` is not used, and could be removed. Loading history...
111
112			/**
113			* @var array
114			*/
115			private static $allowed_children = [];
			0 ignored issues – show introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The private property `$allowed_children` is not used, and could be removed. Loading history...
116
117			/**
118			* @return FieldList
119			*/
120			public function getCMSFields()
121			{
122			$this->beforeUpdateCMSFields(function (FieldList $fields) {
123
124			$fields->addFieldsToTab(
125			'Root.Main',
126			[
127			$toggle = FieldGroup::create(
			0 ignored issues – show Unused Code introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The assignment to `$toggle` is dead and can be removed. Loading history...
128			'RecipeStatistics',
129			[
130			TextField::create('Servings')
131			->setTitle('Servings'),
132			TextField::create('PrepTime')
133			->setTitle('Prep Time'),
134			TextField::create('CookTime')
135			->setTitle('Cook Time'),
136			TextField::create('Difficulty')
137			->setTitle('Difficulty'),
138			]
139			)->setTitle('Info'),
140			],
141			'Content'
142			);
143
144			if ($this->exists()) {
145			$fields->addFieldToTab(
146			'Root.Ingredients',
147			$ingredients = GridField::create(
148			'Ingredients',
149			'Ingredients',
150			$this->Ingredients(),
151			$ingredientsConfig = GridFieldConfig_RelationEditor::create()
152			)
153			);
154
155			$fields->addFieldToTab(
156			'Root.Directions',
157			$directions = GridField::create(
158			'Directions',
159			'Directions',
160			$this->Directions(),
161			$directionsConfig = GridFieldConfig_RelationEditor::create()
162			)
163			);
164
165			$fields->addFieldsToTab(
166			'Root.Categories',
167			[
168			ReadonlyField::create('PrimaryCategoryDisplay')
169			->setTitle('Primary Category')
170			->setValue($this->getPrimaryCategory()->Title),
171			$categories = GridField::create(
			0 ignored issues – show Unused Code introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The assignment to `$categories` is dead and can be removed. Loading history...
172			'Categories',
173			'Additional Categories',
174			$this->Categories()->exclude('ID', $this->ParentID)->sort('SortOrder'),
175			$catConfig = GridFieldConfig_RelationEditor::create()
176			),
177			]
178			);
179
180			$ingredientsConfig
181			->addComponent(new GridFieldOrderableRows('Sort'))
182			->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
183
184			$directionsConfig
185			->addComponent(new GridFieldOrderableRows('Sort'))
186			->removeComponentsByType(GridFieldAddExistingAutocompleter::class);
187
188			$catConfig
189			->removeComponentsByType([
190			GridFieldAddExistingAutocompleter::class,
191			GridFieldArchiveAction::class,
192			GridFieldEditButton::class,
193			])
194			->addComponents(
195			new GridFieldOrderableRows('SortOrder'),
196			$list = new GridFieldAddExistingSearchButton()
197			);
198
199			$list->setSearchList(RecipeCategoryPage::get()->exclude('ID', $this->ParentID));
200			}
201			});
202
203			return parent::getCMSFields();
204			}
205
206			/**
207			* @return RecipeCategory\|DataObject\|null
208			*/
209			public function getPrimaryCategory()
210			{
211			return $this->Parent();
212			}
213
214			/**
215			* @return \SilverStripe\ORM\DataList
216			*/
217			public function getCategoryList()
218			{
219			$categories[] = $this->ParentID;
			0 ignored issues – show Comprehensibility Best Practice introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report `$categories` was never initialized. Although not strictly required by PHP, it is generally a good practice to add `$categories = array();` before regardless. Loading history...
220
221			foreach ($this->Categories() as $cat) {
222			$categories[] = $cat->ID;
223			}
224
225			$records = RecipeCategoryPage::get()->byIDs($categories);
226
227			return $records;
228			}
229
230			/**
231			* @return \SilverStripe\ORM\DataList
232			*/
233			public function getRelatedRecipes()
234			{
235			$categories = $this->getCategoryList()->column('ID');
236
237			$recipes = RecipePage::get()
238			->exclude('ID', $this->ID)
239			->filterAny([
240			'ParentID' => $categories,
241			'Categories.ID' => $categories,
242			])
243			->limit(15);
244
245			$random = DB::get_conn()->random();
246			$records = $recipes->sort($random)->limit($this->RelatedLimit);
			0 ignored issues – show Bug Best Practice introduced 2020-11-10 21:37 UTC by Report Bug Copy Issue Report The property `RelatedLimit` does not exist on `Dynamic\RecipeBook\Page\RecipePage`. Since you implemented `__get`, consider adding a @property annotation. Loading history...
247
248			return $records;
249			}
250			}
251

dynamic / silverstripe-recipe-book

RecipePage::getRelatedRecipes() A last analyzed 2022-05-24 20:12 UTC

Complexity

Size

Duplication

Importance

Duplication Side-by-Side

Filter issues like

RecipePage::getRelatedRecipes() A
last analyzed 2022-05-24 20:12 UTC