Hwarf Nugen

Configure PhpStorm to Auto-complete CakePHP Models, Views, and Controllers

Joshua Glemza — Thu, 25 Aug 2011 02:47:10 +0000

After playing around a bit today I finally figured out how to get PhpStorm to auto-complete methods for models and controllers. Here’s what you need to do.

Removing Multiple Definitions

First, let’s tackle the multiple definitions problem that we see below.

There are multiple places defining AppController. We need to remove the ones that are included in the following locations from our ‘Directories’ in the project’s settings.

The two locations are:

$CAKEHOME/cake/console
$CAKEHOME/cake/tests

Next we need to mark the following file as plain text.

$CAKEHOME/cake/libs/controllers/app_controller.php

You should now see that PhpStorm is no longer complaining about multiple definitions. If it is you may want to check your plugins/components to see if they’re mucking it up. If they are, just mark the file with the definition as plain text.

Auto-completion should now work for the controller. However, it’s still not working correctly on our model.

Adding the Model

To fix the model we need to add a magic property to the class.

/**
*@property ModelName $ModelName
*/

Here’s an example from the controller we’ve been working in.

We can now auto-complete on our models in the controller.

Defining Model Relationships

Lastly, we need to add magic properties to our models to define its relationships with other models. Basically, for each “belongs to” relationship defined in the model’s file you need to add the magic property comment.

We can now auto-complete these relationships.

Setting Up Helper Auto-completion in Views

To get auto-completion working in views we need to include a file created by junichi11 over at GitHub.

Download this file and save it in a directory somewhere outside of your current project. I did this so I could use the same file on multiple projects.

CakePHP Helper Code Completion

Now add that directory to your current project.

Open a view file and add the following variable definition.

/**
*@var $this View
*/

You should now be able to auto-complete helpers in your view!

Core Component Auto-Completion

Add the following to your app_controller.php file and this will add component auto-completion.

/**
* CakePHP Component & Model Code Completion
* @author junichi11
*
* ==============================================
* CakePHP Core Components
* ==============================================
* @property AuthComponent $Auth
* @property AclComponent $Acl
* @property CookieComponent $Cookie
* @property EmailComponent $Email
* @property RequestHandlerComponent $RequestHandler
* @property SecurityComponent $Security
* @property SessionComponent $Session
*/

SABnzbd URL Bookmarklet (NZBMatrix)

Joshua Glemza — Thu, 22 Apr 2010 01:45:01 +0000

Here’s a simple bookmarklet that will take the URL of the current page you’re on and tell SABnzbd to download it. It works great if you’re using NZBMatrix and on the page for the post you’re wanting to download. Perfect for your mobile browser.

javascript:location.href='http://yourhost:8080/api?mode=addurl&name='+encodeURIComponent(location.href)+'&apikey=yourapikey';

Be sure to insert your SABnzbd API key and hostname (or IP address) into the bookmarklet’s code.

Perl Find and Replace One Liner

Joshua Glemza — Thu, 21 Jan 2010 01:37:18 +0000

I’m constantly needing a way to easily change a line in a bunch of configuration files. I thought I’d share the way I do it here.

perl -p -i -e 's/oldstring/newstring/g' *

This allows you to use a regular expression and perform the find and replace.

Lake Michigan Motorcycle Trip Pictures

Joshua Glemza — Fri, 07 Aug 2009 02:21:58 +0000

Here’s the few shots that were taken while Dad and I were out touring Lake Michigan.

[flickr-gallery mode="photoset" photoset="72157622634235926"]

Cleveland Metroparks Zoo – PACE Summer Picnic

Joshua Glemza — Sun, 19 Jul 2009 01:16:28 +0000

[flickr-gallery mode="photoset" photoset="72157622509806403"]

BlackBerry WordPress

Joshua Glemza — Fri, 17 Jul 2009 02:34:48 +0000

This was posted via the new WordPress Blackberry application. Be sure to check it out. WordPress.org

HOWTO: Set the SSHD Idle Timeout

Joshua Glemza — Wed, 24 Jun 2009 14:03:37 +0000

