├── LICENSE.md
├── README.md
├── license-mit.sublime-snippet
├── license-newbsd.sublime-snippet
├── php-getset.sublime-snippet
├── php-mit.sublime-snippet
├── php-newbsd.sublime-snippet
└── php-section-comment.sublime-snippet


/LICENSE.md:
--------------------------------------------------------------------------------
 1 | New BSD License
 2 | ===============
 3 | 
 4 | Copyright (c) 2012, Stuart Herbert and contributors
 5 | All rights reserved.
 6 | 
 7 | Redistribution and use in source and binary forms, with or without
 8 | modification, are permitted provided that the following conditions are met:
 9 | 
10 | * Redistributions of source code must retain the above copyright notice,
11 |   this list of conditions and the following disclaimer.
12 | * Redistributions in binary form must reproduce the above copyright notice,
13 |   this list of conditions and the following disclaimer in the documentation
14 |   and/or other materials provided with the distribution.
15 | * Neither the names of the copyright holders nor the names of its
16 |   contributors may be used to endorse or promote products derived from this
17 |   software without specific prior written permission.
18 | 
19 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
20 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
21 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
22 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
23 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
24 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
25 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
26 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
27 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
28 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
29 | POSSIBILITY OF SUCH DAMAGE.


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
 1 | Additional PHP Snippets For Sublime Text 2
 2 | ==========================================
 3 | 
 4 | [Sublime Text 2](http://www.sublimetext.com/2) already ships with a lot of snippets for writing PHP code. This is a collection of additional snippets contributed by the PHP community.
 5 | 
 6 | Installation
 7 | ------------
 8 | 
 9 | Use Sublime Text 2's [Package Control](http://wbond.net/sublime_packages/package_control) (Preferences -> Package Control -> Install Package -> Additional PHP Snippets) to install this plugin.
10 | 
11 | Snippets
12 | --------
13 | 
14 | We add the following snippets to speed up writing PHP code.
15 | 
16 | To use any of the snippets, simply type the name of the snippet, then press the <TAB> key.  Sublime Text 2 will insert the snippet, and you can then use the <TAB> key to move through any placeholders that you need to replace.
17 | 
18 | __For LICENSE.md-type files:__
19 | 
20 | * __license-mit__: insert the MIT license
21 | * __license-newbsd__: insert the new BSD license
22 | 
23 | __ For PHP files:__
24 | 
25 | * __php-getset__: create getter/setter methods quickly and easily (based on a snippet originally published by @akrabat)
26 | * __php-mit__: insert the MIT license as a PHP docblock
27 | * __php-newbsd__: insert the new BSD license as a PHP docblock
28 | * __php-section-comment__: insert a prominent comment to help break up the sections of your class
29 | 
30 | Contributions Welcome
31 | ---------------------
32 | 
33 | Requests for features, and pull requests with patches, are most welcome :)
34 | 


--------------------------------------------------------------------------------
/license-mit.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     license-mit
 3 |         Insert the MIT license into your file.
 4 | 
 5 |     HOW TO USE
 6 |         In your README file, simply type the following:
 7 | 
 8 |             license-mit<TAB><your name or organisation><email address>
 9 | 
10 |         Sublime Text will add the license to your file, and set the
11 |         copyright message to be your name.
12 | -->
13 | <snippet>
14 |     <content><![CDATA[
15 | 
16 | MIT License
17 | ===========
18 | 
19 | Copyright (c) 2012 ${1:[Your name]} <${2:[Your email]}>
20 | 
21 | Permission is hereby granted, free of charge, to any person obtaining a
22 | copy of this software and associated documentation files (the "Software"),
23 | to deal in the Software without restriction, including without limitation
24 | the rights to use, copy, modify, merge, publish, distribute, sublicense,
25 | and/or sell copies of the Software, and to permit persons to whom the
26 | Software is furnished to do so, subject to the following conditions:
27 | 
28 | The above copyright notice and this permission notice shall be included in
29 | all copies or substantial portions of the Software.
30 | 
31 | THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
32 | IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
33 | FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
34 | THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
35 | LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
36 | FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
37 | DEALINGS IN THE SOFTWARE.
38 | ]]></content>
39 |     <!-- Optional: Tab trigger to activate the snippet -->
40 |     <tabTrigger>license-mit</tabTrigger>
41 |     <!-- Optional: Description to show in the menu -->
42 |     <description>Add the MIT license to a plain text file</description>
43 | </snippet>


--------------------------------------------------------------------------------
/license-newbsd.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     license-newbsd
 3 |         Insert the New BSD license into your file.
 4 | 
 5 |     HOW TO USE
 6 |         In your PHP class, simply type the following:
 7 | 
 8 |             license-newbsd<TAB><your name or organisation>
 9 | 
