History: PhpStorm
Comparing version 2 with version 214
|
|||
| Lines: 1-31 | Lines: 1-546 | ||
| - | + | [http://www.jetbrains.com/phpstorm/|PhpStorm] is JetBrains' integrated development environment for PHP, based on IntelliJ IDEA. As of 2019, PhpStorm may be the best commercial PHP IDE. JetBrains offers PhpStorm for free for Tiki development. | |
| - | + | {maketoc} | |
| - | + | !# Comparison with alternatives !!#features featuresIn no particular order (yet) by {sign user="jonnybradley" datetime="2013-04-15T15:54:54+00:00 } # Navigate -> File... (and Class... and Symbol. .) ## Especially the way you can type the initials of the words in the filename %%% e.g. "t a t o o" gets you tiki-admin_toolbars (the PHP, tpl and js files you want) ## Also, if you specify the line number it takes you straight to it, as in -+tiki-jquery.js:288+- or even more amazingly -+tiki-jquery.js line 288+- # Edit -> Copy Reference %%% Except for the way it includes the leading slash... must look a pref for that! # {img fileId=2209 max="300"} %%% makes me smile, but seriously, the debugger knows what's going on to a far deeper level than any PHP IDE I've tried # Code -> Refactor as... (variable, method etc) %%% Common on Java IDE but not seen it on PHP # Code -> Comment/Un-comment %%% Sounds trivial but it's the first thing I've found that does it correctly in all languages, not just PHP and JS, but Smarty, HTML, and CSS too. Chealer 2018-02-07: [https://youtrack.jetbrains.com/issue/ -40620|Not reliable for me] # View -> Compare with the clipboard (you can changes from the clipboard into an open file) # Advanced debugging (breakpoint activation when another breakpoint is , expression evaluation hover, ) # CSS colour indicators # Column select # Tools -> Deployments -> Sync and Diff with Deployment # Code completion on SQL files (fills in and column names from your database - thanks Luci ;) # Branch merging - as you would expect, far more civilized (and quick) than any other IDE I've tried, and so much more controllable (for me) than using a shell # Shelve changes which reverts your current changes keeps them in a safe(ish) place until you want them back again # : "Show History for Selection" (rather than annotating a full file) # Live templates create your own idiosyncratic code snippets and insert them by typing an abbreviated name followed by TAB You can get a free version for on your Tiki work (see details below) !!# Disadvantages compared to Eclipse PDT # The SFTP plugin (''Remote Host'') is in development. Specifically, as of version .1 (PhpStorm 7.1.5), at least on Windows, direct drag-and-drop from/to Explorer is not supported, unlike Eclipse's Remote System Explorer. Remote files cannot be downloaded. # The history of commit messages cannot be shared between projects (for example, when backporting a change). | |
| - | + | !# Issues #"Find Usages" does not necessarily provide an exhaustive list. For example ## A method will not show its usages through objects whose type PhpStorm fails to . ## A method will not show its usages from Smarty templates if the object on which the method is called is assigned PHP. ## [https://youtrack.jetbrains.com/issue/WI-38235|Calls to methods through callbacks specified with a simple string ignored]. ## Using "Find Usages" on a global variable in a function will only find usages in that function (see [https://youtrack.jetbrains.com/issue/WI-18065|WI 18065]). # [https://youtrack.jetbrains.com/issue/IDEA-173887|"Find in Path" forgets the when switching between projects] # Find in Path can be unwarrantedly sluggish (see [https://youtrack.jetbrains.com/issue/IDEA- |IDEA-157017]) #Tiki's default Smarty cache behavior is to compile only if a template file's timestamp is newer than the timestamp recorded on the latest compilation. Using PhpStorm's Revert action from Local history sets the reverted file's timestamp to the time the original version was created, rather than the time the reversion was performed. As of PhpStorm 2017.2.1, there is apparently no setting to control that behavior. This means Local history reverts performed by PhpStorm will not be reflected in Tiki until template cache is cleared, by default. To deal with this, either perform a dummy modification of all reverted files (for example, add a space and then remove it) or set Smarty to recompile always and a performance hit for every request. # PHP's extract() function is problematic. Reads of the variables extracted are reported as errors. Moreover, [https://youtrack.jetbrains.com/issue/WI-1392|the debugger does not show these variables in the Variables zone] due to [https://bugs.xdebug.org/view.php?id= |Xdebug bug #546]. # Similarly, [https://youtrack.jetbrains.com/issue/WI-38342|importing Global variables in function scope using composed variable name/variable variables will fail to add them to the Debug tool window], and accesses will be erroneously displayed as errors. # [https://youtrack.jetbrains.com/issue/WI-34847|The 's console can display bogus error messages]. # [https://youtrack.jetbrains.com/issue/IDEA-135346|In the editor's vertical scrollbar, the thumb's position, and size are broken , which makes it confusing to try navigating issues. # [https://youtrack.jetbrains.com/issue/WI-40620|"Comment with Block " does not behave properly on function with PHPDoc comments] # The inspection for unused variables generates numerous false positives due to several scenarios, notably [https://youtrack.jetbrains.com/issue/WI-6151|file inclusions] and [https://youtrack. .com/issue/WI-3737|variable variables]. # [https://youtrack.jetbrains.com/issue/WI-42052|Move Caret to Code end/start in a PHP file can bring to the wrong location] # With certain layouts (including French Canadian), some keyboard shortcuts have no effect, such as [https://youtrack.jetbrains.com/issue/IDEA-122622|"VCS Operations Pop-up"] and [https://youtrack.jetbrains.com issue/WI-3493|Move to code block end/start]. # Annotating several files (such as tikilib.php on branch 15.x) results in an error being displayed at the top ("Number of lines annotated by Subversion is not equal to the number of lines in the file. Check file encoding and line separators."). With "Display anyway", some of the lines show correct annotations, but some lines lack annotations in some cases. Not clear if missing annotations are due to this or to excessively long histories. Affects Chealer with PhpStorm 2017.3.2 # Controlling indentation can be problematic in Smarty templates, as described in [https: /youtrack.jetbrains.com/issue/WI-37875|this ticket]. # "Merge From..." appears broken with branches in 2017.2.1 if one directly selects the branch (another menu opens prompting to select a file in 17.x, for example). Instead selecting "branches..." and only then 17.x works. # When merging, [https://youtrack. .com/issue/WI-28563|non-conflicting changes are not applied automatically]. # Annotations are very intelligent, blaming the initial commit when the last change is from a merge, but perhaps too confident. The initial commit displayed can apparently be if a merge encompassed several commits on the same file (PhpStorm 2017.3.2). # By default, [https://youtrack.jetbrains.com/issue WI-39629|a tab is quietly closed when opening a new tab with already 10 tabs open]. And many more... | |
| - | !!# |
+ | Wishes # Debug - [https://youtrack.jetbrains.com/issue/WI-7993|Please add Variable/Expression Change Breakpoints # Debug - [https://youtrack.jetbrains.com/issue/WI-39745|Break when back to selected ] # Debug - [https://youtrack.jetbrains.com/issue/WI-46061|Smarty debugging] !# Setting it up {REMARKSBOX(type="warning" title=" progress")} This section incomplete and outdated. { } !!# Installationonly !!!# For Tiki work onlyIf you are a regular contributor to the TikiWiki project, then you may be eligible for a free license to PhpStorm kindly provided by [https://www.jetbrains.com/|JetBrains]. |
| - | + | *Contact [https://tiki.org/JonnyBradley|Jonny] (jonnyb on IRC) and ask him for a new license key. *Once you receive the mail, log in to JetBrains *Download PhpStorm from https://account.jetbrains.com licenses * Start PhpStorm *With PhpStorm 2017, you will get prompted on the first launch and can just enter your JetBrains account credentials. If not, keep reading this ... * > Register * Enter the username and license exactly as in the email {REMARKSBOX(type=warning title="Don't enter the key as single line!")} The license key you will have received, may be on several lines. | |
| - | + | You must enter it exactly like that, without trying to "unwrap" the key into a single line. {REMARKSBOX} | |
| - | + | !!!# Without a free license Get PhpStorm from http://www.jetbrains.com/phpstorm/ | |
| - | Settings |
+ | !!# Tiki Code Style Settings {TABS(name="code_style_config" tabs="Tiki 21 +|phpStorm 2018+|phpStorm 2017-") Your IDE should now detect coding style automatically through the .editorconfig file. |
| - | . | + | [https://sourceforge.net/p/tikiwiki/code/HEAD/tree/trunk/doc/devtools/TikiCodeStyleSettingsPhpStorm.xml|/doc/devtools/TikiCodeStyleSettingsPhpStorm.xml]. Is being kept up to date with .editorconfig by exporting the TikiCodeStyleSettingsPhpStorm.xml into .editorconfig format. Remember to re-add the comment in the top of the .editorconfig after exporting :) |
| - | the |
+ | For how to manually apply settings, see the phpStorm 2018 tab. //// The config file is available inside Tiki here: [https://sourceforge.net/p/tikiwiki/code/HEAD/tree/trunk/doc/devtools/TikiCodeStyleSettingsPhpStorm.xml|/doc/devtools/TikiCodeStyleSettingsPhpStorm.xml] . |
| + | Go to ''File -> Settings... -> Editor -> Code Style'' and in the {icon name="cog"} drop-down menu next to the ''Scheme'' drop down at the top, select ''Import Scheme ''->''Intellij IDEA code style XML''. | ||
| + | ///// | ||
| + | You may download this [tiki-download_wiki_attachment.php?attId=209&page=PhpStorm&download=y|phpStorm 2017 Config File]. For previous versions, get another file from [#attzone|here] instead. | ||
| - | + | Go to ''File -> Settings... -> Editor -> Code Style'' and in the {icon name="cog"} drop-down menu next to the ''Scheme'' drop down at the top, select ''Import Scheme ''->''Intellij IDEA code style XML''. This is the content of the third {TABS} | |
| - | * Name: localhost | ||
| - | * Host: localhost | ||
| + | To use the code style, select the code you want to reformat and navigate to __Code -> Reformat Code__. Any reformatting that can be done automatically to conform to the code style will be applied. | ||
| + | !!# Tiki Code Inspection (phpcs) | ||
| + | The CI will check your work when a commit is made. To have the same code style evaluation made on your code, with an inspection inside PhpStorm, follow the following steps: | ||
| + | {TABS(name="code_style_devmode" tabs="Tiki 22 +|Tiki 21-")} | ||
| + | You have to use the developer package for composer to install all the tools. | ||
| + | {CODE(colors="shell")}./temp/composer.phar install --prefer-dist --working-dir="vendor_bundled"{CODE} | ||
| + | This will install the development packages from Composer. | ||
| + | Then you can run the following console command: | ||
| + | {CODE(colors="shell")}php console.php dev:configure{CODE} | ||
| + | ///// | ||
| + | {CODE(colors="shell")}./temp/composer.phar install --prefer-dist --working-dir="vendor_bundled"{CODE} | ||
| + | This will install the development packages from Composer. | ||
| + | {TABS} | ||
| + | {TABS(name="Preferences_code_style_devmode" tabs="PhpStorm 2022+|PhpStorm 2022-")} | ||
| + | ''Preferences -> PHP -> Quality Tools -> PHP_CodeSniffer -> Configuration -> ... -> PHP Code Sniffer path'' | ||
| + | * Set to "bin/phpcs", | ||
| + | * You may also increase the timeout to 30 seconds. | ||
| + | * Set Code standard to ''Custom'' Path to ruleset'' set to ''phpcs.xml.dist'' (in the tikiroot folder) | ||
| + | Now that we have our Code Sniffer binary referenced we can check it is validated as an inspection. | ||
| + | ''Preferences -> Editor -> Inspections -> PHP -> Quality Tools -> PHPCodeSniffer Validation | ||
| + | ///// | ||
| + | ''Preferences -> Languages & Frameworks -> PHP -> Quality Tools -> Code Sniffer -> ... -> PHP Code Sniffer path'' | ||
| + | set to "vendor_bundled/vendor/squizlabs/php_codesniffer/bin/phpcs". You may also increase the timeout to 30 seconds. | ||
| + | Now that we have our Code Sniffer binary referenced we will set up an inspection. | ||
| + | ''Preferences -> Editor -> Inspections -> Quality Tools -> PHP Code Sniffer -> ... -> Path to ruleset'' set to ''phpcs.xml.dist'' (in the tikiroot folder) | ||
| + | Make sure ''Coding standard'' is set to ''Custom'' | ||
| + | {TABS} | ||
| + | You now have near-realtime code sniffer evaluations set up. In addition to code style, it will warn about incompatible PHP. | ||
| + | To learn more read ((PHP Code Sniffer)). | ||
| + | !!# Debugger (side of the HTTP server) | ||
| + | Choose a PHP debugger, either __Xdebug__ or Zend Debugger, install and configure it on the HTTP server's side. | ||
| + | !!!# Installation | ||
| + | Xdebug is included in XAMPP. | ||
| + | To install Xdebug for PHP 5 on Debian, the following command may be used: | ||
| + | {CODE(colors="bash")} | ||
| + | sudo apt-get install php5-xdebug | ||
| + | {CODE} | ||
| + | To install Xdebug under Mac 10.9 Maverick using MacPorts (couldn't manage to install phpunit) {sign user="Bsfez" datetime="2013-11-20T12:31:20+00:00"}: | ||
| + | {CODE(colors="bash")} | ||
| + | sudo port install php5-xdebug | ||
| + | {CODE} | ||
| + | !!!# Configuration | ||
| + | To configure Xdebug on the HTTP server's side, the following settings could be used as a reference: | ||
| + | {CODE(caption="php.ini" wrap="1" colors="bash")} | ||
| + | [xdebug] | ||
| + | ; Remote settings | ||
| + | xdebug.remote_enable = On | ||
| + | xdebug.remote_cookie_expire_time = 100000 ; 1 day | ||
| + | xdebug.remote_autostart = On | ||
| + | xdebug.idekey = PHPSTORM | ||
| + | xdebug.collect_return = On | ||
| + | xdebug.collect_vars = On | ||
| + | xdebug.show_local_vars = On | ||
| + | xdebug.show_mem_delta = On | ||
| + | xdebug.var_display_max_children = 512 | ||
| + | ;xdebug.collect_params = 2 | ||
| + | {CODE} | ||
| + | !!!# Remote Debugging | ||
| + | Some useful info on setting up xdebug and phpstorm to do remote debugging can be found here: [https://confluence.jetbrains.com/display/PhpStorm/Remote+debugging+in+PhpStorm+via+SSH+tunnel], mainly the part about the ssh port 9000 tunnel - that's the bit that was missing for me {sign user="jonnybradley" datetime="2016-06-15T16:55:22+00:00"} | ||
| + | !!# Configuring the PHP interpreter & path | ||
| + | {REMARKSBOX(type=warning title=Skip)} | ||
| + | This section is outdated. You should probably skip it. 2017-06-26 | ||
| + | {REMARKSBOX} | ||
| + | PhpStorm expects to find the Php interpreter in a particular location (ex: on my mac, it's /usr/bin/php). But it could be that you are using an interpreter that is in a different location. | ||
| + | Here is how you can do that. The particulars of the steps seem to depend on the version of PhpStorm you use. Below are the steps as described originally by Jonny, and those for PhpStorm 6.0 (written by Alain) | ||
| + | !!!# For PhpStorm 6.0 | ||
| + | !!!!# PHP Interpreter | ||
| + | * __Preferences > PHP__ | ||
| + | * Click on __...__ to the right of __Interpreter__. | ||
| + | * Browser to the location of the php interpreter (ex: /opt/local/bin) | ||
| + | * Click on the __+__ sign at the top left, then __Specify other__ | ||
| + | * For __Name__, enter a freetext name for that version of the interpreter (you could just set it to the full path) | ||
| + | * For __PHP home__, enter the path of the directory that contains the php executable (ex: /opt/local/bin). Do not include php at the end of the path (it has to be a directory, not the path to the executable itself). | ||
| + | * __OK__ | ||
| + | !!!!#Include path | ||
| + | * __Preferences > PHP__ | ||
| + | * Choose the interpreter for which you want to set the path, by clicking on the __...__ to the right of __Interpreter__ | ||
| + | * Click on the __+__ sign at the bottom right of the PHP window | ||
| + | * __NOT SURE ABOUT THE REST__ | ||
| + | !!!# Original instructions by Jonny | ||
| + | File → Settings → PHP (open) | ||
| + | !!!!# PHP Interpreter | ||
| + | Interpreter > Add | ||
| + | Enter the following: | ||
| + | Name: "php on ubuntu" (free text) | ||
| + | PHP home: /usr/bin/ | ||
| + | Debugger: Xdebug | ||
| + | → See appear the PHP version (here PHP version 5.3.... ) | ||
| + | !!!!#Include path | ||
| + | * Click at the plus sign | ||
| + | * add the path to application source (the real place without links) | ||
| + | !!# Server | ||
| + | * Server | ||
| + | ** Name: localhost | ||
| + | ** Host: localhost | ||
| + | ** Port: 80 | ||
| + | ** Debugger: Xdebug | ||
| + | ** (X) Use path mappings (select if the server is remote or symlinks are used) | ||
| + | {img type="src" src="http://doc.tiki.org/display711" link="http://doc.tiki.org/display711" height="249" width="627"} | ||
| + | !!# Create project(s) | ||
| + | The code edited needs to be in a PhpStorm project. If you are working on several Tiki versions, it is best to create one project per version. | ||
| + | PhpStorm allows using a single window for all projects or one window per project. Most Tiki developers seem to choose the latter option. | ||
| + | !!# Add a PHP Script to Run/Debug Configurations | ||
| + | Open ''Run'' -> ''Edit configurations...'' | ||
| + | Click on the plus ("+") sign at the top and select "PHP Web Application". | ||
| + | Adjust the ''Name'' and ''Start URL'' fields and select OK. | ||
| + | {img type="src" src="http://doc.tiki.org/display712" link="http://doc.tiki.org/display712" height="306" width="624"} | ||
| + | !!# Set up PHPUnit in Run/Debug Config | ||
| + | PHPUnit allows us to run our code tests. If you haven't already, we need to be in Tiki's Dev Mode for this to work, so see the "Tiki Code Inspection (phpcs)" section if you have not already. | ||
| + | First, phpStorm needs to know where PHPUnit is Click Prefrences->Languages & Frameworks->PHP->Test Frameworks. | ||
| + | Now point "Use Composer autoloader" to vendor_bundled/vendor/autolaod.php. | ||
| + | The "Default configuration file" should point to phpunit.xml.dist | ||
| + | {img fileId="1402" thumb="box"} | ||
| + | Now we need to add PHPUnit to the Run/Debug menu. | ||
| + | Click Run->Edit Configurations...->+ button -> PHPUnit | ||
| + | All you need to do here is name it, and make sure "Defined in the configuration file" is checked off. | ||
| + | {img fileId="1403" thumb="box"} | ||
| + | On the above image, the yellow arrows point to Run, Debug and Generate Code Coverage shortcut buttons. | ||
| + | You may now do the following: | ||
| + | # Run unit tests with Run, Debug and Generate Code Coverage buttons. (yellow arrows in above image) | ||
| + | # Integrates debugging into tests for easy troubleshooting | ||
| + | # Integrates with code coverage and displays the results inside the GUI. Image below. (requires xDebug) | ||
| + | # If your viewing test code, you can know run/debug only that test. Image below. | ||
| + | {img fileId="1405" thumb="box"} {img fileId="1404" thumb="box"} | ||
| + | !!# Configure directories | ||
| + | For Tiki 17 and above, in File -> Settings... -> Directories, mark temp/ as Excluded. | ||
| + | !!# Set default headers | ||
| + | In Settings..., Editor -> File and Code Templates, Includes tab, set PHP File Header to something like: | ||
| + | {CODE(colors="null" theme="default")}// (c) Copyright 2002-2018 by authors of the Tiki Wiki CMS Groupware Project | ||
| + | // | ||
| + | // All Rights Reserved. See copyright.txt for details and a complete list of authors. | ||
| + | // Licensed under the GNU LESSER GENERAL PUBLIC LICENSE. See license.txt for details. | ||
| + | // $Id${CODE} | ||
| + | !!# Create a custom scope | ||
| + | A custom search scope will make Find in Path faster and more relevant. In Settings -> Appearance & Behavior -> Scopes, add a local scope which can be named "Tiki proper". | ||
| + | To exclude vendor directories, you can use a Pattern such as {CODE()}file:*/&&!file:lib/equation/*&&!file:lib/dracula/*&&!file:lib/ical/*&&!file:lib/openlayers/*&&!file:lib/swfobject/*&&!file:vendor_bundled/vendor/*/&&!file:db/tiki-secdb_*.sql{CODE} | ||
| + | language.php files are a major slowdown. To exclude them only keeping - for example - French (fr) files, you could use a pattern like {CODE()}file:*/&&!file:lib/equation/*&&!file:lib/dracula/*&&!file:lib/ical/*&&!file:lib/openlayers/*&&!file:lib/swfobject/*&&!file:vendor_bundled/vendor/*/&&!file:db/tiki-secdb_*.sql&&!file:lang//*||file:lang/fr//*{CODE} | ||
| + | !!#Useful phpStorm Plugins | ||
| + | There are lots of plugins that can make work on Tiki easier, but here are a few of the most useful ones. | ||
| + | !!!![https://plugins.jetbrains.com/plugin/7499-gittoolbox|GitToolBox] | ||
| + | One of the most useful features I use regularly is the inline viewing of git logs. It can help you to see what was changed when it changed and what the reason was. | ||
| + | {img fileId="1398" thumb="box"} | ||
| + | !!!![https://plugins.jetbrains.com/plugin/7622-php-inspections-ea-extended-|Php Inspections (EA Extended)] | ||
| + | It has many useful inspections on code quality. It also offers auto-correct functionality to enhance some code "gotchas" | ||
| + | !!!![https://plugins.jetbrains.com/plugin/7320-php-annotations|PHP Annotations] & [https://plugins.jetbrains.com/plugin/7219-symfony-support|Symfony Support] | ||
| + | Makes filling out DocBlocks easer, with better auto-complete. | ||
| + | !!!![https://plugins.jetbrains.com/plugin/9927-deep-assoc-completion|deep-assoc-completion] | ||
| + | Makes filling out array keys easier with much better auto-complete. | ||
| + | !!!! [https://plugins.jetbrains.com/plugin/7276-php-advanced-autocomplete|PHP Advanced AutoComplete] | ||
| + | Yup, another plugin to make auto-complete more useful. | ||
| + | !!!! [https://plugins.jetbrains.com/plugin/13762-tree-of-usages|Tree of Usages] | ||
| + | This is a neat plugin that shows you where a function is called from. Shows it all nicely laid out in a tree. It can help visualize where functions are being called from. Often better than using a search feature to find function calls. | ||
| + | {img fileId="1400" thumb="box"} | ||
| + | !!# Miscellaneous | ||
| + | You may want to increase the maximum memory (Xmx) setting in ''Help -> Diagnostic -> Change memory settings'' if you have the default 750 MB limit and open several Tiki projects at the same time. | ||
| + | !#Tips | ||
| + | !!# Deploying to a Subversion checkout | ||
| + | Since Remote Host does not support copy-pasting files, uploading changes to a server can be done by copy-pasting the whole contents of modified files. | ||
| + | However, this can change indentation, since PhpStorm reformats on pastes by default. There are [https://intellij-support.jetbrains.com/hc/en-us/community/posts/207280009/comments/207437845|2 ways to avoid this issue]. Furthermore, since PhpStorm considers all pasted lines as modified, it will feel free to remove trailing whitespaces by default when the remote file is saved. To keep the remote file as identical as possible, you need to set the "Strip trailing spaces on Save" setting in Editor -> General, Other section to "None". This has the unfortunate side effect of disabling trailing spaces stripping even in new code you write. To minimize the risk that you unintentionally add trailing whitespaces, you may enable Show whitespaces in Settings... Editor -> General -> Appearance. | ||
| + | !!# Updating a checkout | ||
| + | To update a checkout, do ''VCS'' -> ''Update project...''. | ||
| + | __If__ you have several projects, select the one to update. | ||
| + | !!#Navigation | ||
| + | Turn on __Autoscroll from source__ option, so that the project browser repositions itself automatically to the page you currently have in the editors. That way, if you want to do an operation on the file you are editing (ex: delete, rename), or see other files in the viscinity, you can just go from the editor to the project browser. | ||
| + | To set this option on: | ||
| + | * Click on the project | ||
| + | * Click on the gear icon (top right of the project browser) | ||
| + | * Check __Autoscroll from source__ | ||
| + | Make use of the various navigation and search shortcuts. One really powerful thing about those is that you can search for things by specifying parts of its name, that might not be consecutve. So for example, searching for a file with "tiki permissions" will find "tiki-debug-permissions.tpl". | ||
| + | Below are some of the more useful search and navigation shortcuts: | ||
| + | * Command+Shift+O: search for a file. | ||
| + | * Ctrl+Shift+F: Search all files in the project | ||
| + | * Command+O: Search for a class. | ||
| + | * Ctrl+Alt+Shift+N or Ctrl+Command+O: Search for a symbol (class, method, variable, etc...) | ||
| + | !!# How to merge | ||
| + | Useful tip from [https://sourceforge.net/p/tikiwiki/mailman/message/33501438/|this 2015 mail]: | ||
| + | {QUOTE()} | ||
| + | Seems that the way I do merging of single commits in phpStorm isn't in their documentation, I think I just worked it out several versions ago (don't like manuals mostly | ||
| + | So here's what I do... let's say I want to merge a commit from trunk into 14.x... | ||
| + | The first thing to do is configure the branches in your project (you need that also to do "Compare with branch..." which is really handy too. | ||
| + | https://www.jetbrains.com/phpstorm/help/configure-subversion-branches.html | ||
| + | It should work out where trunk is, and last time I did it added branches, mods, third_party etc as branch locations, you can remove everything apart from branches from there (the lower box). | ||
| + | To do a merge, go back to the Changes panel -> Working Copy info pane where the config branches link was and just under it is "Merge from..." - click that and the little drop down branch menu appears, click "trunk" (in this case) and you get the "Select Merge Variant" dialog, with "Quick Manual Select" button, should be obvious from there (?) | ||
| + | The other two options (merge all, only any use when merging an experimental branch back into trunk, but I've never used it, looked too scary!) and Select with pre-filter, which takes ages and ages on tiki, probably due to our extensive history (and svn being a bit rubbish at this). | ||
| + | Hope that helps, odd that it's not on their documentation (afaics) | ||
| + | jonny | ||
| + | P.S. Compare with branch instructions are here https://www.jetbrains.com/phpstorm/help/comparing-with-branch.html | ||
| + | {QUOTE} | ||
| + | # As of PhpStorm 2017.2, "Merge from..." is now in the "Subversion Working Copies Information" tab of the Version Control tool window. | ||
| + | # "Quick Manual Select" requires you to __check __the revision you want to merge, not just to select it. | ||
| + | !!!# Conflicts | ||
| + | When there are conflicts, [https://youtrack.jetbrains.com/issue/WI-28563|the "Apply All non-conflicting changes" button needs to be used] to reduce the list of changes to apply to those which conflict. | ||
| + | !!# File Watcher Settings to auto-compile SCSS | ||
| + | {TABS(tabs="23+|21.2+ | 21 | 21 -" toggle="y" inside_pretty="n")} | ||
| + | Since Tiki23.x and due to constant improvement of the [https://doc.tiki.org/Console|Tiki Console] previous options became capricious and require constant maintenance. | ||
| + | While it is possible to initiate a php script with arguments from the phpStorm watcher, it is advised to use the [http://doc.tiki.org/Console|Tiki console] that includes a -+ scss +- command to compile your SCSS into CSS. | ||
| + | ///// | ||
| + | {img fileId="1458" thumb="box"} | ||
| + | Since Tiki21.2 (at some point previous options stopped working anymore) you can use the [http://doc.tiki.org/Console|Tiki console] that includes a command to compile your SCSS into CSS from within phpStorm in a convenient way. | ||
| + | # Open the phpStorm settings ("⌘ ," on Mac), look for Tools => File watchers. | ||
| + | # Click on the + sign at the bottom of the window to create a new watcher. | ||
| + | # Give it a name and set it as follows: | ||
| + | *File type: SCSS | ||
| + | *Scope: Project files | ||
| + | *Program: -+/user/www/yourtiki/console.php+- (the full path to the console.php of THIS tiki website) | ||
| + | *Argument: -+scss:compile yourtheme+- (set your theme name else ALL the themes will be compiled) | ||
| + | * __Output path to refresh__: -+$FileParentDir$/css/$FileNameWithoutExtension$.css+- | ||
| + | * __Track only root files__: This should be checked otherwise extraneous css files may be created. A separate css file is not needed for less files that are imported into another less file. Checking this box ensures that only the ultimate less file generates a css. | ||
| + | * __Auto-save edited files to trigger the watcher__ : This is unchecked in the screenshot so that regeneration only occurs upon save. If checked, the css will be regenerated as you type in changes. | ||
| + | * __Trigger the watcher regardless of syntax errors__ : This is usually unchecked but sometimes you may use some "exotic" or advanced CSS command (or your code review preferences are outdated) that are seen by phpStorm as error and it forbid the compiler to run. In such case you can enable it (ignoring the error) or investigate to find what is seen as a syntax error (see below : Troubleshooting when File Watcher is throwing an error) and improve or let it that way. | ||
| + | * __Show console and Output filters__ : The settings for these two options in the screenshot are simply the default settings in PhpStorm. They can be changed according to your preference, they will not affect the compilation of the Less files. | ||
| + | # Click "Ok" to save | ||
| + | # Apply and it is done | ||
| + | Your SCSS should be compiled using the console.php command. | ||
| + | (you may have to restart phpStorm) for changes to be applied. | ||
| + | Note: depending your server setting you may need to change console.php permissions. | ||
| + | ~pp~ chmod 755 console.php~/pp~ | ||
| + | |||
| + | ///// | ||
| + | Once you've run the composer command scss program will be available directly. | ||
| + | (In my case MAMP is set to use php from the package itself and the path is not the one state above) {sign user="Bsfez" datetime="2018-06-21T08:57:26+00:00"}. | ||
| + | Below is a screenshot showing the settings to use for the SCSS file watcher with pscss. There may be a better way running the scss compiler that is included with Tiki. | ||
| + | * __Program__ : From within your Tiki use the path to the scss installed in your vendor_bundled folder: vendor_bundled/vendor/scssphp/scssphp/bin/pscss | ||
| + | {img fileId="1241" thumb="box"} | ||
| + | Some comments on the settings as shown in the screenshot above: | ||
| + | * __Arguments__: -+~np~--no-color~/np~ $FileName$+- | ||
| + | * __Output path to refresh__: -+$FileParentDir$/css/$FileNameWithoutExtension$.css+- | ||
| + | * __Track only root files__: This should be checked otherwise extraneous css files may be created. A separate css file is not needed for less files that are imported into another less file. Checking this box ensures that only the ultimate less file generates a css. | ||
| + | * __Auto-save edited files to trigger the watcher__ : This is unchecked in the screenshot so that regeneration only occurs upon save. If checked, the css will be regenerated as you type in changes. | ||
| + | * __Trigger the watcher regardless of syntax errors__ : This is usually unchecked but sometimes you may use some "exotic" or advanced CSS command (or your code review preferences are outdated) that are seen by phpStorm as error and it forbid the compiler to run. In such case you can enable it (ignoring the error) or investigate to find what is seen as a syntax error (see below : Troubleshooting when File Watcher is throwing an error) and improve or let it that way. | ||
| + | * __Show console and Output filters__ : The settings for these two options in the screenshot are simply the default settings in PhpStorm. They can be changed according to your preference, they will not affect the compilation of the Less files. | ||
| + | ///// | ||
| + | Once you've run the composer command scss program will be available directly. | ||
| + | (In my case MAMP is set to use php from the package itself and the path is not the one state above) {sign user="Bsfez" datetime="2018-06-21T08:57:26+00:00"}. | ||
| + | Below is a screenshot showing the settings to use for the SCSS file watcher with pscss. They may be a better way running the scss compiler that is included with Tiki. | ||
| + | * __Program__ : From within your tiki use the path to the scss installed in your vendor_bundled folder: -+/mytiki/vendor_bundled/vendor/leafo/scssphp/bin/pscss+- | ||
| + | {img fileId="1241" thumb="box"} | ||
| + | Some comments on the settings as shown in the above screenshot: | ||
| + | * __Arguments__: -+~np~--no-color~/np~ $FileName$+- | ||
| + | * __Output path to refresh__: -+$FileParentDir$/css/$FileNameWithoutExtension$.css+- | ||
| + | * __Track only root files__: This should be checked otherwise extraneous css files may be created. A separate css file is not needed for less files that are imported into another less file. Checking this box ensures that only the ultimate less file generates a css. | ||
| + | * __Auto-save edited files to trigger the watcher__ : This is unchecked in the screenshot so that regeneration only occurs upon save. If checked, the css will be regenerated as you type in changes. | ||
| + | * __Trigger the watcher regardless of syntax errors__ : This is usually unchecked but sometimes you may use some "exotic" or advanced CSS command (or your code review preferences are outdated) that are seen by phpStorm as error and it forbid the compiler to run. In such case you can enable it (ignoring the error) or investigate to find what is seen as a syntax error (see below : Troubleshooting when File Watcher is throwing an error) and improve or let it that way. | ||
| + | * __Show console and Output filters__ : The settings for these two options in the screenshot are simply the default settings in PhpStorm. They can be changed according to your preference, they will not affect the compilation of the Less files. | ||
| + | {TABS} | ||
| + | !!!# Troubleshooting when File Watcher is throwing an error | ||
| + | There are cases running the SCSS will throw an error (usually 255) and the log doesn’t give much information. | ||
| + | You can run the console.php equivalent command on your shell or terminal to compile your SCSS file from within your Tiki directory. | ||
| + | {CODE(colors="shell")}console.php scss:compile yourthemename{CODE} | ||
| + | ''Note: if you don’t specify a theme, the command will compile all the themes and it is taking much longer'' | ||
| + | Console.php gives usually a better more verbose error message and helps to solve issues so you can continue to use phpStorm file watcher for SCSS. | ||
| + | !#Troubleshooting | ||
| + | !!"Could not save project" error | ||
| + | If you get this error, it probably means that the permissions on your Tiki files are wrong. Typicall, when you run setup.sh, all the files in Tiki end up being owned by _www with _www as the group (unless you specify other choices). But on most platforms (at least on Mac), PhpStorm runs as your own regular user, which is not part of group _www. | ||
| + | Here is how to fix this issue on Mac. Details for other platforms may vary. | ||
| + | {CODE()} | ||
| + | # First, add your username to group _www | ||
| + | sudo dseditgroup -o edit -a yourusername -t user _www | ||
| + | # Next, rerun setup.sh, but this time, specify | ||
| + | # yourusername as the user, but leave _www as | ||
| + | # the group | ||
| + | sudo sh setup.sh | ||
| + | # Then make sure certain directories are writeable | ||
| + | # by the _www group. | ||
| + | sudo chmod -R g+w db dump img/wiki img/wiki_up img/trackers modules/cache templates_c templates styles whelp | ||
| + | {CODE} | ||
| + | !! 'Cannot find PHPUnit in include path' error | ||
| + | When attempting to run project '9.x' on 'LocalApache' server, I see these messages: | ||
| + | {QUOTE()} | ||
| + | Cannot find PHPUnit in include path (.:/usr/share/php:/usr/share/pear) | ||
| + | Unable to attach test reporter to test framework or test framework quit unexpectedly | ||
| + | {QUOTE} | ||
| + | Once phpunit is installed (& phpstorm restarted), the error message dissapears. | ||
| + | !! 'Debug server doesn't exist' error | ||
| + | When attempting to go to "Run > Debug '9.x on LocalApache'", I see this message at the bottom: | ||
| + | {QUOTE()} | ||
| + | Error running 9.x on LocalApache: | ||
| + | Debug server doesn't exist. Check 'Remote' tab in run configuration editor. | ||
| + | {QUOTE} | ||
| + | Ok, after I added "localhost" as Debug Server, and run again "Run > Debug '9.x on LocalApache'", I did get these messages: | ||
| + | {QUOTE(ln="1", colors="shell")} | ||
| + | Testing started at 18:35 ... | ||
| + | Executing tests | ||
| + | Http request failed: HTTP/1.0 500 Internal Server ErrorE_WARNING: require_once(Zend/Cache/Backend/ExtendedInterface.php): failed to open stream: No such file or directory | ||
| + | #0 /var/www/9.x/lib/core/Zend/Cache/Backend/Test.php(27): require_once() | ||
| + | #1 /usr/share/php/PHPUnit/Util/Fileloader.php(95): include_once() | ||
| + | #2 /usr/share/php/PHPUnit/Util/Fileloader.php(79): load() | ||
| + | #3 /var/www/9.x/_intellij_phpunit_launcher.php(527): checkAndLoad() | ||
| + | #4 /var/www/9.x/_intellij_phpunit_launcher.php(821): collectTestsFromFile() | ||
| + | #5 /var/www/9.x/_intellij_phpunit_launcher.php(929): main() | ||
| + | E_COMPILE_ERROR: require_once(): Failed opening required 'Zend/Cache/Backend/ExtendedInterface.php' (include_path='.:/usr/share/php:/usr/share/pear') | ||
| + | #0 /var/www/9.x/lib/core/Zend/Cache/Backend/Test.php(27) | ||
| + | {QUOTE} | ||
| + | !! Can't commit a change | ||
| + | Sometimes, nothing happens when you click on the __Commit__ button. | ||
| + | When that happens, make sure you uncheckall the boxes in the __Subversion__ and __before commit__ section have to be unchecked. | ||
| + | {img type="fileId" fileId="418" width="600" noDrawIcon="n"} | ||
| + | !!'Connection with 'xdebug' was not established' error | ||
| + | You typically get this error when running the debugger __PHP Script__ run configuration. | ||
| + | The error usually means that the PHP interpreter you are using does not have the xdebug extension installed. | ||
| + | To find out which interpreter you are using | ||
| + | * __Preferences > PHP__ | ||
| + | * Click on __...__ to the right of the __Interpreter__ field | ||
| + | * The path of the interpreter is in the __PHP Home__ field. | ||
| + | To see if xdebug is installed for that interpreter: | ||
| + | {CODE()} | ||
| + | pathtoyourinterpreter/php -i | grep xdebug | ||
| + | {CODE} | ||
| + | If the phpinfo doesn't contain any line with xdebug, it means it's not installed. | ||
| + | To install xdebug for use with PhpStorm, see the __Configuring the Debugger__ section above. | ||
| + | !!PhpStorm becomes sluggish | ||
| + | If you notice that PhpStorm occasionally gets in a rut and becomes very slow in responding to your actions, it probably means that you haven't allocated enough heap memory to it. | ||
| + | The way to fix it is to add or change the heap size setting. From the main menu, choose __Help | Edit Custom VM Options__ to create a copy of the -+idea.vmoptions+- file in the user home directory. See [https://www.jetbrains.com/help/idea/increasing-memory-heap.html|PhpStorm's help page] for more information. | ||
| + | For example, here is Alain's __idea.vmoptions__ file: | ||
| + | {CODE()} | ||
| + | -Xms128m | ||
| + | -Xmx2048m | ||
| + | -XX:MaxPermSize=350m | ||
| + | -XX:ReservedCodeCacheSize=96m | ||
| + | -XX:+UseCodeCacheFlushing | ||
| + | -XX:+UseCompressedOops | ||
| + | {CODE} | ||
| + | !!Can't use svn from the command line | ||
| + | Although the graphical svn UI in PhpStorm is pretty good, there may be a time when you want to use the command line SVN. | ||
| + | If you do that, it could be that the command line SVN will complain that the current directory is in the wrong SVN format. | ||
| + | This is usually due to the fact that PhpStorm uses its own version of SVN (which is embedded as a Java library), and that it uses SVN data format that is more recent than the command line SVN you are using. For example, maybe your command line SVN uses the 1.6 format, while the PhpStorm svn uses 1.7. | ||
| + | There are two ways to deal with this | ||
| + | * Upgrade your command line SVN so it can deal with the data format version used by PhpStorm. | ||
| + | * Redo the checkout, but ask PhpStorm to store the data in the format that your command line uses. | ||
| + | As of this writing (Oct 29, 2013), the easiest option for Mac users seems to be to redo the checkout, because macport doesn't seem to have version 1.7 of the command line SVN (which is what PhpStorm uses by default). | ||
| + | !# Useful links | ||
| + | Free video tutorial to help you setting (Xdebug) and customizing PhpStorm: https://laracasts.com/series/how-to-be-awesome-in-phpstorm/ | ||
| + | ((Tiki Unit Testing with PhpStorm)) | ||
History
;){kind=link}
;){kind=link}
- Fatal error updating a wiki page at themes.tiki.org
- Headings now have d-flex justify-content-start classes and this breaks some page styling
- Fatal error when changing banner type or creating a new banner zone
- "SVN update" button doesn't work anymore on existing show instances
- show.tiki.org : SVN update should also do a db update and run Composer
;){kind=link}
;){kind=link}