├── .github
    └── FUNDING.yml
├── .gitignore
├── LICENSE
├── README.md
├── google.png
├── icon.png
├── info.plist
├── pest.php
└── screenshot.png


/.github/FUNDING.yml:
--------------------------------------------------------------------------------
1 | github: [tillkruss, alexmartinfr]
2 | custom: ["https://www.paypal.me/tillkruss", "https://www.paypal.me/alexmartin"]
3 | 


--------------------------------------------------------------------------------
/.gitignore:
--------------------------------------------------------------------------------
1 | /vendor
2 | .DS_Store
3 | composer.lock
4 | 


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


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | # Pest PHP Docs Workflow for Alfred
 2 | 
 3 | An ultra-fast Pest PHP docs search workflow for [Alfred](https://www.alfredapp.com).
 4 | 
 5 | ![Screenshot](screenshot.png)
 6 | 
 7 | ## Installation
 8 | 
 9 | 1. [Download the latest version](https://github.com/AlexMartinFR/alfred-pestphp-docs/releases/download/v0.1.0/pestphp-docs.alfredworkflow)
10 | 2. Install the workflow by double-clicking the `.alfredworkflow` file
11 | 3. You can add the workflow to a category, then click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.
12 | 
13 | ## Usage
14 | 
15 | Just type `pest` followed by your search query:
16 | 
17 | ```
18 | pest <query>
19 | pest test
20 | ```
21 | 
22 | Either press `⌘Y` to Quick Look the result, or press `<enter>` to open it in your web browser.
23 | 
24 | ## Credits
25 | 
26 | This workflow is based on Till Kruss' [Laravel Docs workflow](https://github.com/tillkruss/alfred-laravel-docs).


--------------------------------------------------------------------------------
/google.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/alexmartinfr/alfred-pestphp-docs/3f4004665340c2023f661c60ed5794aafe2f78ad/google.png


--------------------------------------------------------------------------------
/icon.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/alexmartinfr/alfred-pestphp-docs/3f4004665340c2023f661c60ed5794aafe2f78ad/icon.png


--------------------------------------------------------------------------------
/info.plist:
--------------------------------------------------------------------------------
  1 | <?xml version="1.0" encoding="UTF-8"?>
  2 | <!DOCTYPE plist PUBLIC "-//Apple//DTD PLIST 1.0//EN" "http://www.apple.com/DTDs/PropertyList-1.0.dtd">
  3 | <plist version="1.0">
  4 | <dict>
  5 | 	<key>bundleid</key>
  6 | 	<string>com.alexmartinfr.alfred-pestphp-doc</string>
  7 | 	<key>category</key>
  8 | 	<string>Productivity</string>
  9 | 	<key>connections</key>
 10 | 	<dict>
 11 | 		<key>5F3B3AF3-9709-4EE5-8742-31952977E46C</key>
 12 | 		<array>
 13 | 			<dict>
 14 | 				<key>destinationuid</key>
 15 | 				<string>3A309868-3B85-42B4-AA2F-26EB0FB9F4BE</string>
 16 | 				<key>modifiers</key>
 17 | 				<integer>0</integer>
 18 | 				<key>modifiersubtext</key>
 19 | 				<string></string>
 20 | 				<key>vitoclose</key>
 21 | 				<false/>
 22 | 			</dict>
 23 | 		</array>
 24 | 	</dict>
 25 | 	<key>createdby</key>
 26 | 	<string>Alex Martin</string>
 27 | 	<key>description</key>
 28 | 	<string>An ultra-fast Pest PHP docs search workflow</string>
 29 | 	<key>disabled</key>
 30 | 	<false/>
 31 | 	<key>name</key>
 32 | 	<string>Pest PHP Docs</string>
 33 | 	<key>objects</key>
 34 | 	<array>
 35 | 		<dict>
 36 | 			<key>config</key>
 37 | 			<dict>
 38 | 				<key>browser</key>
 39 | 				<string></string>
 40 | 				<key>spaces</key>
 41 | 				<string></string>
 42 | 				<key>url</key>
 43 | 				<string>{query}</string>
 44 | 				<key>utf8</key>
 45 | 				<true/>
 46 | 			</dict>
 47 | 			<key>type</key>
 48 | 			<string>alfred.workflow.action.openurl</string>
 49 | 			<key>uid</key>
 50 | 			<string>3A309868-3B85-42B4-AA2F-26EB0FB9F4BE</string>
 51 | 			<key>version</key>
 52 | 			<integer>1</integer>
 53 | 		</dict>
 54 | 		<dict>
 55 | 			<key>config</key>
 56 | 			<dict>
 57 | 				<key>alfredfiltersresults</key>
 58 | 				<false/>
 59 | 				<key>alfredfiltersresultsmatchmode</key>
 60 | 				<integer>0</integer>
 61 | 				<key>argumenttreatemptyqueryasnil</key>
 62 | 				<false/>
 63 | 				<key>argumenttrimmode</key>
 64 | 				<integer>0</integer>
 65 | 				<key>argumenttype</key>
 66 | 				<integer>0</integer>
 67 | 				<key>escaping</key>
 68 | 				<integer>4</integer>
 69 | 				<key>keyword</key>
 70 | 				<string>pest</string>
 71 | 				<key>queuedelaycustom</key>
 72 | 				<integer>3</integer>
 73 | 				<key>queuedelayimmediatelyinitially</key>
 74 | 				<true/>
 75 | 				<key>queuedelaymode</key>
 76 | 				<integer>0</integer>
 77 | 				<key>queuemode</key>
 78 | 				<integer>1</integer>
 79 | 				<key>runningsubtext</key>
 80 | 				<string>Searching docs for "{query}"...</string>
 81 | 				<key>script</key>
 82 | 				<string>php pest.php "{query}"</string>
 83 | 				<key>scriptargtype</key>
 84 | 				<integer>0</integer>
 85 | 				<key>scriptfile</key>
 86 | 				<string></string>
 87 | 				<key>subtext</key>
 88 | 				<string>Search the Pest PHP docs...</string>
 89 | 				<key>title</key>
 90 | 				<string>Pest Docs</string>
 91 | 				<key>type</key>
 92 | 				<integer>0</integer>
 93 | 				<key>withspace</key>
 94 | 				<true/>
 95 | 			</dict>
 96 | 			<key>type</key>
 97 | 			<string>alfred.workflow.input.scriptfilter</string>
 98 | 			<key>uid</key>
 99 | 			<string>5F3B3AF3-9709-4EE5-8742-31952977E46C</string>
100 | 			<key>version</key>
101 | 			<integer>3</integer>
102 | 		</dict>
103 | 	</array>
104 | 	<key>readme</key>
105 | 	<string># Pest PHP Docs Workflow for Alfred
106 | 
107 | An ultra-fast Pest PHP docs search workflow for Alfred.
108 | 
109 | ## Installation
110 | 
111 | 1. Download the latest version: https://github.com/AlexMartinFR/alfred-pestphp-docs/releases/download/v0.1.0/pestphp-docs.alfredworkflow
112 | 
113 | 2. Install the workflow by double-clicking the `.alfredworkflow` file
114 | 
115 | 3. Click "Import" to finish importing. You'll now see the workflow listed in the left sidebar of your Workflows preferences pane.
116 | 
117 | ## Usage
118 | 
119 | Just type `pest` followed by your search query:
120 | 
121 | ```
122 | pest &lt;query&gt;
123 | pest test
124 | ```
125 | 
126 | Either press `⌘Y` to Quick Look the result, or press `&lt;enter&gt;` to open it in your web browser.
127 | 
128 | ## Credits
129 | 
130 | This workflow is based on Till Kruss' Laravel Docs workflow:
131 | https://github.com/tillkruss/alfred-laravel-docs</string>
132 | 	<key>uidata</key>
133 | 	<dict>
134 | 		<key>3A309868-3B85-42B4-AA2F-26EB0FB9F4BE</key>
135 | 		<dict>
136 | 			<key>xpos</key>
137 | 			<integer>545</integer>
138 | 			<key>ypos</key>
139 | 			<integer>145</integer>
140 | 		</dict>
141 | 		<key>5F3B3AF3-9709-4EE5-8742-31952977E46C</key>
142 | 		<dict>
143 | 			<key>xpos</key>
144 | 			<integer>235</integer>
145 | 			<key>ypos</key>
146 | 			<integer>145</integer>
147 | 		</dict>
148 | 	</dict>
149 | 	<key>variablesdontexport</key>
150 | 	<array/>
151 | 	<key>version</key>
152 | 	<string>0.1.0</string>
153 | 	<key>webaddress</key>
154 | 	<string>https://github.com/AlexMartinFR/alfred-pestphp-docs</string>
155 | </dict>
156 | </plist>
157 | 


--------------------------------------------------------------------------------
/pest.php:
--------------------------------------------------------------------------------
 1 | <?php
 2 | 
 3 | use Alfred\Workflows\Workflow;
 4 | 
 5 | use AlgoliaSearch\Client as Algolia;
 6 | use AlgoliaSearch\Version as AlgoliaUserAgent;
 7 | 
 8 | require __DIR__ . '/vendor/autoload.php';
 9 | 
10 | $query = $argv[1];
11 | $subtext = empty($_ENV['alfred_theme_subtext']) ? '0' : $_ENV['alfred_theme_subtext'];
12 | 
13 | $workflow = new Workflow;
14 | $parsedown = new Parsedown;
15 | $algolia = new Algolia('BH4D9OD16A', 'd25b0b281fd72e7b8ce770857fff45bf'); // Pest PHP
16 | AlgoliaUserAgent::addSuffixUserAgentSegment('Pest PHP Docs Alfred Workflow', '0.1.0');
17 | $index = $algolia->initIndex('pestphp');
18 | $search = $index->search($query);
19 | $results = $search['hits'];
20 | 
21 | $subtextSupported = $subtext === '0' || $subtext === '2';
22 | 
23 | if (empty($results)) {
24 |     $google = sprintf('https://www.google.com/search?q=%s', rawurlencode("pestphp {$query}"));
25 | 
26 |     $workflow->result()
27 |         ->title($subtextSupported ? 'Search Google' : 'No match found. Search Google...')
28 |         ->icon('google.png')
29 |         ->subtitle(sprintf('No match found. Search Google for: "%s"', $query))
30 |         ->arg($google)
31 |         ->quicklookurl($google)
32 |         ->valid(true);
33 | 
34 |     $workflow->result()
35 |         ->title($subtextSupported ? 'Open Docs' : 'No match found. Open docs...')
36 |         ->icon('icon.png')
37 |         ->subtitle('No match found. Open https://pestphp.com/docs/installation/...')
38 |         ->arg('https://pestphp.com/docs/installation/')
39 |         ->quicklookurl('https://pestphp.com/docs/installation/')
40 |         ->valid(true);
41 | 
42 |     echo $workflow->output();
43 |     exit;
44 | }
45 | 
46 | $urls = [];
47 | 
48 | foreach ($results as $hit) {
49 | 
50 |     $highestLvl = $hit['hierarchy']['lvl6'] ? 6 : ($hit['hierarchy']['lvl5'] ? 5 : ($hit['hierarchy']['lvl4'] ? 4 : ($hit['hierarchy']['lvl3'] ? 3 : ($hit['hierarchy']['lvl2'] ? 2 : ($hit['hierarchy']['lvl1'] ? 1 : 0)))));
51 | 
52 |     $title = $hit['hierarchy']['lvl' . $highestLvl];
53 |     $currentLvl = 0;
54 |     $subtitle = $hit['hierarchy']['lvl0'];
55 |     while ($currentLvl < $highestLvl) {
56 |         $currentLvl = $currentLvl + 1;
57 |         $subtitle = $subtitle . ' » ' . $hit['hierarchy']['lvl' . $currentLvl];
58 |     }
59 | 
60 |     $workflow->result()
61 |         ->uid($hit['objectID'])
62 |         ->title($title)
63 |         ->autocomplete($title)
64 |         ->subtitle($subtitle)
65 |         ->arg($hit['url'])
66 |         ->quicklookurl($hit['url'])
67 |         ->valid(true);
68 | }
69 | 
70 | echo $workflow->output();
71 | 


--------------------------------------------------------------------------------
/screenshot.png:
--------------------------------------------------------------------------------
https://raw.githubusercontent.com/alexmartinfr/alfred-pestphp-docs/3f4004665340c2023f661c60ed5794aafe2f78ad/screenshot.png


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