├── .gitignore ├── CODE_OF_CONDUCT.md ├── CONTRIBUTING.md ├── COPYING ├── Cask ├── Makefile ├── README.md ├── SECURITY.md ├── dir ├── php-extras-gen-eldoc.el └── php-extras.el /.gitignore: -------------------------------------------------------------------------------- 1 | php-extras.info 2 | php-extras-pkg.el 3 | php-extras-*.tar 4 | php-extras-eldoc-functions.el* 5 | README 6 | .cask 7 | -------------------------------------------------------------------------------- /CODE_OF_CONDUCT.md: -------------------------------------------------------------------------------- 1 | # Contributor Covenant Code of Conduct 2 | 3 | ## Our Pledge 4 | 5 | In the interest of fostering an open and welcoming environment, we as 6 | contributors and maintainers pledge to making participation in our project and 7 | our community a harassment-free experience for everyone, regardless of age, body 8 | size, disability, ethnicity, sex characteristics, gender identity and expression, 9 | level of experience, education, socio-economic status, nationality, personal 10 | appearance, race, religion, or sexual identity and orientation. 11 | 12 | ## Our Standards 13 | 14 | Examples of behavior that contributes to creating a positive environment 15 | include: 16 | 17 | * Using welcoming and inclusive language 18 | * Being respectful of differing viewpoints and experiences 19 | * Gracefully accepting constructive criticism 20 | * Focusing on what is best for the community 21 | * Showing empathy towards other community members 22 | 23 | Examples of unacceptable behavior by participants include: 24 | 25 | * The use of sexualized language or imagery and unwelcome sexual attention or 26 | advances 27 | * Trolling, insulting/derogatory comments, and personal or political attacks 28 | * Public or private harassment 29 | * Publishing others' private information, such as a physical or electronic 30 | address, without explicit permission 31 | * Other conduct which could reasonably be considered inappropriate in a 32 | professional setting 33 | 34 | ## Our Responsibilities 35 | 36 | Project maintainers are responsible for clarifying the standards of acceptable 37 | behavior and are expected to take appropriate and fair corrective action in 38 | response to any instances of unacceptable behavior. 39 | 40 | Project maintainers have the right and responsibility to remove, edit, or 41 | reject comments, commits, code, wiki edits, issues, and other contributions 42 | that are not aligned to this Code of Conduct, or to ban temporarily or 43 | permanently any contributor for other behaviors that they deem inappropriate, 44 | threatening, offensive, or harmful. 45 | 46 | ## Scope 47 | 48 | This Code of Conduct applies both within project spaces and in public spaces 49 | when an individual is representing the project or its community. Examples of 50 | representing a project or community include using an official project e-mail 51 | address, posting via an official social media account, or acting as an appointed 52 | representative at an online or offline event. Representation of a project may be 53 | further defined and clarified by project maintainers. 54 | 55 | ## Enforcement 56 | 57 | Instances of abusive, harassing, or otherwise unacceptable behavior may be 58 | reported by contacting the project team at arne@arnested.dk. All 59 | complaints will be reviewed and investigated and will result in a response that 60 | is deemed necessary and appropriate to the circumstances. The project team is 61 | obligated to maintain confidentiality with regard to the reporter of an incident. 62 | Further details of specific enforcement policies may be posted separately. 63 | 64 | Project maintainers who do not follow or enforce the Code of Conduct in good 65 | faith may face temporary or permanent repercussions as determined by other 66 | members of the project's leadership. 67 | 68 | ## Attribution 69 | 70 | This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4, 71 | available at https://www.contributor-covenant.org/version/1/4/code-of-conduct.html 72 | 73 | [homepage]: https://www.contributor-covenant.org 74 | 75 | For answers to common questions about this code of conduct, see 76 | https://www.contributor-covenant.org/faq 77 | -------------------------------------------------------------------------------- /CONTRIBUTING.md: -------------------------------------------------------------------------------- 1 | # Developer Certificate of Origin 2 | 3 | ``` 4 | Version 1.1 5 | 6 | Copyright (C) 2004, 2006 The Linux Foundation and its contributors. 7 | 1 Letterman Drive 8 | Suite D4700 9 | San Francisco, CA, 94129 10 | 11 | Everyone is permitted to copy and distribute verbatim copies of this 12 | license document, but changing it is not allowed. 13 | 14 | 15 | Developer's Certificate of Origin 1.1 16 | 17 | By making a contribution to this project, I certify that: 18 | 19 | (a) The contribution was created in whole or in part by me and I 20 | have the right to submit it under the open source license 21 | indicated in the file; or 22 | 23 | (b) The contribution is based upon previous work that, to the best 24 | of my knowledge, is covered under an appropriate open source 25 | license and I have the right under that license to submit that 26 | work with modifications, whether created in whole or in part 27 | by me, under the same open source license (unless I am 28 | permitted to submit under a different license), as indicated 29 | in the file; or 30 | 31 | (c) The contribution was provided directly to me by some other 32 | person who certified (a), (b) or (c) and I have not modified 33 | it. 34 | 35 | (d) I understand and agree that this project and the contribution 36 | are public and that a record of the contribution (including all 37 | personal information I submit with it, including my sign-off) is 38 | maintained indefinitely and may be redistributed consistent with 39 | this project or the open source license(s) involved. 40 | ``` 41 | -------------------------------------------------------------------------------- /COPYING: -------------------------------------------------------------------------------- 1 | GNU GENERAL PUBLIC LICENSE 2 | Version 3, 29 June 2007 3 | 4 | Copyright (C) 2007 Free Software Foundation, Inc. 5 | Everyone is permitted to copy and distribute verbatim copies 6 | of this license document, but changing it is not allowed. 7 | 8 | Preamble 9 | 10 | The GNU General Public License is a free, copyleft license for 11 | software and other kinds of works. 12 | 13 | The licenses for most software and other practical works are designed 14 | to take away your freedom to share and change the works. By contrast, 15 | the GNU General Public License is intended to guarantee your freedom to 16 | share and change all versions of a program--to make sure it remains free 17 | software for all its users. We, the Free Software Foundation, use the 18 | GNU General Public License for most of our software; it applies also to 19 | any other work released this way by its authors. You can apply it to 20 | your programs, too. 21 | 22 | When we speak of free software, we are referring to freedom, not 23 | price. Our General Public Licenses are designed to make sure that you 24 | have the freedom to distribute copies of free software (and charge for 25 | them if you wish), that you receive source code or can get it if you 26 | want it, that you can change the software or use pieces of it in new 27 | free programs, and that you know you can do these things. 28 | 29 | To protect your rights, we need to prevent others from denying you 30 | these rights or asking you to surrender the rights. Therefore, you have 31 | certain responsibilities if you distribute copies of the software, or if 32 | you modify it: responsibilities to respect the freedom of others. 33 | 34 | For example, if you distribute copies of such a program, whether 35 | gratis or for a fee, you must pass on to the recipients the same 36 | freedoms that you received. You must make sure that they, too, receive 37 | or can get the source code. And you must show them these terms so they 38 | know their rights. 39 | 40 | Developers that use the GNU GPL protect your rights with two steps: 41 | (1) assert copyright on the software, and (2) offer you this License 42 | giving you legal permission to copy, distribute and/or modify it. 43 | 44 | For the developers' and authors' protection, the GPL clearly explains 45 | that there is no warranty for this free software. For both users' and 46 | authors' sake, the GPL requires that modified versions be marked as 47 | changed, so that their problems will not be attributed erroneously to 48 | authors of previous versions. 49 | 50 | Some devices are designed to deny users access to install or run 51 | modified versions of the software inside them, although the manufacturer 52 | can do so. This is fundamentally incompatible with the aim of 53 | protecting users' freedom to change the software. The systematic 54 | pattern of such abuse occurs in the area of products for individuals to 55 | use, which is precisely where it is most unacceptable. Therefore, we 56 | have designed this version of the GPL to prohibit the practice for those 57 | products. If such problems arise substantially in other domains, we 58 | stand ready to extend this provision to those domains in future versions 59 | of the GPL, as needed to protect the freedom of users. 60 | 61 | Finally, every program is threatened constantly by software patents. 62 | States should not allow patents to restrict development and use of 63 | software on general-purpose computers, but in those that do, we wish to 64 | avoid the special danger that patents applied to a free program could 65 | make it effectively proprietary. To prevent this, the GPL assures that 66 | patents cannot be used to render the program non-free. 67 | 68 | The precise terms and conditions for copying, distribution and 69 | modification follow. 70 | 71 | TERMS AND CONDITIONS 72 | 73 | 0. Definitions. 74 | 75 | "This License" refers to version 3 of the GNU General Public License. 76 | 77 | "Copyright" also means copyright-like laws that apply to other kinds of 78 | works, such as semiconductor masks. 79 | 80 | "The Program" refers to any copyrightable work licensed under this 81 | License. Each licensee is addressed as "you". "Licensees" and 82 | "recipients" may be individuals or organizations. 83 | 84 | To "modify" a work means to copy from or adapt all or part of the work 85 | in a fashion requiring copyright permission, other than the making of an 86 | exact copy. The resulting work is called a "modified version" of the 87 | earlier work or a work "based on" the earlier work. 88 | 89 | A "covered work" means either the unmodified Program or a work based 90 | on the Program. 91 | 92 | To "propagate" a work means to do anything with it that, without 93 | permission, would make you directly or secondarily liable for 94 | infringement under applicable copyright law, except executing it on a 95 | computer or modifying a private copy. Propagation includes copying, 96 | distribution (with or without modification), making available to the 97 | public, and in some countries other activities as well. 98 | 99 | To "convey" a work means any kind of propagation that enables other 100 | parties to make or receive copies. Mere interaction with a user through 101 | a computer network, with no transfer of a copy, is not conveying. 102 | 103 | An interactive user interface displays "Appropriate Legal Notices" 104 | to the extent that it includes a convenient and prominently visible 105 | feature that (1) displays an appropriate copyright notice, and (2) 106 | tells the user that there is no warranty for the work (except to the 107 | extent that warranties are provided), that licensees may convey the 108 | work under this License, and how to view a copy of this License. If 109 | the interface presents a list of user commands or options, such as a 110 | menu, a prominent item in the list meets this criterion. 111 | 112 | 1. Source Code. 113 | 114 | The "source code" for a work means the preferred form of the work 115 | for making modifications to it. "Object code" means any non-source 116 | form of a work. 117 | 118 | A "Standard Interface" means an interface that either is an official 119 | standard defined by a recognized standards body, or, in the case of 120 | interfaces specified for a particular programming language, one that 121 | is widely used among developers working in that language. 122 | 123 | The "System Libraries" of an executable work include anything, other 124 | than the work as a whole, that (a) is included in the normal form of 125 | packaging a Major Component, but which is not part of that Major 126 | Component, and (b) serves only to enable use of the work with that 127 | Major Component, or to implement a Standard Interface for which an 128 | implementation is available to the public in source code form. A 129 | "Major Component", in this context, means a major essential component 130 | (kernel, window system, and so on) of the specific operating system 131 | (if any) on which the executable work runs, or a compiler used to 132 | produce the work, or an object code interpreter used to run it. 133 | 134 | The "Corresponding Source" for a work in object code form means all 135 | the source code needed to generate, install, and (for an executable 136 | work) run the object code and to modify the work, including scripts to 137 | control those activities. However, it does not include the work's 138 | System Libraries, or general-purpose tools or generally available free 139 | programs which are used unmodified in performing those activities but 140 | which are not part of the work. For example, Corresponding Source 141 | includes interface definition files associated with source files for 142 | the work, and the source code for shared libraries and dynamically 143 | linked subprograms that the work is specifically designed to require, 144 | such as by intimate data communication or control flow between those 145 | subprograms and other parts of the work. 146 | 147 | The Corresponding Source need not include anything that users 148 | can regenerate automatically from other parts of the Corresponding 149 | Source. 150 | 151 | The Corresponding Source for a work in source code form is that 152 | same work. 153 | 154 | 2. Basic Permissions. 155 | 156 | All rights granted under this License are granted for the term of 157 | copyright on the Program, and are irrevocable provided the stated 158 | conditions are met. This License explicitly affirms your unlimited 159 | permission to run the unmodified Program. The output from running a 160 | covered work is covered by this License only if the output, given its 161 | content, constitutes a covered work. This License acknowledges your 162 | rights of fair use or other equivalent, as provided by copyright law. 163 | 164 | You may make, run and propagate covered works that you do not 165 | convey, without conditions so long as your license otherwise remains 166 | in force. You may convey covered works to others for the sole purpose 167 | of having them make modifications exclusively for you, or provide you 168 | with facilities for running those works, provided that you comply with 169 | the terms of this License in conveying all material for which you do 170 | not control copyright. Those thus making or running the covered works 171 | for you must do so exclusively on your behalf, under your direction 172 | and control, on terms that prohibit them from making any copies of 173 | your copyrighted material outside their relationship with you. 174 | 175 | Conveying under any other circumstances is permitted solely under 176 | the conditions stated below. Sublicensing is not allowed; section 10 177 | makes it unnecessary. 178 | 179 | 3. Protecting Users' Legal Rights From Anti-Circumvention Law. 180 | 181 | No covered work shall be deemed part of an effective technological 182 | measure under any applicable law fulfilling obligations under article 183 | 11 of the WIPO copyright treaty adopted on 20 December 1996, or 184 | similar laws prohibiting or restricting circumvention of such 185 | measures. 186 | 187 | When you convey a covered work, you waive any legal power to forbid 188 | circumvention of technological measures to the extent such circumvention 189 | is effected by exercising rights under this License with respect to 190 | the covered work, and you disclaim any intention to limit operation or 191 | modification of the work as a means of enforcing, against the work's 192 | users, your or third parties' legal rights to forbid circumvention of 193 | technological measures. 194 | 195 | 4. Conveying Verbatim Copies. 196 | 197 | You may convey verbatim copies of the Program's source code as you 198 | receive it, in any medium, provided that you conspicuously and 199 | appropriately publish on each copy an appropriate copyright notice; 200 | keep intact all notices stating that this License and any 201 | non-permissive terms added in accord with section 7 apply to the code; 202 | keep intact all notices of the absence of any warranty; and give all 203 | recipients a copy of this License along with the Program. 204 | 205 | You may charge any price or no price for each copy that you convey, 206 | and you may offer support or warranty protection for a fee. 207 | 208 | 5. Conveying Modified Source Versions. 209 | 210 | You may convey a work based on the Program, or the modifications to 211 | produce it from the Program, in the form of source code under the 212 | terms of section 4, provided that you also meet all of these conditions: 213 | 214 | a) The work must carry prominent notices stating that you modified 215 | it, and giving a relevant date. 216 | 217 | b) The work must carry prominent notices stating that it is 218 | released under this License and any conditions added under section 219 | 7. This requirement modifies the requirement in section 4 to 220 | "keep intact all notices". 221 | 222 | c) You must license the entire work, as a whole, under this 223 | License to anyone who comes into possession of a copy. This 224 | License will therefore apply, along with any applicable section 7 225 | additional terms, to the whole of the work, and all its parts, 226 | regardless of how they are packaged. This License gives no 227 | permission to license the work in any other way, but it does not 228 | invalidate such permission if you have separately received it. 229 | 230 | d) If the work has interactive user interfaces, each must display 231 | Appropriate Legal Notices; however, if the Program has interactive 232 | interfaces that do not display Appropriate Legal Notices, your 233 | work need not make them do so. 234 | 235 | A compilation of a covered work with other separate and independent 236 | works, which are not by their nature extensions of the covered work, 237 | and which are not combined with it such as to form a larger program, 238 | in or on a volume of a storage or distribution medium, is called an 239 | "aggregate" if the compilation and its resulting copyright are not 240 | used to limit the access or legal rights of the compilation's users 241 | beyond what the individual works permit. Inclusion of a covered work 242 | in an aggregate does not cause this License to apply to the other 243 | parts of the aggregate. 244 | 245 | 6. Conveying Non-Source Forms. 246 | 247 | You may convey a covered work in object code form under the terms 248 | of sections 4 and 5, provided that you also convey the 249 | machine-readable Corresponding Source under the terms of this License, 250 | in one of these ways: 251 | 252 | a) Convey the object code in, or embodied in, a physical product 253 | (including a physical distribution medium), accompanied by the 254 | Corresponding Source fixed on a durable physical medium 255 | customarily used for software interchange. 256 | 257 | b) Convey the object code in, or embodied in, a physical product 258 | (including a physical distribution medium), accompanied by a 259 | written offer, valid for at least three years and valid for as 260 | long as you offer spare parts or customer support for that product 261 | model, to give anyone who possesses the object code either (1) a 262 | copy of the Corresponding Source for all the software in the 263 | product that is covered by this License, on a durable physical 264 | medium customarily used for software interchange, for a price no 265 | more than your reasonable cost of physically performing this 266 | conveying of source, or (2) access to copy the 267 | Corresponding Source from a network server at no charge. 268 | 269 | c) Convey individual copies of the object code with a copy of the 270 | written offer to provide the Corresponding Source. This 271 | alternative is allowed only occasionally and noncommercially, and 272 | only if you received the object code with such an offer, in accord 273 | with subsection 6b. 274 | 275 | d) Convey the object code by offering access from a designated 276 | place (gratis or for a charge), and offer equivalent access to the 277 | Corresponding Source in the same way through the same place at no 278 | further charge. You need not require recipients to copy the 279 | Corresponding Source along with the object code. If the place to 280 | copy the object code is a network server, the Corresponding Source 281 | may be on a different server (operated by you or a third party) 282 | that supports equivalent copying facilities, provided you maintain 283 | clear directions next to the object code saying where to find the 284 | Corresponding Source. Regardless of what server hosts the 285 | Corresponding Source, you remain obligated to ensure that it is 286 | available for as long as needed to satisfy these requirements. 287 | 288 | e) Convey the object code using peer-to-peer transmission, provided 289 | you inform other peers where the object code and Corresponding 290 | Source of the work are being offered to the general public at no 291 | charge under subsection 6d. 292 | 293 | A separable portion of the object code, whose source code is excluded 294 | from the Corresponding Source as a System Library, need not be 295 | included in conveying the object code work. 296 | 297 | A "User Product" is either (1) a "consumer product", which means any 298 | tangible personal property which is normally used for personal, family, 299 | or household purposes, or (2) anything designed or sold for incorporation 300 | into a dwelling. In determining whether a product is a consumer product, 301 | doubtful cases shall be resolved in favor of coverage. For a particular 302 | product received by a particular user, "normally used" refers to a 303 | typical or common use of that class of product, regardless of the status 304 | of the particular user or of the way in which the particular user 305 | actually uses, or expects or is expected to use, the product. A product 306 | is a consumer product regardless of whether the product has substantial 307 | commercial, industrial or non-consumer uses, unless such uses represent 308 | the only significant mode of use of the product. 309 | 310 | "Installation Information" for a User Product means any methods, 311 | procedures, authorization keys, or other information required to install 312 | and execute modified versions of a covered work in that User Product from 313 | a modified version of its Corresponding Source. The information must 314 | suffice to ensure that the continued functioning of the modified object 315 | code is in no case prevented or interfered with solely because 316 | modification has been made. 317 | 318 | If you convey an object code work under this section in, or with, or 319 | specifically for use in, a User Product, and the conveying occurs as 320 | part of a transaction in which the right of possession and use of the 321 | User Product is transferred to the recipient in perpetuity or for a 322 | fixed term (regardless of how the transaction is characterized), the 323 | Corresponding Source conveyed under this section must be accompanied 324 | by the Installation Information. But this requirement does not apply 325 | if neither you nor any third party retains the ability to install 326 | modified object code on the User Product (for example, the work has 327 | been installed in ROM). 328 | 329 | The requirement to provide Installation Information does not include a 330 | requirement to continue to provide support service, warranty, or updates 331 | for a work that has been modified or installed by the recipient, or for 332 | the User Product in which it has been modified or installed. Access to a 333 | network may be denied when the modification itself materially and 334 | adversely affects the operation of the network or violates the rules and 335 | protocols for communication across the network. 336 | 337 | Corresponding Source conveyed, and Installation Information provided, 338 | in accord with this section must be in a format that is publicly 339 | documented (and with an implementation available to the public in 340 | source code form), and must require no special password or key for 341 | unpacking, reading or copying. 342 | 343 | 7. Additional Terms. 344 | 345 | "Additional permissions" are terms that supplement the terms of this 346 | License by making exceptions from one or more of its conditions. 347 | Additional permissions that are applicable to the entire Program shall 348 | be treated as though they were included in this License, to the extent 349 | that they are valid under applicable law. If additional permissions 350 | apply only to part of the Program, that part may be used separately 351 | under those permissions, but the entire Program remains governed by 352 | this License without regard to the additional permissions. 353 | 354 | When you convey a copy of a covered work, you may at your option 355 | remove any additional permissions from that copy, or from any part of 356 | it. (Additional permissions may be written to require their own 357 | removal in certain cases when you modify the work.) You may place 358 | additional permissions on material, added by you to a covered work, 359 | for which you have or can give appropriate copyright permission. 360 | 361 | Notwithstanding any other provision of this License, for material you 362 | add to a covered work, you may (if authorized by the copyright holders of 363 | that material) supplement the terms of this License with terms: 364 | 365 | a) Disclaiming warranty or limiting liability differently from the 366 | terms of sections 15 and 16 of this License; or 367 | 368 | b) Requiring preservation of specified reasonable legal notices or 369 | author attributions in that material or in the Appropriate Legal 370 | Notices displayed by works containing it; or 371 | 372 | c) Prohibiting misrepresentation of the origin of that material, or 373 | requiring that modified versions of such material be marked in 374 | reasonable ways as different from the original version; or 375 | 376 | d) Limiting the use for publicity purposes of names of licensors or 377 | authors of the material; or 378 | 379 | e) Declining to grant rights under trademark law for use of some 380 | trade names, trademarks, or service marks; or 381 | 382 | f) Requiring indemnification of licensors and authors of that 383 | material by anyone who conveys the material (or modified versions of 384 | it) with contractual assumptions of liability to the recipient, for 385 | any liability that these contractual assumptions directly impose on 386 | those licensors and authors. 387 | 388 | All other non-permissive additional terms are considered "further 389 | restrictions" within the meaning of section 10. If the Program as you 390 | received it, or any part of it, contains a notice stating that it is 391 | governed by this License along with a term that is a further 392 | restriction, you may remove that term. If a license document contains 393 | a further restriction but permits relicensing or conveying under this 394 | License, you may add to a covered work material governed by the terms 395 | of that license document, provided that the further restriction does 396 | not survive such relicensing or conveying. 397 | 398 | If you add terms to a covered work in accord with this section, you 399 | must place, in the relevant source files, a statement of the 400 | additional terms that apply to those files, or a notice indicating 401 | where to find the applicable terms. 402 | 403 | Additional terms, permissive or non-permissive, may be stated in the 404 | form of a separately written license, or stated as exceptions; 405 | the above requirements apply either way. 406 | 407 | 8. Termination. 408 | 409 | You may not propagate or modify a covered work except as expressly 410 | provided under this License. Any attempt otherwise to propagate or 411 | modify it is void, and will automatically terminate your rights under 412 | this License (including any patent licenses granted under the third 413 | paragraph of section 11). 414 | 415 | However, if you cease all violation of this License, then your 416 | license from a particular copyright holder is reinstated (a) 417 | provisionally, unless and until the copyright holder explicitly and 418 | finally terminates your license, and (b) permanently, if the copyright 419 | holder fails to notify you of the violation by some reasonable means 420 | prior to 60 days after the cessation. 421 | 422 | Moreover, your license from a particular copyright holder is 423 | reinstated permanently if the copyright holder notifies you of the 424 | violation by some reasonable means, this is the first time you have 425 | received notice of violation of this License (for any work) from that 426 | copyright holder, and you cure the violation prior to 30 days after 427 | your receipt of the notice. 428 | 429 | Termination of your rights under this section does not terminate the 430 | licenses of parties who have received copies or rights from you under 431 | this License. If your rights have been terminated and not permanently 432 | reinstated, you do not qualify to receive new licenses for the same 433 | material under section 10. 434 | 435 | 9. Acceptance Not Required for Having Copies. 436 | 437 | You are not required to accept this License in order to receive or 438 | run a copy of the Program. Ancillary propagation of a covered work 439 | occurring solely as a consequence of using peer-to-peer transmission 440 | to receive a copy likewise does not require acceptance. However, 441 | nothing other than this License grants you permission to propagate or 442 | modify any covered work. These actions infringe copyright if you do 443 | not accept this License. Therefore, by modifying or propagating a 444 | covered work, you indicate your acceptance of this License to do so. 445 | 446 | 10. Automatic Licensing of Downstream Recipients. 447 | 448 | Each time you convey a covered work, the recipient automatically 449 | receives a license from the original licensors, to run, modify and 450 | propagate that work, subject to this License. You are not responsible 451 | for enforcing compliance by third parties with this License. 452 | 453 | An "entity transaction" is a transaction transferring control of an 454 | organization, or substantially all assets of one, or subdividing an 455 | organization, or merging organizations. If propagation of a covered 456 | work results from an entity transaction, each party to that 457 | transaction who receives a copy of the work also receives whatever 458 | licenses to the work the party's predecessor in interest had or could 459 | give under the previous paragraph, plus a right to possession of the 460 | Corresponding Source of the work from the predecessor in interest, if 461 | the predecessor has it or can get it with reasonable efforts. 462 | 463 | You may not impose any further restrictions on the exercise of the 464 | rights granted or affirmed under this License. For example, you may 465 | not impose a license fee, royalty, or other charge for exercise of 466 | rights granted under this License, and you may not initiate litigation 467 | (including a cross-claim or counterclaim in a lawsuit) alleging that 468 | any patent claim is infringed by making, using, selling, offering for 469 | sale, or importing the Program or any portion of it. 470 | 471 | 11. Patents. 472 | 473 | A "contributor" is a copyright holder who authorizes use under this 474 | License of the Program or a work on which the Program is based. The 475 | work thus licensed is called the contributor's "contributor version". 476 | 477 | A contributor's "essential patent claims" are all patent claims 478 | owned or controlled by the contributor, whether already acquired or 479 | hereafter acquired, that would be infringed by some manner, permitted 480 | by this License, of making, using, or selling its contributor version, 481 | but do not include claims that would be infringed only as a 482 | consequence of further modification of the contributor version. For 483 | purposes of this definition, "control" includes the right to grant 484 | patent sublicenses in a manner consistent with the requirements of 485 | this License. 486 | 487 | Each contributor grants you a non-exclusive, worldwide, royalty-free 488 | patent license under the contributor's essential patent claims, to 489 | make, use, sell, offer for sale, import and otherwise run, modify and 490 | propagate the contents of its contributor version. 491 | 492 | In the following three paragraphs, a "patent license" is any express 493 | agreement or commitment, however denominated, not to enforce a patent 494 | (such as an express permission to practice a patent or covenant not to 495 | sue for patent infringement). To "grant" such a patent license to a 496 | party means to make such an agreement or commitment not to enforce a 497 | patent against the party. 498 | 499 | If you convey a covered work, knowingly relying on a patent license, 500 | and the Corresponding Source of the work is not available for anyone 501 | to copy, free of charge and under the terms of this License, through a 502 | publicly available network server or other readily accessible means, 503 | then you must either (1) cause the Corresponding Source to be so 504 | available, or (2) arrange to deprive yourself of the benefit of the 505 | patent license for this particular work, or (3) arrange, in a manner 506 | consistent with the requirements of this License, to extend the patent 507 | license to downstream recipients. "Knowingly relying" means you have 508 | actual knowledge that, but for the patent license, your conveying the 509 | covered work in a country, or your recipient's use of the covered work 510 | in a country, would infringe one or more identifiable patents in that 511 | country that you have reason to believe are valid. 512 | 513 | If, pursuant to or in connection with a single transaction or 514 | arrangement, you convey, or propagate by procuring conveyance of, a 515 | covered work, and grant a patent license to some of the parties 516 | receiving the covered work authorizing them to use, propagate, modify 517 | or convey a specific copy of the covered work, then the patent license 518 | you grant is automatically extended to all recipients of the covered 519 | work and works based on it. 520 | 521 | A patent license is "discriminatory" if it does not include within 522 | the scope of its coverage, prohibits the exercise of, or is 523 | conditioned on the non-exercise of one or more of the rights that are 524 | specifically granted under this License. You may not convey a covered 525 | work if you are a party to an arrangement with a third party that is 526 | in the business of distributing software, under which you make payment 527 | to the third party based on the extent of your activity of conveying 528 | the work, and under which the third party grants, to any of the 529 | parties who would receive the covered work from you, a discriminatory 530 | patent license (a) in connection with copies of the covered work 531 | conveyed by you (or copies made from those copies), or (b) primarily 532 | for and in connection with specific products or compilations that 533 | contain the covered work, unless you entered into that arrangement, 534 | or that patent license was granted, prior to 28 March 2007. 535 | 536 | Nothing in this License shall be construed as excluding or limiting 537 | any implied license or other defenses to infringement that may 538 | otherwise be available to you under applicable patent law. 539 | 540 | 12. No Surrender of Others' Freedom. 541 | 542 | If conditions are imposed on you (whether by court order, agreement or 543 | otherwise) that contradict the conditions of this License, they do not 544 | excuse you from the conditions of this License. If you cannot convey a 545 | covered work so as to satisfy simultaneously your obligations under this 546 | License and any other pertinent obligations, then as a consequence you may 547 | not convey it at all. For example, if you agree to terms that obligate you 548 | to collect a royalty for further conveying from those to whom you convey 549 | the Program, the only way you could satisfy both those terms and this 550 | License would be to refrain entirely from conveying the Program. 551 | 552 | 13. Use with the GNU Affero General Public License. 553 | 554 | Notwithstanding any other provision of this License, you have 555 | permission to link or combine any covered work with a work licensed 556 | under version 3 of the GNU Affero General Public License into a single 557 | combined work, and to convey the resulting work. The terms of this 558 | License will continue to apply to the part which is the covered work, 559 | but the special requirements of the GNU Affero General Public License, 560 | section 13, concerning interaction through a network will apply to the 561 | combination as such. 562 | 563 | 14. Revised Versions of this License. 564 | 565 | The Free Software Foundation may publish revised and/or new versions of 566 | the GNU General Public License from time to time. Such new versions will 567 | be similar in spirit to the present version, but may differ in detail to 568 | address new problems or concerns. 569 | 570 | Each version is given a distinguishing version number. If the 571 | Program specifies that a certain numbered version of the GNU General 572 | Public License "or any later version" applies to it, you have the 573 | option of following the terms and conditions either of that numbered 574 | version or of any later version published by the Free Software 575 | Foundation. If the Program does not specify a version number of the 576 | GNU General Public License, you may choose any version ever published 577 | by the Free Software Foundation. 578 | 579 | If the Program specifies that a proxy can decide which future 580 | versions of the GNU General Public License can be used, that proxy's 581 | public statement of acceptance of a version permanently authorizes you 582 | to choose that version for the Program. 583 | 584 | Later license versions may give you additional or different 585 | permissions. However, no additional obligations are imposed on any 586 | author or copyright holder as a result of your choosing to follow a 587 | later version. 588 | 589 | 15. Disclaimer of Warranty. 590 | 591 | THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY 592 | APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT 593 | HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY 594 | OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, 595 | THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR 596 | PURPOSE. THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM 597 | IS WITH YOU. SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF 598 | ALL NECESSARY SERVICING, REPAIR OR CORRECTION. 599 | 600 | 16. Limitation of Liability. 601 | 602 | IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING 603 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS 604 | THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY 605 | GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE 606 | USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF 607 | DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD 608 | PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS), 609 | EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF 610 | SUCH DAMAGES. 611 | 612 | 17. Interpretation of Sections 15 and 16. 613 | 614 | If the disclaimer of warranty and limitation of liability provided 615 | above cannot be given local legal effect according to their terms, 616 | reviewing courts shall apply local law that most closely approximates 617 | an absolute waiver of all civil liability in connection with the 618 | Program, unless a warranty or assumption of liability accompanies a 619 | copy of the Program in return for a fee. 620 | 621 | END OF TERMS AND CONDITIONS 622 | 623 | How to Apply These Terms to Your New Programs 624 | 625 | If you develop a new program, and you want it to be of the greatest 626 | possible use to the public, the best way to achieve this is to make it 627 | free software which everyone can redistribute and change under these terms. 628 | 629 | To do so, attach the following notices to the program. It is safest 630 | to attach them to the start of each source file to most effectively 631 | state the exclusion of warranty; and each file should have at least 632 | the "copyright" line and a pointer to where the full notice is found. 633 | 634 | 635 | Copyright (C) 636 | 637 | This program is free software: you can redistribute it and/or modify 638 | it under the terms of the GNU General Public License as published by 639 | the Free Software Foundation, either version 3 of the License, or 640 | (at your option) any later version. 641 | 642 | This program is distributed in the hope that it will be useful, 643 | but WITHOUT ANY WARRANTY; without even the implied warranty of 644 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the 645 | GNU General Public License for more details. 646 | 647 | You should have received a copy of the GNU General Public License 648 | along with this program. If not, see . 649 | 650 | Also add information on how to contact you by electronic and paper mail. 651 | 652 | If the program does terminal interaction, make it output a short 653 | notice like this when it starts in an interactive mode: 654 | 655 | Copyright (C) 656 | This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'. 657 | This is free software, and you are welcome to redistribute it 658 | under certain conditions; type `show c' for details. 659 | 660 | The hypothetical commands `show w' and `show c' should show the appropriate 661 | parts of the General Public License. Of course, your program's commands 662 | might be different; for a GUI interface, you would use an "about box". 663 | 664 | You should also get your employer (if you work as a programmer) or school, 665 | if any, to sign a "copyright disclaimer" for the program, if necessary. 666 | For more information on this, and how to apply and follow the GNU GPL, see 667 | . 668 | 669 | The GNU General Public License does not permit incorporating your program 670 | into proprietary programs. If your program is a subroutine library, you 671 | may consider it more useful to permit linking proprietary applications with 672 | the library. If this is what you want to do, use the GNU Lesser General 673 | Public License instead of this License. But first, please read 674 | . 675 | -------------------------------------------------------------------------------- /Cask: -------------------------------------------------------------------------------- 1 | (package-file "php-extras.el") 2 | 3 | (source marmalade) 4 | -------------------------------------------------------------------------------- /Makefile: -------------------------------------------------------------------------------- 1 | .PHONY: all clean install 2 | 3 | CASK?=cask 4 | EMACS?=emacs 5 | TAR?=COPYFILE_DISABLE=1 bsdtar 6 | PANDOC?=pandoc --atx-headers 7 | 8 | VERSION?=$(shell $(CASK) version) 9 | 10 | ARCHIVE_NAME=php-extras 11 | PACKAGE_NAME=$(ARCHIVE_NAME)-$(VERSION) 12 | 13 | all: $(PACKAGE_NAME).tar 14 | 15 | $(ARCHIVE_NAME).info: README.md 16 | $(PANDOC) -t texinfo $^ | makeinfo -o $@ 17 | 18 | README: README.md 19 | $(PANDOC) -t plain -o $@ $^ 20 | 21 | php-extras-eldoc-functions.el: php-extras-gen-eldoc.el 22 | $(CASK) install 23 | $(CASK) exec $(EMACS) --batch -l php-extras.el -l php-extras-gen-eldoc.el -f php-extras-generate-eldoc-1 24 | 25 | $(ARCHIVE_NAME)-pkg.el: $(ARCHIVE_NAME).el 26 | $(CASK) package 27 | 28 | # create a tar ball in package.el format for uploading to http://marmalade-repo.org 29 | $(PACKAGE_NAME).tar: README $(ARCHIVE_NAME).el $(ARCHIVE_NAME)-pkg.el $(ARCHIVE_NAME).info dir php-extras-eldoc-functions.el php-extras-gen-eldoc.el 30 | $(TAR) -c -s "@^@$(PACKAGE_NAME)/@" -f $(PACKAGE_NAME).tar $^ 31 | 32 | install: $(PACKAGE_NAME).tar 33 | $(EMACS) --batch -l package -f package-initialize --eval "(package-install-file \"$(PWD)/$(PACKAGE_NAME).tar\")" 34 | 35 | clean: 36 | $(RM) $(ARCHIVE_NAME)-*.tar $(ARCHIVE_NAME)-pkg.el README $(ARCHIVE_NAME).info php-extras-eldoc-functions.el 37 | $(RM) -r .cask 38 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # PHP Extras 2 | 3 | A small collection of extra features for Emacs `php-mode`. 4 | 5 | Currently includes: 6 | 7 | * `php-extras-insert-previous-variable` 8 | * `php-extras-eldoc-documentation-function` 9 | * Auto complete source for PHP functions based on 10 | `php-extras-eldoc-documentation-function` 11 | * Company completion back-end for PHP functions based on 12 | `php-extras-eldoc-documentation-function` 13 | 14 | 15 | ## `php-extras-insert-previous-variable` 16 | 17 | When variable names get too long or you have to juggle a lot of nested 18 | arrays it gets cumbersome to repeat the same variables over and over 19 | again while programming. 20 | 21 | In example you have the code below and want to debug what value you 22 | actually parsed to `some_function()`. You have point at `^` and now 23 | all you have to write is repeat the variable... 24 | 25 | ```php 26 | some_function($my_array['some_level'][0]['another_level'][7]); 27 | print_r(^); 28 | ``` 29 | 30 | Enter `php-extras` and you just hit C-c C-$ and it will 31 | insert the previous variable (including array indexes). 32 | 33 | If you prefix the command (i.e. C-u 3 C-c C-$) it will 34 | search back 3 variables and with negative prefix arguments it will 35 | search forward. 36 | 37 | 38 | ## `php-extras-eldoc-documentation-function` 39 | 40 | `eldoc-mode` is a nice minor mode that ships with Emacs. It will 41 | display a function tip in the mini buffer showing the function and its 42 | arguments for the function at point. That is if you provide a function 43 | to look up the function definition. 44 | 45 | `php-extras` provides such a function for looking up all the core PHP 46 | functions. 47 | 48 | The function `php-extras-generate-eldoc` will download the 49 | [PHP function list](http://doc.php.net/downloads/json/php_manual_en.json) 50 | and extract the function definitions (slow) and store them in a hash 51 | table on disk for you. 52 | 53 | If you install `php-extras` as an ELPA package from 54 | [Marmalade](http://marmalade-repo.org/packages/php-extras) the hash 55 | table is already generated for you. 56 | 57 | 58 | ## Auto complete source for PHP functions based 59 | 60 | The PHP functions extracted for 61 | `php-extras-eldoc-documentation-function` is also setup as a source for 62 | [auto-complete](http://cx4a.org/software/auto-complete). 63 | 64 | [auto-complete](http://cx4a.org/software/auto-complete) already comes 65 | with a dictionary of PHP functions and will auto complete on them 66 | using the `ac-source-dictionary`. 67 | 68 | The source we provide with `php-extras` will hopefully be more up to 69 | date. 70 | 71 | 72 | ## Company completion back-end for PHP functions based 73 | 74 | Users of [company-mode](http://company-mode.github.io/) will also get 75 | in-buffer completion based on the extracted PHP functions. 76 | 77 | 78 | ## Installation 79 | 80 | The easiest way to install `php-extras` is probably to install it via 81 | the ELPA archive at 82 | [Marmalade](http://marmalade-repo.org/packages/php-extras). 83 | 84 | ELPA (package.el) is part of Emacs 24. For Emacs 23 see 85 | [Marmalade](http://marmalade-repo.org) for installation instructions. 86 | 87 | The version number of the ELPA package will have the date appended 88 | when the package was build and hence the date the documentation got 89 | extracted from [php.net](http://php.net). 90 | 91 | 92 | ### Manual installation 93 | 94 | I really recommend that you install this package via ELPA as 95 | described above. 96 | 97 | If you insist on installing it manually try to follow this recipe: 98 | 99 | * Place the folder with the files somewhere on your disk. 100 | 101 | * Add this to your `.emacs` / `.emacs.d/init.el`: 102 | 103 | ```lisp 104 | (add-to-list 'load-path "/somewhere/on/your/disk/php-extras") 105 | (eval-after-load 'php-mode 106 | (require 'php-extras)) 107 | ``` 108 | 109 | * Either restart your Emacs or evaluate the `add-to-list` expression. 110 | 111 | * Generate the hash table containing the PHP functions: 112 | 113 | M-x load-library RET php-extras-gen-eldoc RET 114 | 115 | M-x php-extras-generate-eldoc RET 116 | 117 | 118 | ## Development of PHP Extras 119 | 120 | PHP Extras is developed at 121 | [GitHub](https://github.com/arnested/php-extras). Feature requests, 122 | ideas, bug reports, and pull request are more than welcome! 123 | -------------------------------------------------------------------------------- /SECURITY.md: -------------------------------------------------------------------------------- 1 | # Security Policy 2 | 3 | ## Supported Versions 4 | 5 | All versions are supported. 6 | 7 | ## Reporting a Vulnerability 8 | 9 | Security issues can be reported to [Arne Jørgensen](https://github.com/arnested) 10 | either by [mail](mailto:arne@arnested.dk) or any other channel you prefer and 11 | trust (see my [Keybase profile](https://keybase.io/arnested)). 12 | -------------------------------------------------------------------------------- /dir: -------------------------------------------------------------------------------- 1 | This is the file .../info/dir, which contains the 2 | topmost node of the Info hierarchy, called (dir)Top. 3 | The first time you invoke Info you start off looking at this node. 4 |  5 | File: dir, Node: Top This is the top of the INFO tree 6 | 7 | This (the Directory node) gives a menu of major topics. 8 | Typing "q" exits, "?" lists all Info commands, "d" returns here, 9 | "h" gives a primer for first-timers, 10 | "mEmacs" visits the Emacs manual, etc. 11 | 12 | In Emacs, you can click mouse button 2 on a menu item or cross reference 13 | to select it. 14 | 15 | * Menu: 16 | 17 | Programming 18 | * PHP Extras: (php-extras). Extra features for `php-mode'. 19 | -------------------------------------------------------------------------------- /php-extras-gen-eldoc.el: -------------------------------------------------------------------------------- 1 | ;;; php-extras-gen-eldoc.el --- Extra features for `php-mode' 2 | 3 | ;; Copyright (C) 2012, 2013, 2014 Arne Jørgensen 4 | 5 | ;; Author: Arne Jørgensen 6 | 7 | ;; This software is free software: you can redistribute it and/or 8 | ;; modify it under the terms of the GNU General Public License as 9 | ;; published by the Free Software Foundation, either version 3 of the 10 | ;; License, or (at your option) any later version. 11 | 12 | ;; This software is distributed in the hope that it will be useful, 13 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 14 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 15 | ;; General Public License for more details. 16 | 17 | ;; You should have received a copy of the GNU General Public License 18 | ;; along with this software. If not, see 19 | ;; . 20 | 21 | ;;; Commentary: 22 | 23 | ;; Download and parse PHP manual from php.net and build a new 24 | ;; `php-extras-function-arguments' hash table of PHP functions and 25 | ;; their arguments. 26 | 27 | ;; Please note that build a new `php-extras-function-arguments' is a 28 | ;; slow process and might be error prone. 29 | 30 | ;;; Code: 31 | 32 | (require 'php-mode) 33 | (require 'php-extras) 34 | (require 'json) 35 | (require 'shr) 36 | 37 | 38 | 39 | (defvar php-extras-php-doc-url 40 | "http://doc.php.net/downloads/json/php_manual_en.json" 41 | "URL of the JSON list of PHP functions.") 42 | 43 | 44 | 45 | ;;;###autoload 46 | (defun php-extras-generate-eldoc () 47 | "Regenerate PHP function argument hash table from php.net. This is slow!" 48 | (interactive) 49 | (when (yes-or-no-p "Regenerate PHP function argument hash table from php.net? This is slow! ") 50 | (php-extras-generate-eldoc-1 t))) 51 | 52 | (defun php-extras-generate-eldoc-1 (&optional byte-compile) 53 | (with-current-buffer (url-retrieve-synchronously php-extras-php-doc-url) 54 | (search-forward-regexp "^$") 55 | (let* ((data (json-read)) 56 | (count 0) 57 | (progress 0) 58 | (length (length data)) 59 | (function-arguments-temp (make-hash-table 60 | :size length 61 | :rehash-threshold 1.0 62 | :rehash-size 100 63 | :test 'equal)) 64 | doc) 65 | (dolist (elem data) 66 | (setq count (+ count 1)) 67 | ;; Skip methods for now: is there anything more intelligent we 68 | ;; could do with them? 69 | (unless (string-match-p "::" (symbol-name (car elem))) 70 | (setq progress (* 100 (/ (float count) length))) 71 | (message "[%2d%%] Adding function: %s..." progress (car elem)) 72 | (setq doc (concat 73 | (cdr (assoc 'purpose (cdr elem))) 74 | "\n\n" 75 | (cdr (assoc 'prototype (cdr elem))) 76 | "\n\n" 77 | ;; The return element is HTML - use `shr' to 78 | ;; render it back to plain text. 79 | (save-window-excursion 80 | (with-temp-buffer 81 | (insert (cdr (assoc 'return (cdr elem)))) 82 | (shr-render-buffer (current-buffer)) 83 | (delete-trailing-whitespace) 84 | (buffer-string))) 85 | "\n\n" 86 | "(" (cdr (assoc 'versions (cdr elem))) ")")) 87 | (puthash (symbol-name (car elem)) (cons `(documentation . ,doc) (cdr elem)) function-arguments-temp))) 88 | ;; PHP control structures are not present in JSON list. We add 89 | ;; them here (hard coded - there are not so many of them). 90 | (let ((php-control-structures '("if" "else" "elseif" "while" "do.while" "for" "foreach" "break" "continue" "switch" "declare" "return" "require" "include" "require_once" "include_once" "goto"))) 91 | (dolist (php-control-structure php-control-structures) 92 | (message "Adding control structure: %s..." php-control-structure) 93 | (puthash php-control-structure 94 | '((purpose . "Control structure") 95 | (id . (concat "control-structures." php-control-structure))) 96 | function-arguments-temp))) 97 | (let* ((file (concat php-extras-eldoc-functions-file ".el")) 98 | (base-name (file-name-nondirectory php-extras-eldoc-functions-file))) 99 | (with-temp-file file 100 | (insert (format 101 | ";;; %s.el -- file auto generated by `php-extras-generate-eldoc' 102 | 103 | \(require 'php-extras) 104 | 105 | \(setq php-extras-function-arguments %S) 106 | 107 | \(provide 'php-extras-eldoc-functions) 108 | 109 | ;;; %s.el ends here 110 | " 111 | base-name 112 | function-arguments-temp 113 | base-name))) 114 | (when byte-compile 115 | (message "Byte compiling and loading %s ..." file) 116 | (byte-compile-file file t) 117 | (message "Byte compiling and loading %s ... done." file)))))) 118 | 119 | (provide 'php-extras-gen-eldoc) 120 | 121 | ;;; php-extras-gen-eldoc.el ends here 122 | -------------------------------------------------------------------------------- /php-extras.el: -------------------------------------------------------------------------------- 1 | ;;; php-extras.el --- Extra features for `php-mode' 2 | 3 | ;; Copyright (C) 2012, 2013, 2014, 2015 Arne Jørgensen 4 | 5 | ;; Author: Arne Jørgensen 6 | ;; URL: https://github.com/arnested/php-extras 7 | ;; Created: June 28, 2012 8 | ;; Version: 2.2.1 9 | ;; Package-Requires: ((php-mode "1.5.0")) 10 | ;; Keywords: programming, php 11 | 12 | ;; This software is free software: you can redistribute it and/or 13 | ;; modify it under the terms of the GNU General Public License as 14 | ;; published by the Free Software Foundation, either version 3 of the 15 | ;; License, or (at your option) any later version. 16 | 17 | ;; This software is distributed in the hope that it will be useful, 18 | ;; but WITHOUT ANY WARRANTY; without even the implied warranty of 19 | ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 20 | ;; General Public License for more details. 21 | 22 | ;; You should have received a copy of the GNU General Public License 23 | ;; along with this software. If not, see 24 | ;; . 25 | 26 | ;;; Commentary: 27 | 28 | ;; Extra features for `php-mode': 29 | 30 | ;; * `php-extras-insert-previous-variable' 31 | ;; * `php-extras-eldoc-documentation-function' 32 | ;; * Auto complete source for PHP functions based on 33 | ;; `php-extras-eldoc-documentation-function' 34 | 35 | ;;; Code: 36 | 37 | (require 'eldoc) 38 | (require 'thingatpt) 39 | (eval-when-compile (require 'cl-lib)) 40 | 41 | ;; Silence byte-compiler warnings 42 | (declare-function php-get-pattern "php-mode" ()) 43 | (declare-function company-doc-buffer "company" (&optional string)) 44 | (declare-function company-grab-symbol "company" ()) 45 | (declare-function company-begin-backend "company" (backend &optional callback)) 46 | (defvar company-backends) 47 | (defvar ac-sources) 48 | 49 | (defvar php-extras-php-variable-regexp 50 | (format "\\(\\$[a-zA-Z_%s-%s][a-zA-Z0-9_%s-%s]*\\(\\[.*\\]\\)*\\)" 51 | (char-to-string 127) (char-to-string 255) 52 | (char-to-string 127) (char-to-string 255)) 53 | "Regexp for a PHP variable.") 54 | 55 | (defvar php-extras-eldoc-functions-file (concat (file-name-directory (or load-file-name buffer-file-name)) "php-extras-eldoc-functions") 56 | "File holding `php-extras-function-arguments' hash table.") 57 | 58 | (defvar php-extras-function-arguments 'not-loaded 59 | "Hash table of PHP functions and their function arguments. 60 | Generated by `php-extras-gen-eldoc-elem-string'.") 61 | 62 | ;;;###autoload 63 | (defcustom php-extras-insert-previous-variable-key [(control c) (control $)] 64 | "Key sequence for `php-extras-insert-previous-variable'." 65 | :group 'php 66 | :set #'(lambda (symbol value) 67 | ;; Always set the variable `php-extras-insert-previous-variable-key'. 68 | (set-default symbol value) 69 | ;; When `php-mode-map' is already loaded define it in the map. 70 | (when (boundp 'php-mode-map) 71 | ;; First undefine the old key sequence if defined. 72 | (when (eq (lookup-key php-mode-map php-extras-insert-previous-variable-key) 'php-extras-insert-previous-variable) 73 | (define-key php-mode-map php-extras-insert-previous-variable-key 'undefined)) 74 | ;; Then define the new key sequence. 75 | (define-key php-mode-map value 'php-extras-insert-previous-variable))) 76 | :type 'key-sequence) 77 | 78 | ;;;###autoload 79 | (defcustom php-extras-auto-complete-insert-parenthesis t 80 | "Whether auto complete insert should add a pair of parenthesis." 81 | :group 'php 82 | :type 'boolean) 83 | 84 | 85 | 86 | ;;;###autoload 87 | (defun php-extras-insert-previous-variable (arg) 88 | "Insert previously used variable from buffer. 89 | With prefix argument search that number of times backwards for 90 | variable. If prefix argument is negative search forward." 91 | (interactive "P") 92 | (when (null arg) 93 | (setq arg 1)) 94 | (save-excursion 95 | (dotimes (var (abs arg)) 96 | (if (> arg 0) 97 | (re-search-backward php-extras-php-variable-regexp nil t) 98 | (re-search-forward php-extras-php-variable-regexp nil t)))) 99 | (if (match-string-no-properties 1) 100 | (insert (match-string-no-properties 1)) 101 | (message "No variable to insert."))) 102 | 103 | (defun php-extras-get-function-property (symbol property) 104 | "Get property of symbol. 105 | Property can be: 'versions, 'return, 'prototype, 'purpose, or 'id." 106 | (cdr (assoc property (gethash symbol php-extras-function-arguments)))) 107 | 108 | ;;;###autoload 109 | (defun php-extras-eldoc-documentation-function () 110 | "Get function arguments for core PHP function at point." 111 | (when (eq php-extras-function-arguments 'not-loaded) 112 | (php-extras-load-eldoc)) 113 | (when (hash-table-p php-extras-function-arguments) 114 | (or 115 | (php-extras-get-function-property (php-get-pattern) 'prototype) 116 | (save-excursion 117 | (ignore-errors 118 | (backward-up-list) 119 | (php-extras-get-function-property (php-get-pattern) 'prototype)))))) 120 | 121 | ;;;###autoload 122 | (add-hook 'php-mode-hook 'php-extras-eldoc-setup) 123 | 124 | (defun php-extras-eldoc-setup () 125 | (when (memq eldoc-documentation-function '(nil ignore)) 126 | (set (make-local-variable 'eldoc-documentation-function) 127 | #'php-extras-eldoc-documentation-function)) 128 | (eldoc-add-command 'completion-at-point)) 129 | 130 | (defun php-extras-load-eldoc () 131 | (unless 132 | (require 'php-extras-eldoc-functions php-extras-eldoc-functions-file t) 133 | (warn "PHP function descriptions not loaded. Try M-x php-extras-generate-eldoc"))) 134 | 135 | 136 | 137 | (defun php-extras-ac-insert-action () 138 | "Auto-complete insert action for PHP. 139 | If `php-extras-auto-complete-insert-parenthesis' is t insert a 140 | pair of parenthesis after the inserted auto complete selection; 141 | place point in between the parenthesis and show the `eldoc' 142 | documentation for the inserted selection." 143 | (when php-extras-auto-complete-insert-parenthesis 144 | (insert "()") 145 | (backward-char) 146 | (when (and (boundp 'eldoc-documentation-function) 147 | (not (memq eldoc-documentation-function '(nil ignore))) 148 | (fboundp 'eldoc-message)) 149 | (eldoc-message (funcall eldoc-documentation-function))))) 150 | 151 | (defun php-extras-function-documentation (symbol) 152 | "Documentation for PHP function." 153 | (php-extras-get-function-property symbol 'documentation)) 154 | 155 | (defvar ac-source-php-extras 156 | '((candidates . php-extras-autocomplete-candidates) 157 | (candidate-face . php-extras-autocomplete-candidate-face) 158 | (selection-face . php-extras-autocomplete-selection-face) 159 | (document . php-extras-function-documentation) 160 | (action . php-extras-ac-insert-action) 161 | (symbol . "f") 162 | (cache)) 163 | "Auto complete source for PHP functions.") 164 | 165 | (defface php-extras-autocomplete-candidate-face 166 | '((t (:inherit ac-candidate-face))) 167 | "Face for PHP auto complete candidate." 168 | :group 'php) 169 | 170 | (defface php-extras-autocomplete-selection-face 171 | '((t (:inherit ac-selection-face))) 172 | "Face for PHP auto complete selection." 173 | :group 'php) 174 | 175 | (defun php-extras-autocomplete-candidates () 176 | "Generate PHP auto complete candidates. 177 | The candidates are generated from the 178 | `php-extras-function-arguments' hash table." 179 | (let (candidates) 180 | (when (eq php-extras-function-arguments 'not-loaded) 181 | (php-extras-load-eldoc)) 182 | (when (hash-table-p php-extras-function-arguments) 183 | (maphash (lambda (key value) (setq candidates (cons key candidates))) php-extras-function-arguments)) 184 | candidates)) 185 | 186 | ;;;###autoload 187 | (defun php-extras-autocomplete-setup () 188 | (eval-after-load 'auto-complete 189 | '(add-to-list 'ac-sources 'ac-source-php-extras))) 190 | 191 | ;;;###autoload 192 | (add-hook 'php-mode-hook #'php-extras-autocomplete-setup) 193 | 194 | 195 | ;;; Setup basic Emacs completion-at-point to complete on function names 196 | 197 | ;;;###autoload 198 | (defun php-extras-completion-at-point () 199 | (when (eq php-extras-function-arguments 'not-loaded) 200 | (php-extras-load-eldoc)) 201 | (when (hash-table-p php-extras-function-arguments) 202 | (let ((bounds (bounds-of-thing-at-point 'symbol))) 203 | (if bounds 204 | (list (car bounds) (cdr bounds) php-extras-function-arguments 205 | :exclusive 'no) 206 | nil)))) 207 | 208 | ;;;###autoload 209 | (defun php-extras-completion-setup () 210 | (add-hook 'completion-at-point-functions 211 | #'php-extras-completion-at-point 212 | nil t)) 213 | 214 | ;;;###autoload 215 | (add-hook 'php-mode-hook #'php-extras-completion-setup) 216 | 217 | 218 | ;;; Backend for `company-mode' 219 | 220 | ;;;###autoload 221 | (defun php-extras-company (command &optional candidate &rest ignore) 222 | "`company-mode' back-end using `php-extras-function-arguments'." 223 | (interactive (list 'interactive)) 224 | (when (derived-mode-p 'php-mode) 225 | (cl-case command 226 | (interactive 227 | (company-begin-backend 'php-extras-company)) 228 | 229 | (init 230 | (php-extras-load-eldoc) 231 | (unless (hash-table-p php-extras-function-arguments) 232 | ;; Signaling an error here will cause company-mode to remove 233 | ;; this backend from the list, so we need not check that the 234 | ;; hash table exists later 235 | (error "No PHP function information loaded"))) 236 | 237 | (prefix 238 | (company-grab-symbol)) 239 | 240 | (candidates 241 | (all-completions candidate php-extras-function-arguments)) 242 | 243 | (annotation 244 | (let ((prototype (php-extras-get-function-property candidate 'prototype))) 245 | (and prototype 246 | (replace-regexp-in-string "\\`[^(]*" "" prototype)))) 247 | 248 | (meta 249 | (php-extras-get-function-property candidate 'purpose)) 250 | 251 | (doc-buffer 252 | (let ((docs (php-extras-get-function-property candidate 'documentation))) 253 | (when docs 254 | (company-doc-buffer docs)))) 255 | 256 | (post-completion 257 | (php-extras-ac-insert-action))))) 258 | 259 | ;;;###autoload 260 | (defun php-extras-company-setup () 261 | ;; Add `php-extras-company' to `company-backends' only if it's not 262 | ;; already present in the list, to avoid overwriting any user 263 | ;; preference for the order and merging of backends (as configured 264 | ;; via customize, e.g.). Elements of `company-backends' may be 265 | ;; lists of backends to merge together, so this is more complicated 266 | ;; than just (memq ..) 267 | (when (boundp 'company-backends) 268 | (unless 269 | (cl-loop 270 | for backend in company-backends 271 | thereis (or (eq backend 'php-extras-company) 272 | (and (listp backend) 273 | (memq 'php-extras-company backend)))) 274 | (add-to-list 'company-backends 'php-extras-company)))) 275 | 276 | ;;;###autoload 277 | (eval-after-load 'company 278 | '(php-extras-company-setup)) 279 | 280 | 281 | 282 | ;;;###autoload 283 | (eval-after-load 'php-mode 284 | `(let ((map php-mode-map) 285 | (key php-extras-insert-previous-variable-key)) 286 | (define-key map key 'php-extras-insert-previous-variable))) 287 | 288 | 289 | 290 | (provide 'php-extras) 291 | 292 | ;;; php-extras.el ends here 293 | --------------------------------------------------------------------------------