10 |         Sublime Text will add the license to your file, and set the
11 |         copyright message to be your name.
12 | -->
13 | <snippet>
14 |     <content><![CDATA[
15 | 
16 | New BSD License
17 | ===============
18 | 
19 | Copyright (c) 2012, ${1:[ Copyright Holder ]}
20 | All rights reserved.
21 | 
22 | Redistribution and use in source and binary forms, with or without
23 | modification, are permitted provided that the following conditions are met:
24 | 
25 | * Redistributions of source code must retain the above copyright notice,
26 |   this list of conditions and the following disclaimer.
27 | * Redistributions in binary form must reproduce the above copyright notice,
28 |   this list of conditions and the following disclaimer in the documentation
29 |   and/or other materials provided with the distribution.
30 | * Neither the names of the copyright holders nor the names of its
31 |   contributors may be used to endorse or promote products derived from this
32 |   software without specific prior written permission.
33 | 
34 | THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
35 | AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
36 | IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
37 | ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE
38 | LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
39 | CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
40 | SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
41 | INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
42 | CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
43 | ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
44 | POSSIBILITY OF SUCH DAMAGE.
45 | ]]></content>
46 |     <!-- Optional: Tab trigger to activate the snippet -->
47 |     <tabTrigger>license-newbsd</tabTrigger>
48 |     <!-- Optional: Description to show in the menu -->
49 |     <description>Add New BSD license to a plain text file</description>
50 | </snippet>


--------------------------------------------------------------------------------
/php-getset.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     php-getset
 3 |         A time-saving device for creating getters & setters in PHP classes
 4 | 
 5 |         Based on a snippet originall published by @akrabat:
 6 |         http://akrabat.com/software/sublime-text-2-snippet-for-php-getter-and-setter-generation/
 7 | 
 8 |     HOW TO USE
 9 |         In your PHP class, simply type the following:
10 | 
11 |             php-getset<TAB><name of your property without a $ sign>
12 | 
13 |         Sublime Text will add the getter and setter to your class, and
14 |         name them after your property.
15 | 
16 |         For example, if your property is called $connection, you would
17 |         go into your class, and type:
18 | 
19 |             php-getset<TAB>connection
20 | 
21 |         and Sublime Text will create getConnection() and setConnection()
22 |         methods for you.
23 | 
24 | -->
25 | <snippet>
26 |     <content><![CDATA[
27 | 
28 | /**
29 |  * ${2:[description here]}
30 |  *
31 |  * @return ${3:[type]} ${4:[description]}
32 |  */
33 | public function get${1/(.*)/\u$1/:[ Prop name ]}() {
34 |     return \$this->${1:[ Prop name ]};
35 | }
36 | 
37 | /**
38 |  * ${5:[Description]}
39 |  *
40 |  * @param ${3/(.*)/\u$1/:[type]} \$new${1:[ Prop name ]} ${4/(.*)/\u$1/:[description]}
41 |  */
42 | public function set${1/(.*)/\u$1/:[ Prop name ]}(\$${1/(.*)/$1/:[ Prop name ]}) {
43 |     \$this->${1:[Prop name ]} = \$${1/(.*)/$1/:[ Prop name ]};
44 | 
45 |     return \$this;
46 | }
47 | ]]></content>
48 |     <!-- Optional: Tab trigger to activate the snippet -->
49 |     <tabTrigger>php-getset</tabTrigger>
50 |     <!-- Optional: Scope the tab trigger will be active in -->
51 |     <scope>source.php</scope>
52 |     <!-- Optional: Description to show in the menu -->
53 |     <description>Create getter and setter methods</description>
54 | </snippet>
55 | 


--------------------------------------------------------------------------------
/php-mit.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     php-mit
 3 |         Inserts a DocBlock for the MIT license.
 4 | 
 5 |     HOW TO USE
 6 |         In your PHP class, go to the top of the file, and type
 7 | 
 8 |             php-mit<TAB>
 9 | 
