├── .gitignore
├── CHANGELOG.md
├── LICENSE.md
├── README.md
├── composer.json
└── src
    ├── AutocompleteTwigExtension.php
    ├── AutocompleteVariable.php
    ├── craftcms
        ├── AutocompleteTwigExtension.php
        └── AutocompleteVariable.php
    ├── nystudio107
        ├── AutocompleteTwigExtension.php
        └── AutocompleteVariable.php
    └── putyourlightson
        ├── AutocompleteTwigExtension.php
        └── AutocompleteVariable.php


/.gitignore:
--------------------------------------------------------------------------------
1 | .DS_Store
2 | 


--------------------------------------------------------------------------------
/CHANGELOG.md:
--------------------------------------------------------------------------------
1 | # Release Notes for Autocomplete
2 | 
3 | ## 1.0.1 - 2021-07-23
4 | ### Added
5 | - Added a mixin for a root autocomplete variable.
6 | 
7 | ## 1.0.0 - 2021-07-15
8 | - Initial release.
9 | 


--------------------------------------------------------------------------------
/LICENSE.md:
--------------------------------------------------------------------------------
1 | Copyright © PutYourLightsOn
2 | 
3 | Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
4 | 
5 | The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
6 | 
7 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
8 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | [![Stable Version](https://img.shields.io/packagist/v/putyourlightson/craft-autocomplete?label=stable)]((https://packagist.org/packages/putyourlightson/craft-autocomplete))
 2 | [![Total Downloads](https://img.shields.io/packagist/dt/putyourlightson/craft-autocomplete)](https://packagist.org/packages/putyourlightson/craft-autocomplete)
 3 | 
 4 | # Autocomplete for Craft CMS [DEPRECATED]
 5 | 
 6 | ### ⚠️ This package has been replaced by the superior [Craft Autocomplete](https://github.com/nystudio107/craft-autocomplete) as a collaboration between [PutYourLightsOn](https://putyourlightson.com/) and [nystudio107](https://nystudio107.com/).
 7 | 
 8 | Provides autocompletion for Craft CMS and plugins in Twig templates. 
 9 |  
10 | Currently works with **PhpStorm only**, as VSCode does not support intellisense for Twig extensions.
11 | 
12 | Adapted from `FauxTwigExtension.php` by nystudio107 as documented in the article:  
13 | https://nystudio107.com/blog/auto-complete-craft-cms-3-apis-in-twig-with-phpstorm
14 | 
15 | ![demo](https://user-images.githubusercontent.com/57572400/126911028-7d7d06dd-c60f-42b9-ae42-95d5f078a229.gif)
16 | 
17 | ## Usage
18 | 
19 | Install the package using composer.
20 | 
21 | ```
22 | composer require putyourlightson/craft-autocomplete
23 | ```
24 | 
25 | Ensure that the Symfony plugin is installed and enabled in PhpStorm:  
26 | https://plugins.jetbrains.com/plugin/7219-symfony-plugin
27 |     
28 | Once your IDE indexes the files, autocompletion for Craft and supported plugins will immediately become available in your Twig templates.
29 | 
30 | ![screenshot](https://user-images.githubusercontent.com/57572400/125784167-618830ae-e475-4faf-81d3-194ad7ce3a08.png)
31 | 
32 | ### Adding Custom Variables
33 | 
34 | You can add autocompletion for your own custom modules/plugins by creating a file called `AutocompleteVariable.php` and placing it inside any folder that PhpStorm will index (for example in the `/config` directory).
35 | 
36 | ```php
37 | <?php
38 | 
39 | use craft\web\twig\variables\CraftVariable;
40 | use my\plugin\variables\MyVariable;
41 | 
42 | /**
43 |  * Adds variables to the global Craft Variable.
44 |  *
45 |  * @mixin MyVariable
46 |  */
47 | class AutocompleteVariable extends CraftVariable { }
48 | ```
49 | 
50 | ## Contributing
51 | 
52 | You can contribute autocompletion for third-party plugins that are available in the plugin store. To do so, copy the `src/putyourlightson` folder and rename it to your GitHub username. Modify the classes accordingly and add a `@mixin` for your variable to the main `AutocompleteVariable` class.
53 | 
54 | Ensure you follow the structure already in place, test that autocompletion works and submit a pull request.
55 | 
56 | ![screenshot-mixins](https://user-images.githubusercontent.com/57572400/125917480-cf4ca8f8-33ad-4f32-ae19-e05d8cfba7d9.png)
57 | 
58 | ---
59 | 
60 | Created by [PutYourLightsOn](https://putyourlightson.com/).
61 | 


--------------------------------------------------------------------------------
/composer.json:
--------------------------------------------------------------------------------
 1 | {
 2 |     "name": "putyourlightson/craft-autocomplete",
 3 |     "description": "Provides autocompletion for Craft and plugins in Twig templates.",
 4 |     "version": "1.0.1",
 5 |     "license": "MIT",
 6 |     "keywords": [
 7 |         "craft",
 8 |         "cms",
 9 |         "autocomplete",
10 |         "twig"
11 |     ],
12 |     "require": {
13 |         "craftcms/cms": "^3.0.0"
14 |     },
15 |     "support": {
16 |         "docs": "https://github.com/putyourlightson/craft-autocomplete"
17 |     },
18 |     "extra": {
19 |         "name": "Autocomplete",
20 |         "developer": "PutYourLightsOn",
21 |         "developerUrl": "https://putyourlightson.com/"
22 |     }
23 | }
24 | 


--------------------------------------------------------------------------------
/src/AutocompleteTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @copyright Copyright (c) nystudio107, PutYourLightsOn
 4 |  */
 5 | 
 6 | namespace putyourlightson\autocomplete;
 7 | 
 8 | use craft\elements\Asset;
 9 | use craft\elements\Category;
10 | use craft\elements\Entry;
11 | use craft\elements\Tag;
12 | use craft\elements\User;
13 | use craft\models\Section;
14 | use craft\models\Site;
15 | use DateTime;
16 | use Twig\Extension\AbstractExtension;
17 | use Twig\Extension\GlobalsInterface;
18 | 
19 | /**
20 |  * Adds globals to autocomplete in Twig templates.
21 |  */
22 | class AutocompleteTwigExtension extends AbstractExtension implements GlobalsInterface
23 | {
24 |     public function getGlobals(): array
25 |     {
26 |         return [
27 |             // Craft Variable
28 |             'craft' => new AutocompleteVariable(),
29 | 
30 |             // Craft Elements
31 |             'asset' => new Asset(),
32 |             'category' => new Category(),
33 |             'entry' => new Entry(),
34 |             'tag' => new Tag(),
35 |             'section' => new Section(),
36 | 
37 |             // Craft "Constants"
38 |             'SORT_ASC' => 4,
39 |             'SORT_DESC' => 3,
40 |             'SORT_REGULAR' => 0,
41 |             'SORT_NUMERIC' => 1,
42 |             'SORT_STRING' => 2,
43 |             'SORT_LOCALE_STRING' => 5,
44 |             'SORT_NATURAL' => 6,
45 |             'SORT_FLAG_CASE' => 8,
46 |             'POS_HEAD' => 1,
47 |             'POS_BEGIN' => 2,
48 |             'POS_END' => 3,
49 |             'POS_READY' => 4,
50 |             'POS_LOAD' => 5,
51 | 
52 |             // Craft Globals
53 |             'currentUser' => new User(),
54 |             'currentSite' => new Site(),
55 |             'now' => new DateTime(),
56 |         ];
57 |     }
58 | }
59 | 


--------------------------------------------------------------------------------
/src/AutocompleteVariable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @copyright Copyright (c) nystudio107, PutYourLightsOn
 4 |  */
 5 | 
 6 | namespace putyourlightson\autocomplete;
 7 | 
 8 | use craft\web\twig\variables\CraftVariable;
 9 | 
10 | /**
11 |  * Adds variables to the global Craft Variable.
12 |  *
13 |  * @mixin \AutocompleteVariable
14 |  * @mixin craftcms\AutocompleteVariable
15 |  * @mixin nystudio107\AutocompleteVariable
16 |  * @mixin putyourlightson\AutocompleteVariable
17 |  */
18 | class AutocompleteVariable extends CraftVariable { }
19 | 


--------------------------------------------------------------------------------
/src/craftcms/AutocompleteTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @copyright Copyright (c) nystudio107, PutYourLightsOn
 4 |  */
 5 | 
 6 | namespace putyourlightson\autocomplete\craftcms;
 7 | 
 8 | use craft\commerce\elements\Order;
 9 | use craft\commerce\elements\Product;
10 | use craft\commerce\models\LineItem;
11 | use Twig\Extension\AbstractExtension;
12 | use Twig\Extension\GlobalsInterface;
13 | 
14 | /**
15 |  * Adds globals to autocomplete in Twig templates.
16 |  */
17 | class AutocompleteTwigExtension extends AbstractExtension implements GlobalsInterface
18 | {
19 |     public function getGlobals(): array
20 |     {
21 |         return [
22 |             // Commerce
23 |             'cart' => new Order(),
24 |             'lineItem' => new LineItem(),
25 |             'order' => new Order(),
26 |             'product' => new Product(),
27 |         ];
28 |     }
29 | }
30 | 


--------------------------------------------------------------------------------
/src/craftcms/AutocompleteVariable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace putyourlightson\autocomplete\craftcms;
 4 | 
 5 | use craft\commerce\web\twig\CraftVariableBehavior;
 6 | use craft\web\twig\variables\CraftVariable;
 7 | 
 8 | /**
 9 |  * Adds variables to the global Craft Variable.
10 |  *
11 |  * @mixin CraftVariableBehavior
12 |  */
13 | class AutocompleteVariable extends CraftVariable { }
14 | 


--------------------------------------------------------------------------------
/src/nystudio107/AutocompleteTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | /**
 3 |  * @copyright Copyright (c) nystudio107, PutYourLightsOn
 4 |  */
 5 | 
 6 | namespace putyourlightson\autocomplete\nystudio107;
 7 | 
 8 | use nystudio107\seomatic\variables\SeomaticVariable;
 9 | use Twig\Extension\AbstractExtension;
10 | use Twig\Extension\GlobalsInterface;
11 | 
12 | /**
13 |  * Adds globals to autocomplete in Twig templates.
14 |  */
15 | class AutocompleteTwigExtension extends AbstractExtension implements GlobalsInterface
16 | {
17 |     public function getGlobals(): array
18 |     {
19 |         return [
20 |             // Seomatic
21 |             'seomatic' => new SeomaticVariable(),
22 |         ];
23 |     }
24 | }
25 | 


--------------------------------------------------------------------------------
/src/nystudio107/AutocompleteVariable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace putyourlightson\autocomplete\nystudio107;
 4 | 
 5 | use craft\web\twig\variables\CraftVariable;
 6 | use nystudio107\pluginmanifest\variables\ManifestVariable;
 7 | 
 8 | /**
 9 |  * Adds variables to the global Craft Variable.
10 |  *
11 |  * @property ManifestVariable $twigpack
12 |  */
13 | class AutocompleteVariable extends CraftVariable { }
14 | 


--------------------------------------------------------------------------------
/src/putyourlightson/AutocompleteTwigExtension.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace putyourlightson\autocomplete\putyourlightson;
 4 | 
 5 | use putyourlightson\campaign\elements\CampaignElement;
 6 | use putyourlightson\campaign\elements\ContactElement;
 7 | use putyourlightson\campaign\elements\MailingListElement;
 8 | use putyourlightson\campaign\elements\SegmentElement;
 9 | use putyourlightson\campaign\elements\SendoutElement;
10 | use putyourlightson\sprig\variables\PaginateVariable;
11 | use putyourlightson\sprig\variables\SprigVariable;
12 | use Twig\Extension\AbstractExtension;
13 | use Twig\Extension\GlobalsInterface;
14 | 
15 | /**
16 |  * Adds globals to autocomplete in Twig templates.
17 |  */
18 | class AutocompleteTwigExtension extends AbstractExtension implements GlobalsInterface
19 | {
20 |     public function getGlobals(): array
21 |     {
22 |         return [
23 |             // Campaign
24 |             'campaign' => new CampaignElement(),
25 |             'contact' => new ContactElement(),
26 |             'mailingList' => new MailingListElement(),
27 |             'segment' => new SegmentElement(),
28 |             'sendout' => new SendoutElement(),
29 | 
30 |             // Sprig
31 |             'sprig' => new SprigVariable(),
32 |             'pageInfo' => new PaginateVariable(),
33 |         ];
34 |     }
35 | }
36 | 


--------------------------------------------------------------------------------
/src/putyourlightson/AutocompleteVariable.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | namespace putyourlightson\autocomplete\putyourlightson;
 4 | 
 5 | use craft\web\twig\variables\CraftVariable;
 6 | use putyourlightson\blitz\variables\BlitzVariable;
 7 | use putyourlightson\campaign\variables\CampaignVariable;
 8 | use putyourlightson\sherlock\variables\SherlockVariable;
 9 | use putyourlightson\sprig\variables\SprigVariable;
10 | 
11 | /**
12 |  * Adds variables to the global Craft Variable.
13 |  *
14 |  * @property BlitzVariable $blitz
15 |  * @property CampaignVariable $campaign
16 |  * @property SherlockVariable $sherlock
17 |  * @property SprigVariable $sprig
18 |  */
19 | class AutocompleteVariable extends CraftVariable { }
20 | 


--------------------------------------------------------------------------------