Here’s something that I usually forget to change from the default and then get annoyed when my terminal hangs.

As root open your sshd_config file in an editor.
su -
vim /etc/ssh/sshd_config
Add the following lines.
ClientAliveInterval 600
ClientAliveCountMax 3
Restart the sshd process.
service sshd restart

That’s it. That will keep you logged in for 30 minutes at a time without activity. (600 seconds x 3)

Motorcycle Trip 2009 – Lake Michigan

Joshua Glemza — Mon, 15 Jun 2009 23:55:07 +0000

Below is the initial route for Dad and I’s motorcycle trip for 2009. We’re going to be traveling July 25th – July 30th. The only set in stone destination is Oshkosh, WI for Airventure.

View Larger Map

M3U Playlist Copy Script

Joshua Glemza — Sat, 04 Apr 2009 19:58:00 +0000

A couple of months ago I picked up a Garmin Nuvi 760 on the cheap. As it turns out this great GPS unit can also play music quite well, especially for riding on the motorcycle. The only problem was there was no good way to get playlists on the device that I could find. Enter the following bash script. This script will read an m3u file, copy all associated mp3 files, and generate a new m3u file. Now all I have to do is specifiy m3u files that I exported from Mozilla Songbird and the path to the Garmin’s SD card.

#!/bin/bash
# April 4, 2009
# m3u_cp.sh
#
# Take an m3u file and copy all associated mp3 files
# to a destination directory and generate a new m3u.
#
# Used to copy m3u playlists from computer to Garmin.

if [ $# -lt 2 ]; then
echo "Usage: m3u_cp.sh some.m3u /dst"
exit 0
fi

# Read the m3u file into an array
declare -a M3U
exec 10<"$1"
let count=0

while read LINE <&10; do
M3U[$count]=$LINE
((count++))
done

exec 10>&-

# Determine the m3u's filename
if [[ $1 =~ [^/]*m3u ]]; then
m3u_path="$2/$BASH_REMATCH"
fi

# If playlist arleady exists, delete it
if [ -f "$m3u_path" ]; then
rm -f "$m3u_path"
fi

# Loop through the m3u lines
i=0
while [ $i -lt ${#M3U[@]} ]; do
# The current line is a comment, do nothing with it
if [ ${M3U[$i]:0:1} = "#" ]; then
echo ${M3U[$i]} >> "$m3u_path"

#Current line is a path to an mp3 file
else
# Get the current songs filename
if [[ ${M3U[$i]} =~ [^/]*mp3 ]]; then
song=$BASH_REMATCH
mpath=$( echo ${M3U[$i]} | tr -d '\r' )

# if the song doesn't exist, copy it to the desitnation folder
if [ -f "$2/$song" ]; then
echo File Exists -- $song
else
echo Copying -- $song
cp "$mpath" "$2/$song"
fi

# Write the song in the m3u file
echo $song >> "$m3u_path"
else
echo "The regex for finding the song's filename is fraked up."
fi
fi

let i=i+1
done
exit 0

In the middle of writing this I really started wondering why I used bash. Perl would’ve been a lot easier.

SVN+SSH Howto: Subversion Quick and Simple

Joshua Glemza — Wed, 11 Mar 2009 13:57:36 +0000

Here’s a quick and simple way to create a Subversion repository while maintaining security by using SSH and the filesystem permissions.

Create users and add them to a group. There are a bunch of different ways to do this. I am only showing you how to create a group.
groupadd svn-users
Make a directory to house the repository.
mkdir /var/lib/project
Create the repository.
svnadmin create /var/lib/project
Change permissions to allow the group read/write access.
cd /var/lib/project
chgrp svn-users db db/transactions db/write-lock db/revs db/revprops hooks locks
chmod 2770 db db/transactions db/revs db/revprops
chmod 660 db/write-lock
chmod 750 hooks
chmod 770 locks

You can now have your users access the repository over SSH.

svn+ssh://username@server.example.com/var/lib/project

If your clients are on Windows, I recommend using TortoiseSVN.

Credit goes to the Carnival of Technology.