10 |         Sublime Text will add the docblock for you. Now use <TAB> to work
11 |         through the fields you need to complete.
12 | 
13 | -->
14 | <snippet>
15 |     <content><![CDATA[
16 | /**
17 |  * MIT License
18 |  * ===========
19 |  *
20 |  * Copyright (c) 2012 ${1:[Your name]} <${2:[Your email]}>
21 |  *
22 |  * Permission is hereby granted, free of charge, to any person obtaining
23 |  * a copy of this software and associated documentation files (the
24 |  * "Software"), to deal in the Software without restriction, including
25 |  * without limitation the rights to use, copy, modify, merge, publish,
26 |  * distribute, sublicense, and/or sell copies of the Software, and to
27 |  * permit persons to whom the Software is furnished to do so, subject to
28 |  * the following conditions:
29 |  *
30 |  * The above copyright notice and this permission notice shall be included
31 |  * in all copies or substantial portions of the Software.
32 |  *
33 |  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
34 |  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
35 |  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
36 |  * IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
37 |  * CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
38 |  * TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
39 |  * SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
40 |  *
41 |  * @category   ${3:[ Category ]}
42 |  * @package    ${4:[ Package ]}
43 |  * @subpackage ${5:[ Subpackage ]}
44 |  * @author     ${1:[ Your name ]} <${2:[ [Your email ]}>
45 |  * @copyright  2012 ${1:[ Your name ]}.
46 |  * @license    http://www.opensource.org/licenses/mit-license.php  MIT License
47 |  * @version    ${6:[ Version ]}
48 |  * @link       http://${7:[ Your website ]}
49 |  */
50 | ]]></content>
51 |     <!-- Optional: Tab trigger to activate the snippet -->
52 |     <tabTrigger>php-mit</tabTrigger>
53 |     <!-- Optional: Scope the tab trigger will be active in -->
54 |     <scope>source.php</scope>
55 |     <!-- Optional: Description to show in the menu -->
56 |     <description>Insert the MIT license DocBlock</description>
57 | </snippet>
58 | 


--------------------------------------------------------------------------------
/php-newbsd.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     php-newbsd
 3 |         Inserts a DocBlock for the NewBSD license.
 4 | 
 5 |     HOW TO USE
 6 |         In your PHP class, go to the top of the file, and type
 7 | 
 8 |             php-newbsd<TAB>
 9 | 
10 |         Sublime Text will add the docblock for you. Now use <TAB> to work
11 |         through the fields you need to complete.
12 | 
13 | -->
14 | <snippet>
15 |     <content><![CDATA[
16 | /**
17 |  * Copyright (c) 2012 ${1:[ Copyright holder ]}.
18 |  * All rights reserved.
19 |  *
20 |  * Redistribution and use in source and binary forms, with or without
21 |  * modification, are permitted provided that the following conditions
22 |  * are met:
23 |  *
24 |  *   * Redistributions of source code must retain the above copyright
25 |  *     notice, this list of conditions and the following disclaimer.
26 |  *
27 |  *   * Redistributions in binary form must reproduce the above copyright
28 |  *     notice, this list of conditions and the following disclaimer in
29 |  *     the documentation and/or other materials provided with the
30 |  *     distribution.
31 |  *
32 |  *   * Neither the names of the copyright holders nor the names of the
33 |  *     contributors may be used to endorse or promote products derived
34 |  *     from this software without specific prior written permission.
35 |  *
36 |  * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
37 |  * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
38 |  * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
39 |  * FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
40 |  * COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
41 |  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
42 |  * BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
43 |  * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
44 |  * CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
45 |  * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
46 |  * ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
47 |  * POSSIBILITY OF SUCH DAMAGE.
48 |  *
49 |  * @package     ${2:[ Package ]}
50 |  * @subpackage  ${3:[ Subpackage ]}
51 |  * @author      ${4:[ Your name ]} <${5:[ Your email address ]}>
52 |  * @copyright   2012 ${1:[ Copyright holder ]}.
53 |  * @license     http://www.opensource.org/licenses/bsd-license.php  BSD License
54 |  * @link        http://${6:[ Your website ]}
55 |  * @version     @@PACKAGE_VERSION@@
56 |  */
57 | ]]></content>
58 |     <!-- Optional: Tab trigger to activate the snippet -->
59 |     <tabTrigger>php-newbsd</tabTrigger>
60 |     <!-- Optional: Scope the tab trigger will be active in -->
61 |     <scope>source.php</scope>
62 |     <!-- Optional: Description to show in the menu -->
63 |     <description>Insert New BSD license DocBlock</description>
64 | </snippet>


--------------------------------------------------------------------------------
/php-section-comment.sublime-snippet:
--------------------------------------------------------------------------------
 1 | <!--
 2 |     php-section-comment
 3 |         Insert an easy-to-spot comment to separate out different sections
 4 |         of your class
 5 | 
 6 |     HOW TO USE
 7 |         In your PHP class, simply type the following:
 8 | 
 9 |             php-section-comment<TAB>
10 | 
11 |         Sublime Text will add the comment for you.  Then use <TAB> to
12 |         fill out the details for your section comment
13 | 
14 | -->
15 | <snippet>
16 |     <content><![CDATA[
17 | // ==================================================================
18 | //
19 | // ${1:[ Section description goes here ... ]}
20 | //
21 | // ------------------------------------------------------------------
22 | 
23 | ]]></content>
24 |     <!-- Optional: Tab trigger to activate the snippet -->
25 |     <tabTrigger>php-section-comment</tabTrigger>
26 |     <!-- Optional: Scope the tab trigger will be active in -->
27 |     <scope>source.php</scope>
28 |     <!-- Optional: Description to show in the menu -->
29 |     <description>Insert a comment block at the start of a new section in your PHP class</description>
30 | </snippet>
31 | 


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