View post:
Advanced Windows Batch File Scripting

Shared by 小董

這樣的一篇關於windows batch file技巧的文章 近年少見 推!!

First off, this is a single windows .bat file that I have written to do advanced batch scripting the easy way, meaning it’s mostly a series of functions you can call from the script or within other functions for extremely modular code. Before you get all bent out of shape by my choice of words (“easy, modular”), when I say this is advanced I mean for Windows .bat files, one of the worlds worst scripting languages, but it works on all windows versions so it’s ideal for things like autorun, autoplay, custom startups, usb drives, etc.. If you are looking for information on how to use and program windows .bat files to do anything cool, this is the right place! I tried my best to mimic linux shell-scripting, so it’s likely different than other batch files you have seen.

Batch File IDE and Script Source

My favorite tool (and I’ve tried sooo many) for editing most Windows files and especially .bat files is the free and open-source Notepad++. Set that up and you will have a color-syntax-highlighted editor for Batch Scripting that works very very well.

The next thing to do is download the source code, which includes comments and formatting I had to remove for this online article. Then rename from .txt to .bat and open in your IDE/text-editor of choice.

Quick Batch File Example

This is a simple batch file named ping-check.bat that I use when rebooting remote servers. The reboot is issued from an SSH session and causes the server to go down and then come back up. When the server goes down the network goes down too so I fire this script up to continually ping the remote server until it responds, at which point I can ssh back in.

One of the first hacks for batch files is line 1, the PUSHD command cd’s the scripts working environment to the directory of the script itself.

@ECHO OFF && PUSHD "%~dp0" && SETLOCAL
 
CALL  INGCHECK "%~1"
 
nircmd.exe speak text "PING RECEIVED.  HOST BACK ONLINE" 7 60
ENDLOCAL && POPD && GOTO :EOF
   INGCHECK
ECHO CHECKING %~1
ping.exe -n 1 %~1 -w 5000 | FIND /C "Reply from %~1" | FIND "1" >nul 2>&1
IF ERRORLEVEL 1 CALL  INGCHECK "%~1" ELSE EXIT /B

Super-hero like even

Just added this as an after thought, moving the main example further down this page. This is an easier file to understand the scope of. It effectively creates SSH-encrypted SOCK5 tunnels that stay connected and auto-reconnect if the link goes down. I wanted to try and write a pure batch method to do that. I wrote this to run automatically from a USB key so that I could keep my tools with me portably. The thing of this script that is the most revolutionary is the method it uses to create auto-reconnecting SSH-encrypted SOCKS5 tunnels using the windows SYSTEM account to do it all in the background with plink.exe. The hack to run it as a system account is by using the built-in AT command to run interactively, which lets you interactively do whatever you want as the builtin NT AUTHORITY/SYSTEM account. The other part I am proud of with this is how lean I got the code, specifically how lean the function is that creates the at job to run every 5 minutes, while still doing connection-testing, all by parsing the cmd.exe processors builtin in DATE and TIME variables. Do a google search for “windows batch file date and time” and you will appreciate just how lean this sucker is.

Almost forgot, check out the ways to keep a plink.exe (putty.exe for cmd.exe) SOCKS5 tunnel hidden and safe and continuously connected to a remote server in minimal lines od code. This was a fun one to work on! Enjoy (and remember this is just the warm-up example to glance at).

@ECHO OFF && PUSHD "%~dp0" && SETLOCAL && SETLOCAL ENABLEDELAYEDEXPANSION && SETLOCAL ENABLEEXTENSIONS
 
SET _CRYPTDRIVE=%~d0
SET PATH=%_CRYPTDRIVE%PP;%_CRYPTDRIVE%PPbin;%PATH%
SET _PUTTYBIN=%_CRYPTDRIVE%PPPputty.exe
 
SET _PSERVER=solar.power.com
SET _PPORT=22
SET _PSESSION=newclean-tunnel
 
SET _ADMINUSER=admin
SET _RUNUSER=life
 
REM SAY CHECKING PLINK OUT LOUD
CALL :SPEAK "Checking Putty"
ECHO "CHECKING PUTTY"
 
REM
IF NOT EXIST "%_CRYPTDRIVE%" (
  CALL :SPEAK "Crypt Not Mounted"
  AT|FOR /F "tokens=1" %%i IN ('FIND /I "%~f0"') DO AT %%i /delete /yes >nul 2>&1
  pskill.exe -t putty >nul 2>&1
  pskill.exe -t thunderbird >nul 2>&1
  pskill.exe -t ThunderbirdPortable >nul 2>&1
  pskill.exe -t Firefox >nul 2>&1
  pskill.exe -t FirefoxPortable >nul 2>&1
  pskill.exe -t GC >nul 2>&1
  EXIT
)
 
REM CREATE AT JOB TO RUN THIS SCRIPT EVERY 5 MINUTES
CALL :CREATEATJOB
 
pslist putty >nul 2>&1
IF ERRORLEVEL 1 psexec.exe -i 0 -e -d -u %_RUNUSER% %_PUTTYBIN% -load %_PSESSION%
 
REM KILL MULTIPLE PSEXEC's
CALL :KILLDUPES "psexec.exe"
 
REM KILL MULTIPLE CMD.EXE's
CALL :KILLDUPES "cmd.exe"
 
REM REACHABLE SERVER CHECK
CALL  INGCHECK %_PSERVER%
 
REM CHECK FOR INACTIVE PUTTY
CALL  UTTYCHECK
 
REM CHECK PORT IS LISTENING (FOR SOCKISFIED TUNNEL)
CALL  ORTCHECK %_PPORT%
 
REM CALL :SPEAK "OK"
SLEEP 100 && ECHO "OK" && SLEEP 1 && ENDLOCAL && POPD && EXIT
 
REM =======================================================================================
REM =   SPEAK - Speak text
REM =======================================================================================
:SPEAK
nircmd.exe speak text "%~1" 5 60
ECHO "%~1"
EXIT /B
 
REM =======================================================================================
REM =   RESTARTPLINK - Sleeps for %1 number of seconds
REM =======================================================================================
:RESTARTPLINK
CALL :SPEAK "%~1 ReSTARTing Plink"
REM runas /savecred /user:admin "%_PUTTYBIN% -load %_PSESSION%"
psexec.exe -i 0 -e -d -u %_RUNUSER% %_PUTTYBIN% -load %_PSESSION%
EXIT
EXIT /B
 
REM =======================================================================================
REM =   PORTCHECK - Check that Port is being used (for tunnels)
REM =======================================================================================  ORTCHECK
netstat.exe -n -v -a -p TCP | FIND "ESTABLISHED" | FIND ":%~1" >nul 2>&1
IF ERRORLEVEL 1 CALL :RESTARTPLINK "PORT CHECK FAILED"
EXIT /B
 
REM =======================================================================================
REM =   INACTIVEPUTTYCHECK - Check for inactive putty windows
REM =======================================================================================  UTTYCHECK
tasklist.exe /V /NH /FI "WINDOWTITLE eq PuTTY (inactive)" 2>nul|FIND "INFO: " >nul 2>&1
IF ERRORLEVEL 1 taskkill.exe /T /F /FI "WINDOWTITLE eq PuTTY (inactive)" >nul 2>&1
 
:: MAKE SURE ONLY 1 putty is running that is connected to the remote server
netstat.exe -n -a -o -p TCP | FIND ":%_PPORT%" | FIND /C ":%_PPORT%" | FIND "1" >nul 2>&1
IF ERRORLEVEL 1 (
  tasklist.exe /V /FO TABLE /NH /FI "IMAGENAME eq putty.exe" 2>nul | FIND /C "Running" | FIND "1" >nul 2>&1
  IF ERRORLEVEL 1 (
    REM kill all running puttys (owned by system)
    FOR /F "usebackq tokens=2 skip=2" %%p IN (`tasklist.exe /V /FO TABLE /NH /FI "IMAGENAME eq putty.exe"`) DO taskkill.exe /F /PID %%p /T >nul 2>&1
    CALL :RESTARTPLINK "EXTRA PUTTY FOUND"
  )
)
EXIT /B
 
REM =======================================================================================
REM =   PINGCHECK - PING address to make sure it is reachable
REM =======================================================================================  INGCHECK
PING %~1 -n 1 -w 5000 | FIND "TTL=" >nul 2>&1
IF ERRORLEVEL 1 (
  PING google.com -n 1 -w 500 | FIND "TTL=" >nul 2>&1
  IF ERRORLEVEL 1 ( CALL :SPEAK "CHECK INTERNET CONNECTION" && SLEEP 60 )

  PING google.com -n 1 -w 5000 | FIND "TTL=" >nul 2>&1
  IF ERRORLEVEL 1 ( CALL :SPEAK "CHECK INTERNET CONNECTION" && SLEEP 60 )
 
  PING google.com -n 1 -w 5000 | FIND "TTL=" >nul 2>&1
  IF ERRORLEVEL 1 (
    CALL :SPEAK "KILL SOCKS PROGRAMS"
  SLEEP 100
  pskill.exe -t putty >nul 2>&1
  pskill.exe -t thunderbird >nul 2>&1
  pskill.exe -t ThunderbirdPortable >nul 2>&1
  )
)
EXIT /B
 
REM =======================================================================================
REM =   KILLDUPES - kills duplicate processes, except for the one with lowest pid
REM =======================================================================================
:KILLDUPES
REM Check that more than 1 process is running
tasklist.exe /V /NH /FI "IMAGENAME eq %~1" /FI "USERNAME eq SYSTEM" 2>nul | FIND /C "K Running" | FIND "1" >nul 2>&1
IF NOT ERRORLEVEL 1 EXIT /B
 
REM Create Filename in current dir (of this script)
SET _T=&&SET _T=!_T::=-!&&SET _T=%~dp0%!_T:~0,-2!log
 
REM Create the file in the same dir as this script named for date and sorted by PID
tasklist.exe /V /NH /FI "IMAGENAME eq %~1" /FI "USERNAME eq SYSTEM" 2>nul | SORT /+29 > "%_T%"

REM Check that the file was created or exit
IF NOT EXIST "%_T%" ( CALL :SPEAK "FILE CREATION FAILED" && EXIT /B )

REM kill all the processes found except for 1, do not kill the process with the lowest pid number
FOR /F "tokens=2 skip=2" %%p IN (%_T%) DO taskkill.exe /F /PID %%p /T

REM erase the file
REM ERASE /Q "%_T%" >nul 2>&1

REM check that the file was erased
REM IF EXIST "%_T%" ( CALL :SPEAK "ERASE FILE FAILED" && EXIT /B )
 
EXIT /B
 
REM =======================================================================================
REM =   CREATEATJOB - runs job (START this file) every 5 minutes
REM =======================================================================================
:CREATEATJOB
:: delete all putty AT jobs
AT | FIND /C "%~f0" | FIND "1" >nul 2>&1
IF ERRORLEVEL 1 ( AT|FOR /F "tokens=1" %%i IN ('FIND /I "%~f0"') DO AT %%i /delete /yes >nul 2>&1 )
SET /A H=!TIME:~0,2!&& SET M=!TIME:~3,2!
SET Y=%HM%&& SET /A M+=5
IF !M! GEQ 61 ( SET /A H+=1&&SET /A M-=61 )
IF !H! GEQ 24 SET /A H-=24
SET M=0!M!&& SET H=0!H!
:: create AT job
AT %H:~-2M:~-2% /INTERACTIVE %ComSpec% /E:ON /D /Q /C START /B /MIN %ComSpec% /E:ON /D /Q /C "%~f0" >nul
EXIT /B

Advanced Batch File

This is the main batch file example which you can download here. Other than some minor changes this is the actual script I use at work when I logon to my PC. The first thing it does is mount an encrypted TrueCrypt Drive where all of my files and settings are located. It also starts a putty session named “1″ that I configured to start a few encrypted tunnels and socks proxies so that my email Thunderbird and Website IDE Dreamweaver and other network apps can communicate 100% encrypted and my real location becomes hidden (thanks socks!).

I might come back later and add comments if I get any kind of response for this article, and because it’s such a unique and low-traffic topic, I will try to answer any questions added with the comment form.

Starting the Script

The first line is of my own design and is perhaps the coolest hack in the script. I use this 1 line to start pretty much all of my .bat files.

@ECHO OFF&& SETLOCAL&& PUSHD "%~dp0"&& SETLOCAL ENABLEDELAYEDEXPANSION&& SETLOCAL ENABLEEXTENSIONS&& SET V=5&& IF NOT "!V!"=="5" (ECHO DelayedExpansion Failed&& GOTO :EOF)

SCRIPT VARIABLES

These are all local to this script thanks to the SETLOCAL above, so they won’t exist outside the scripts execution environment.

REM ** Various vars for output used by functions
SET P1=^^^>^^^>^^^>
SET P2=++
SET P3=::
SET L1=+==============================================================================================================+
SET L2=+--------------------------------------------------------------------------------------------------------------+
 
REM ** administrator username, unless changed for more security, its Administrator
SET ADMINUSER=admin
 
REM ** runuser is the username you use when running this script
SET RUNUSER=bill
 
REM ** Custom COMSPEC for running cmd.exe
SET _SCOM=%COMSPEC% /E:ON /F:ON /D /Q /T:0C /C
 
REM ** Custom START command
SET _START=START /WAIT /MIN /B %_SCOM%

MAIN PROGRAM EXECUTION

This is where the main code starts, note how small it is thanks to the use of functions (labels/call/goto). Read the comments in this area (start with :: or REM ) to see the extent of this script. The gold is in the functions.

:: Only allow certain users to run this script or die (prevents global STARTup or service running it)
CALL :CHECKUSERVALID %RUNUSER% %ADMINUSER%
 
:: Mount the truecrypt container
CALL :CRYPTMOUNT "L" "%SYSTEMDRIVE%CRYPTLEONARDO" "%SYSTEMDRIVE%CRYPTLEONARDO_KEY"
 
:: Start Mozilla Firefox
CALL :RUNONE "C:Program FilesMozilla Firefoxfirefox.exe"
 
:: Start Thunderbird Portable
CALL :RUNONE "L:PPPputty.exe" "/MIN" -load 1
 
:: Start Thunderbird Portable
CALL :RUNONE "L:PTBThunderbirdPortable.exe" "/MIN"
 
:: Start Adobe Dreamweaver CS4
CALL :RUNONE "C:Program FilesAdobeAdobe Dreamweaver CS4Dreamweaver.exe" "/MIN"
 
:: Start LightScreen Portable
CALL :RUNONE "L:PLPLightscreenPortable.exe" /B /B
 
:: Start Google Chrome Portable ( GREAT to use for pandora/last.fm as its so low mem )
CALL :RUNONE "L:PGCGC.exe" "/NORMAL"
 
:: Start Adobe Photoshop CS4
CALL :RUNONE "%ProgramFiles%AdobeAdobe Photoshop CS4Photoshop.exe" "/MAX"

Exit Script

This is the last line executed in the Main, it forces the script to exit cleanly at this point, otherwise the functions below would all get executed. This is what allows the use of all the functions below. I end all my scripts MAIN with this.

REM ** EXIT Script
CALL :MDYE "EOF" && POPD && ENDLOCAL && GOTO :EOF

SCRIPT FUNCTIONS

Now then, onto the MEAT of the script, all the functions. These functions are designed for global use in other batch files, so that the only modification when you make a new batch is the above variables and main execution.. If you know much about batch files you will realize that creating these functions was a very painful process in some cases.. I freakin hate windows! Anyway, enjoy!

CRYPTMOUNT – mounts a truecrypt container and returns to CALLer. On fail, quit

REM
REM     CALL :CRYPTMOUNT "%LEONARDO%" "%LEONARDO_FILE%" "%LEONARDO_KEY%"
REM     CALL :CRYPTMOUNT "L" "%SYSTEMDRIVE%CRYPTLEONARDO" "%SYSTEMDRIVE%CRYPTLEONARDO_KEY"
REM
REM :: print the settings
REM :: CALL :MP 3 "DRIVE: %DRIVE%"&&CALL :MP 3 " FILE: %FILE%"&&CALL :MP 3 "  KEY: %KEY%"&&CALL :MP 3 "  VOL: %VOL%"

:CRYPTMOUNT
SET DRIVE=%~1&& SET FILE=%~2&& SET KEY=%~3&& SET VOL=!FILE:~0,3!
CALL :MP 1 "Mounting TrueCrypt on %DRIVE% from %FILE%"
 
:: Check for Truecrypt or die
CALL :EXISTORQUIT "%ProgramFiles%TrueCryptTrueCrypt.exe" && CALL :EXISTORQUIT "%FILE%" && CALL :EXISTORQUIT "%KEY%"
 
:: checks that MOUNTVOL works and the drive containing the truecrypt container file is present or dies
MOUNTVOL %VOL% /L 2>NUL | FIND "\?Volume" >NUL 2>&1
IF ERRORLEVEL 1 CALL :MDYE "%VOL% NOT FOUND"
 
REM ** Converts G: to its \?Volume234234 equivalent for greater portability
FOR /F %%i IN ('MOUNTVOL %VOL% /L') DO @SET VOL=%%i
 
:: IF the drive is already mounted then continue, otherwise try to mount
MOUNTVOL %DRIVEDRIVE% ALREADY MOUNTED" && EXIT /B
) ELSE (
  START "Mounting TrueCrypt" /D"%ProgramFiles%TrueCrypt" /MIN /B TrueCrypt.exe /c n /b /q background /h n /k %KEY% /l %DRIVE% /p /v %VOL% && SLEEP 10
)
 
:: try again in case of bad password and accidental keypress
MOUNTVOL %DRIVEProgramFiles%TrueCrypt" /MIN /B TrueCrypt.exe /c n /b /q background /h n /k %KEY% /l %DRIVE% /p /v %VOL% && SLEEP 10)
 
:: IF it still doesnt exist then quit
MOUNTVOL %DRIVEFILE% on %DRIVE%"
 
CALL :MF && ENDLOCAL && EXIT /B
EXIT /B

RUNONE – Starts one instance of executable after verifying it exists and is not already running.

REM     %~1 is location of executatable
REM     %~2 is optional (unless %~3 is used) START parameters
REM     %~3 is optional parameters for executable
REM
REM     CALL :RUNONE "L:PLPLightscreenPortable.exe" "/MAX" "/HIDE"

:RUNONE
SETLOCAL
CALL :MP 1 "Starting %~n1"
 
:: SLEEP FOR NICENESS, LOCAL VARS _P2 and _P3
SLEEP 2 && SETLOCAL
 
SET P=%~1
ECHO %P%|FIND " " >NUL 2>&1
IF NOT ERRORLEVEL 1 ( PUSHD "%~dp1" && SET P=%~nx1 )
 
:: SET _P2 TO DEFAULT TO "/MIN" IF EMPTY
SET _P2=/MIN
IF NOT " %~2" == " " SET _P2=%~2
IF NOT " %~3" == " " SET _P3=%~3
IF NOT " %~4" == " " SET _P4=%~4
 
:: CHECK THAT EXECUTABLE EXISTS
CALL :EXISTORQUIT "%~1"
 
REM ECHO START %_P2% /D"%~dp1" %P% %_P3% %_P4%&& PAUSE&&
:: CHECK FOR EXISTING PROCESSNAME ( %~n1 is file name without ext, %~nx1 is the file name and extension. )
pslist.exe /e %~n1 >NUL 2>&1
IF ERRORLEVEL 1 (START %_P2% /D"%~dp1" %P% %_P3% %_P4% ) ELSE (CALL :MP 2 "%~n1 already running!" )
 
ENDLOCAL && EXIT /B

ADMINRUNONE – Runs %1 with admin rights IF neccessary

:ADMINRUNONE
CALL :MP 3 "Exec %~1 as %ADMINUSER%"
 
:: Check that file exists
CALL :EXISTORQUIT "%~1"
 
:: test for rights to the task scheduler
:: %SYSTEMDRIVE%WINDOWSsystem32cmd.exe /E:ON /D /Q /T:0C /C START /WAIT /MIN /B %SYSTEMDRIVE%WINDOWSsystem32cmd.exe /E:ON /D /Q /T:0C /C %~1
AT >NUL 2>&1
IF ERRORLEVEL 1 (
  RUNAS /noprofile /user:%USERDOMAIN%%ADMINUSER% "%~1"
) ELSE (
  %COMSPEC% /E:ON /D /Q /T:0C /C "%~1"
)
SLEEP 2 && CALL :MF && EXIT /B

CHECKUSERVALID – checks that defined username equals %ADMINUSER% or %RUNUSER%, then returns to CALLer

:CHECKUSERVALID
:: EXIT IF USERNAME IS NOT DEFINED, CATCHES SYSTEM ACCOUNTS TRYING TO RUN WHEN IN GLOBAL STARTUP
IF NOT DEFINED USERNAME EXIT
 
SETLOCAL
SET UP=no
SET _P1= %~1
SET _P2= %~2
IF NOT "%_P1%" == " " ( IF /I "%~1" == "%USERNAME%" SET UP=yes)
IF NOT "%_P1%" == " " ( IF /I "%~1" == "%USERNAME%" SET UP=yes)
IF NOT "%_P1%" == " " ( IF /I "%~1" == "%USERNAME%" SET UP=yes)
IF /I "bill" == "%USERNAME%" SET UP=yes
IF /I "newbill" == "%USERNAME%" SET UP=yes
IF /I "max" == "%USERNAME%" SET UP=yes
IF /I NOT "%UP%" == "yes" EXIT
ENDLOCAL
EXIT /B

SETPROMPT – sets prompt, then returns to CALLer

REM =   user@MACHINE C:DRPEPPERSCRIPTS
REM =   > REG /?

:SETPROMPT
set PROMPT=$_%USERNAME%@%USERDOMAIN%$S$P$_$M$G && EXIT /B

BEEP – beeps once, then returns to CALLer

The character after the echo is the actual BEL char, so unless you have my source file, you will need to copy a literal BEL char here to make it beep.

:BEEP
@ECHO # && EXIT /B

MSETCOLOR – SET colors for screen, then returns to CALLer

REM
REM     0 = Black       8 = Gray
REM     1 = Blue        9 = Light Blue
REM     2 = Green       A = Light Green
REM     3 = Aqua        B = Light Aqua
REM     4 = Red         C = Light Red
REM     5 = Purple      D = Light Purple
REM     6 = Yellow      E = Light Yellow
REM     7 = White       F = Bright White
REM

:MSETCOLOR
COLOR %~1 && EXIT /B

MSETCONSOLE – sets the cols and lines of current screen buffer, then returns to CALLer

:MSETCONSOLE
MODE CON COLS=%~1 LINES=%~2 && EXIT /B

PARAMTEST – tests params, then returns to CALLer

  ARAMTEST
ECHO. && CALL :MP 1 "PARAMTEST CALLED WITH: %*" && ECHO %L1%
SET _P= %~1
IF NOT "%_P%" == " " ( ECHO %%1          = %1 && ECHO %%~f1        = %~f1 && ECHO %%~d1        = %~d1 && ECHO %%~p1        = %~p1
  ECHO %%~n1        = %~n1 && ECHO %%~x1        = %~x1 && ECHO %%~s1        = %~s1 && ECHO %%~dp1       = %~dp1
  ECHO %%~nx1       = %~nx1 && ECHO %%~$PATH:1   = %~$PATH:1 && ECHO %%~dp$PATH:1 = %~dp$PATH:1 && ECHO %L1% )
SET _P= %~2
IF NOT "%_P%" == " " ( ECHO %%2          = %2 && ECHO %%~f2        = %~f2 && ECHO %%~d2        = %~d2 && ECHO %%~p2        = %~p2
  ECHO %%~n2        = %~n2 && ECHO %%~x2        = %~x2 && ECHO %%~s2        = %~s2 && ECHO %%~dp2       = %~dp2
  ECHO %%~nx2       = %~nx2 && ECHO %%~$PATH:2   = %~$PATH:2 && ECHO %%~dp$PATH:2 = %~dp$PATH:2 && ECHO %L1% )
SET _P= %~3
IF NOT "%_P%" == " " ( ECHO %%3          = %3 && ECHO %%~f3        = %~f3 && ECHO %%~d3        = %~d3 && ECHO %%~p3        = %~p3
  ECHO %%~n3        = %~n3 && ECHO %%~x3        = %~x3 && ECHO %%~s3        = %~s3 && ECHO %%~dp3       = %~dp3
  ECHO %%~nx3       = %~nx3 && ECHO %%~$PATH:3   = %~$PATH:3 && ECHO %%~dp$PATH:3 = %~dp$PATH:3 && ECHO %L1% )
SET _P= %~4
IF NOT "%_P%" == " " ( ECHO %%4          = %4 && ECHO %%~f4        = %~f4 && ECHO %%~d4        = %~d4 && ECHO %%~p4        = %~p4
  ECHO %%~n4        = %~n4 && ECHO %%~x4        = %~x4 && ECHO %%~s4        = %~s4 && ECHO %%~dp4       = %~dp4
  ECHO %%~nx4       = %~nx4 && ECHO %%~$PATH:4   = %~$PATH:4 && ECHO %%~dp$PATH:4 = %~dp$PATH:4 && ECHO %L1% )
SET _P= %~5
IF NOT "%_P%" == " " ( ECHO %%5          = %5 && ECHO %%~f5        = %~f5 && ECHO %%~d5        = %~d5 && ECHO %%~p5        = %~p5
  ECHO %%~n5        = %~n5 && ECHO %%~x5        = %~x5 && ECHO %%~s5        = %~s5 && ECHO %%~dp5       = %~dp5
  ECHO %%~nx5       = %~nx5 && ECHO %%~$PATH:5   = %~$PATH:5 && ECHO %%~dp$PATH:5 = %~dp$PATH:5 && ECHO %L1% )
SET _P= %~6
IF NOT "%_P%" == " " ( ECHO %%6          = %6 && ECHO %%~f6        = %~f6 && ECHO %%~d6        = %~d6 && ECHO %%~p6        = %~p6
  ECHO %%~n6        = %~n6 && ECHO %%~x6        = %~x6 && ECHO %%~s6        = %~s6 && ECHO %%~dp6       = %~dp6
  ECHO %%~nx6       = %~nx6 && ECHO %%~$PATH:6   = %~$PATH:6 && ECHO %%~dp$PATH:6 = %~dp$PATH:6 && ECHO %L1% )
SET _P= %~7
IF NOT "%_P%" == " " ( ECHO %%7          = %7 && ECHO %%~f7        = %~f7 && ECHO %%~d7        = %~d7 && ECHO %%~p7        = %~p7
  ECHO %%~n7        = %~n7 && ECHO %%~x7        = %~x7 && ECHO %%~s7        = %~s7 && ECHO %%~dp7       = %~dp7
  ECHO %%~nx7       = %~nx7 && ECHO %%~$PATH:7   = %~$PATH:7 && ECHO %%~dp$PATH:7 = %~dp$PATH:7 && ECHO %L1% )
SLEEP 3
CALL :MF
EXIT /B

PARAMTESTHELP – show params help, then returns to CALLer

  ARAMTESTHELP
ECHO %%~1 Expands %%1 and removes any surrounding quotation marks
ECHO %%~f1 Expands %%1 to a fully qualified path name.
ECHO %%~d1 Expands %%1 to a drive letter.
ECHO %%~p1 Expands %%1 to a path.
ECHO %%~n1 Expands %%1 to a file name.
ECHO %%~x1 Expands %%1 to a file extension.
ECHO %%~s1 Expanded path contains short names only.
ECHO %%~a1 Expands %%1 to file attributes.
ECHO %%~t1 Expands %%1 to date and time of file.
ECHO %%~z1 Expands %%1 to size of file.
ECHO %%~dp1 Expands %%1 to a drive letter and path.
ECHO %%~nx1 Expands %%1 to a file name and extension.
ECHO %%~ftza1 Expands %%1 to a dir-like output line.
ECHO %%~$PATH:1 Searches the dirs in PATH expanding %%1 to fully qualified name of first found. If var name isn't defined or the files not found, expands to empty string.
ECHO %%~dp$PATH:1 Searches the directories listed in the PATH environment variable for %%1 and expands to the drive letter and path of the first one found.
CALL :MF
EXIT /B

EXAMINEFILE – FINDs useful strings in file, then returns to CALLer

:EXAMINEFILE
CALL :MP 1 "Examine File %~1"
CALL :EXISTORQUIT "%~1"
STRINGS "%~1" | FINDSTR /R /C:"A-ZA-Z="
CALL :MF
EXIT /B

ADMINSHELL – sets prompt, then returns to CALLer

:ADMINSHELL
CALL :MP 1 "Creating Admin Shell"
CALL :EXISTORQUIT "%SYSTEMROOT%system32runas.exe"
START %SYSTEMROOT%system32runas.exe /profile /savecred /user:%ADMINUSER% "%COMSPEC% /T:0C /E:ON /F:ON /K cmd.exe /K cd C:CRYPTBIN"
CALL :MF
EXIT /B

EXISTORQUIT – checks %~1 exists, IF it does returns to CALLer, otherwise, quit

:EXISTORQUIT
:: CALL :MP 1 "Checking for %~1"
IF NOT EXIST "%~1" CALL :MDYE "%~1 NOT FOUND"
EXIT /B

RR – IF file %1 EXISTs then :MT “Removing %1″ then :MF, then ( or IF %1 not EXISTs) returns to CALLer

:RR
CALL :MP 1 "Removing %~1"
IF EXIST "%~1" ERASE /q "%~1"
CALL :MF && EXIT /B

LOCKDOWN – locks workstation, then returns to CALLer (pointless)

:LOCKDOWN
RUNDLL32 USER32.DLL,LockWorkStation && EXIT /B

SHUTDOWNIN – initiates shutdown, then returns to CALLer (pointless)

REM shutdown /a aborts

:SHUTDOWNIN
SHUTDOWN -r -t "%~1" && EXIT /B

LISTSERVICES – lists services, then returns to CALLer

:LISTSERVICES
SC query state= all type= all | FOR /F "tokens=2" %%i IN ('FIND /I "SERVICE_NAME"') DO @ECHO %%i
SC query | FOR /F "tokens=2" %%i IN ('FIND /I "SERVICE_NAME"') DO @ECHO %%i
EXIT /B

TASKS – Advanced Tasklisting

:TASKS
SET _P=%~1
SET _PP= %~1
IF "%_PP%" == " " EXIT /B
 
REM SORTABLES
IF /I "%_P%" == "pid" ( tasklist.exe /V /NH | SORT /+29 && EXIT /B )
IF /I "%_P%" == "size" ( tasklist.exe /V /NH | SORT /+59 && EXIT /B )
IF /I "%_P%" == "user" ( tasklist.exe /V /NH | SORT /+89 && EXIT /B )
IF /I "%_P%" == "time" ( tasklist.exe /V /NH | SORT /+138 && EXIT /B )
IF /I "%_P%" == "window" ( tasklist.exe /V /NH | SORT /+152 && EXIT /B )
 
REM FILTERS
IF /I "%_P%" == "image" ( tasklist.exe /V /NH /FI "IMAGENAME eq %~2" && EXIT /B )
IF /I "%_P%" == "username" ( tasklist.exe /V /NH /FI "USERNAME eq %~2" && EXIT /B )
IF /I "%_P%" == "running" ( tasklist.exe /V /NH /FI "STATUS eq Running" && EXIT /B )
IF /I "%_P%" == "status" ( tasklist.exe /V /NH /FI "STATUS eq %~2" && EXIT /B )
CALL :MF
EXIT /B

SPEAK – Speak text

:SPEAK
REM ECHO "%~1"
nircmd.exe speak text "%~1" 5 60 && EXIT /B

MF – SLEEPs for 1 second, then prints out completed message, followed by 2 blank lines, then returns to CALLer

:MF
SLEEP 1 && ECHO  COMPLETED && ECHO. && ECHO. && EXIT /B

MM – prints blank line, L1, changes title of the interpreter window to %~1, prints >>> %~1…, L2, blank line, then returns to CALLer

:MM
SLEEP 1 && ECHO. && ECHO %L1% && title +++ %~1... && ECHO %P1% %~1... && ECHO %L2% && ECHO. && EXIT /B

MT – prints blank line, L1, changes title of the interpreter window to %~1, prints >>> %~1…, L2, blank line, then returns to CALLer

:MT
CALL :MM "%~1" && CALL :SPEAK "%~1" && EXIT /B

MP – Print Output, then returns to CALLer

:MP
IF "%~1" == "1" ECHO %P1% %~2 && EXIT /B
IF "%~1" == "2" ECHO %P2% %~2 && ECHO. && EXIT /B
IF "%~1" == "3" ECHO %P3% %~2 && EXIT /B
EXIT /B

MP3 – ECHO %~1, speak %~1 with nircmd.exe, then returns to CALLer

:MP3
CALL :MP 1 "%~1" && CALL :SPEAK "%~1" && EXIT /B

MDYE – exit script with message %~1, then returns to CALLer

:MDYE
SETLOCAL
SET _M= %~1
IF NOT "%_M%" == " " SET _M=REASON: %~1
CALL :MP 1 "EXITING SCRIPT...  %_M%" && ECHO. && ECHO.
ENDLOCAL && EXIT /B

MKILL – exit cmd processor with message %~1

:MKILL
SETLOCAL
SET _M= %~1
IF NOT "%_M%" == " " SET _M=REASON: %~1
ECHO. && ECHO. && CALL :MP 1 "EXITING CMD WINDOW IN 3 SECONDS...  %_M%" && ECHO. && ECHO. && SLEEP 3
ENDLOCAL && EXIT && EXIT && EXIT

EOF: Thoughts

So what did you think? I have around 20 batch scripts that utilize these and other functions to do all sorts of cool things. One takes a screenshot of my desktop every 10 minutes and saves it for a real-cool archive of my activity. Another lets me edit a boot.ini file with 1 command.. And another runs when I insert a USB drive to automatically mount a truecrypt volume and create SSH tunnels in the background by using Plink, AT, and the runas.exe command.

If you want to program, please use linux… If you need to write a Windows batch file, I hope this helps.

Technorati Tags: .bat, Advanced, batch file, cli, cmd.exe, Notepad, programming, scripting, SSH Tunnels, Windows

© AskApache for AskApache, 2010. |
Permalink |
No comment |
Add to
del.icio.us

Post tags: .bat, Advanced, batch file, cli, cmd.exe, Notepad, programming, scripting, SSH Tunnels, Windows

Advanced Windows Batch File Scripting originally appeared on AskApache.com

The rest is here:
FreeBSD 上使用 wkhtmltopdf 做網頁擷取

Shared by 小董

天阿 育典哥們 你看了也可以瞑目了 阿門~

以往要用程式控制將網頁輸出pdf或擷取網頁,都是件浩大工程.
這次介紹如何在FreeBSD 命令列模式下即可輕易辦到,並且不需龐大的X Windows 圖形系統適合在server上跑.

以下是軟體原文介紹.

wkhtmltopdf

Convert html to pdf using webkit (qtwebkit)

Description

Simple shell utility to convert html to pdf using the webkit rendering engine, and qt.

Introduction

Searching the web, I have found several command line tools that allow you to convert a HTML-document to a PDF-document, however they all seem to use their own, and rather incomplete rendering engine, resulting in poor quality. Recently QT 4.4 was released with a WebKit widget (WebKit is the engine of Apples Safari, which is a fork of the KDE KHtml), and making a good tool became very easy.
此軟體使用WebKit開發完成,除了flash以外其他接可正常顯示！！（包含js）
在安裝前請先確定你的FreeBSD已安裝 linux-base 套件並正常使用,並且將port tree更新.

1.安裝linux-expat

# cd /usr/ports/textproc/linux-f10-expat;make install clean;
===>  License check disabled, port has not defined LICENSE
=> expat-2.0.1-5.i386.rpm doesn't seem to exist in /usr/ports/distfiles/rpm/i386/fedora/10.
=> Attempting to fetch from http://ftp.tw.freebsd.org/pub/FreeBSD/distfiles/rpm/i386/fedora/10/.
expat-2.0.1-5.i386.rpm                        100% of   82 kB  244 kBps
===>  Extracting for linux-f10-expat-2.0.1
=> MD5 Checksum OK for rpm/i386/fedora/10/expat-2.0.1-5.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/expat-2.0.1-5.i386.rpm.
===>   linux-f10-expat-2.0.1 depends on file: /usr/local/bin/rpm2cpio - found
===>  Patching for linux-f10-expat-2.0.1
===>  Configuring for linux-f10-expat-2.0.1
===>  Installing for linux-f10-expat-2.0.1
===>   linux-f10-expat-2.0.1 depends on file: /compat/linux/etc/fedora-release - found
===>   Generating temporary packing list
===>  Checking if textproc/linux-f10-expat already installed
cd /usr/ports/textproc/linux-f10-expat/work && /usr/bin/find * -type d -exec /bin/mkdir -p "/compat/linux/{}" ;
cd /usr/ports/textproc/linux-f10-expat/work && /usr/bin/find * ! -type d | /usr/bin/cpio -pm -R root:wheel /compat/linux
367 blocks
===>   Running linux ldconfig
/compat/linux/sbin/ldconfig -r /compat/linux
===>   Registering installation for linux-f10-expat-2.0.1
===>  Cleaning for linux-f10-expat-2.0.1

2.安裝linux-fontconfig

# cd /usr/ports/x11-fonts/linux-f10-fontconfig; make install clean;
===>  License check disabled, port has not defined LICENSE
=> fontconfig-2.6.0-3.fc10.i386.rpm doesn't seem to exist in /usr/ports/distfiles/rpm/i386/fedora/10.
=> Attempting to fetch from http://ftp.tw.freebsd.org/pub/FreeBSD/distfiles/rpm/i386/fedora/10/.
fontconfig-2.6.0-3.fc10.i386.rpm              100% of  182 kB  241 kBps
===>  Extracting for linux-f10-fontconfig-2.6.0
=> MD5 Checksum OK for rpm/i386/fedora/10/fontconfig-2.6.0-3.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/fontconfig-2.6.0-3.fc10.i386.rpm.
===>   linux-f10-fontconfig-2.6.0 depends on file: /usr/local/bin/rpm2cpio - found
===>  Patching for linux-f10-fontconfig-2.6.0
===>  Configuring for linux-f10-fontconfig-2.6.0
===>  Installing for linux-f10-fontconfig-2.6.0
===>   linux-f10-fontconfig-2.6.0 depends on file: /compat/linux/etc/fedora-release - found
===>   linux-f10-fontconfig-2.6.0 depends on file: /compat/linux/lib/libexpat.so.1 - found
===>   Generating temporary packing list
===>  Checking if x11-fonts/linux-f10-fontconfig already installed
cd /usr/ports/x11-fonts/linux-f10-fontconfig/work && /usr/bin/find * -type d -exec /bin/mkdir -p "/compat/linux/{}" ;
cd /usr/ports/x11-fonts/linux-f10-fontconfig/work && /usr/bin/find * ! -type d | /usr/bin/cpio -pm -R root:wheel /compat/linux
617 blocks
===>   Running linux ldconfig
/compat/linux/sbin/ldconfig -r /compat/linux
===>   Registering installation for linux-f10-fontconfig-2.6.0
===>  Cleaning for linux-f10-fontconfig-2.6.0

3.安裝 linux-xorg-libs

# cd /usr/ports/x11/linux-f10-xorg-libs; make install clean;
===>  Extracting for linux-f10-xorg-libs-7.4_1
=> MD5 Checksum OK for rpm/i386/fedora/10/libICE-1.0.4-4.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libICE-1.0.4-4.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libFS-1.0.1-2.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libFS-1.0.1-2.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libSM-1.1.0-2.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libSM-1.1.0-2.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libX11-1.1.5-4.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libX11-1.1.5-4.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXScrnSaver-1.1.3-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXScrnSaver-1.1.3-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXTrap-1.0.0-6.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXTrap-1.0.0-6.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXau-1.0.4-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXau-1.0.4-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXaw-1.0.4-3.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXaw-1.0.4-3.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXcomposite-0.4.0-5.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXcomposite-0.4.0-5.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXcursor-1.1.9-3.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXcursor-1.1.9-3.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXdamage-1.1.1-4.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXdamage-1.1.1-4.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXdmcp-1.0.2-6.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXdmcp-1.0.2-6.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXevie-1.0.2-4.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXevie-1.0.2-4.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXext-1.0.4-1.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXext-1.0.4-1.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXfixes-4.0.3-4.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXfixes-4.0.3-4.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXfont-1.3.3-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXfont-1.3.3-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXft-2.1.13-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXft-2.1.13-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXi-1.1.3-4.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXi-1.1.3-4.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXinerama-1.0.3-2.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXinerama-1.0.3-2.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXmu-1.0.4-1.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXmu-1.0.4-1.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXp-1.0.0-11.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXp-1.0.0-11.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXpm-3.5.7-4.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXpm-3.5.7-4.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXrandr-1.2.3-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXrandr-1.2.3-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXrender-0.9.4-3.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXrender-0.9.4-3.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXres-1.0.3-5.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXres-1.0.3-5.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXt-1.0.5-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXt-1.0.5-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXtst-1.0.3-3.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXtst-1.0.3-3.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXv-1.0.4-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXv-1.0.4-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXvMC-1.0.4-5.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXvMC-1.0.4-5.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXxf86dga-1.0.2-3.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXxf86dga-1.0.2-3.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXxf86misc-1.0.1-6.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXxf86misc-1.0.1-6.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libXxf86vm-1.0.2-1.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libXxf86vm-1.0.2-1.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libfontenc-1.0.4-6.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libfontenc-1.0.4-6.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libxcb-1.1.91-5.fc10.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libxcb-1.1.91-5.fc10.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/libxkbfile-1.0.4-5.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/libxkbfile-1.0.4-5.fc9.i386.rpm.
=> MD5 Checksum OK for rpm/i386/fedora/10/mesa-libGLw-6.5.1-5.fc9.i386.rpm.
=> SHA256 Checksum OK for rpm/i386/fedora/10/mesa-libGLw-6.5.1-5.fc9.i386.rpm.
===>   linux-f10-xorg-libs-7.4_1 depends on file: /usr/local/bin/rpm2cpio - found
===>  Patching for linux-f10-xorg-libs-7.4_1
===>  Configuring for linux-f10-xorg-libs-7.4_1
===>  Installing for linux-f10-xorg-libs-7.4_1
===>   linux-f10-xorg-libs-7.4_1 depends on file: /compat/linux/etc/fedora-release - found
===>   linux-f10-xorg-libs-7.4_1 depends on file: /compat/linux/lib/libexpat.so.1 - found
===>   linux-f10-xorg-libs-7.4_1 depends on file: /compat/linux/usr/lib/libfontconfig.so.1.3.0 - found
===>   Generating temporary packing list
===>  Checking if x11/linux-f10-xorg-libs already installed
cd /usr/ports/x11/linux-f10-xorg-libs/work && /usr/bin/find * -type d -exec /bin/mkdir -p "/compat/linux/{}" ;
cd /usr/ports/x11/linux-f10-xorg-libs/work && /usr/bin/find * ! -type d | /usr/bin/cpio -pm -R root:wheel /compat/linux
12139 blocks
===>   Running linux ldconfig
/compat/linux/sbin/ldconfig -r /compat/linux
===>   Registering installation for linux-f10-xorg-libs-7.4_1
===> SECURITY REPORT:
      This port has installed the following files which may act as network
      servers and may therefore pose a remote security risk to the system.
/compat/linux/usr/lib/libICE.so.6.3.0
/compat/linux/usr/lib/libXdmcp.so.6.0.0

      If there are vulnerabilities in these programs there may be a security
      risk to the system. FreeBSD makes no guarantee about the security of
      ports included in the Ports Collection. Please type 'make deinstall'
      to deinstall the port if this is a concern.

      For more information, and contact details about the security
      status of this software, see the following webpage:

http://x.org

===>  Cleaning for linux-f10-xorg-libs-7.4_1

4.安裝中文字型cwttf

# wget http://cle.linux.org.tw/fonts/cwttf/cwttf-v1.0.tar.gz
# cp * /usr/local/lib/X11/fonts/TTF
# fc-cache -f -v
/usr/local/lib/X11/fonts: caching, new cache contents: 0 fonts, 12 dirs
/usr/local/lib/X11/fonts/100dpi: caching, new cache contents: 398 fonts, 0 dirs
/usr/local/lib/X11/fonts/75dpi: caching, new cache contents: 398 fonts, 0 dirs
/usr/local/lib/X11/fonts/OTF: caching, new cache contents: 23 fonts, 0 dirs
/usr/local/lib/X11/fonts/TTF: caching, new cache contents: 31 fonts, 0 dirs
/usr/local/lib/X11/fonts/Type1: caching, new cache contents: 29 fonts, 0 dirs
/usr/local/lib/X11/fonts/bitstream-vera: caching, new cache contents: 10 fonts, 0 dirs
/usr/local/lib/X11/fonts/cyrillic: caching, new cache contents: 0 fonts, 0 dirs
/usr/local/lib/X11/fonts/encodings: caching, new cache contents: 0 fonts, 1 dirs
/usr/local/lib/X11/fonts/encodings/large: caching, new cache contents: 0 fonts, 0 dirs
/usr/local/lib/X11/fonts/lfpfonts-fix: caching, new cache contents: 71 fonts, 0 dirs
/usr/local/lib/X11/fonts/local: caching, new cache contents: 2 fonts, 0 dirs
/usr/local/lib/X11/fonts/misc: caching, new cache contents: 59 fonts, 0 dirs
/usr/local/lib/X11/fonts/util: caching, new cache contents: 0 fonts, 0 dirs
/root/.fonts: skipping, no such directory
/var/db/fontconfig: cleaning cache directory
/root/.fontconfig: not cleaning non-existent cache directory
fc-cache: succeeded
# fc-list :lang=zh-tw
文鼎ＰＬ中楷,AR PL KaitiM Big5:style=Regular
AR PL UMing TW:style=Light
AR PL UMing HK:style=Light
cwTeX 粗黑體,cwTeXHeiBold:style=Medium
AR PL UMing CN:style=Light
文鼎ＰＬ新宋,AR PL New Sung:style=Regular
AR PL UKai TW MBE:style=Book
cwTeX 仿宋體,cwTeXFangSong:style=Medium
cwTeX 明體,cwTeXMing:style=Medium
AR PL UKai CN:style=Book
AR PL UKai HK:style=Book
cwTeX 楷書,cwTeXKai:style=Medium
AR PL UKai TW:style=Book
文鼎ＰＬ細上海宋,AR PL Mingti2L Big5:style=Regular,Reguler
AR PL UMing TW MBE:style=Light
cwTeX 圓體,cwTeXYen:style=Medium

5.下載wkhtmltopdf Linux Static Binary (i368)

wget http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-0.10.0_beta4-static-i386.tar.bz2
--2010-08-03 20:13:15--  http://wkhtmltopdf.googlecode.com/files/wkhtmltopdf-0.10.0_beta4-static-i386.tar.bz2
正在查找主機 wkhtmltopdf.googlecode.com... 64.233.183.82
正在連接 wkhtmltopdf.googlecode.com|64.233.183.82|:80... 連上了。
已送出 HTTP 要求，正在等候回應... 200 OK
長度: 11712708 (11M) application/x-bzip2
Saving to: `wkhtmltopdf-0.10.0_beta4-static-i386.tar.bz2'

100%=================================================================================================================================================================================> 11,712,708  1.08M/s   in 13s

2010-08-03 20:13:29 (881 KB/s) -- 已儲存 ‘wkhtmltopdf-0.10.0_beta4-static-i386.tar.bz2’ 11712708/11712708)

6.執行

# ./wkhtmltopdf-i386
You need to specify atleast one input file, and exactly one output file
Use - for stdin or stdout

Name:
  wkhtmltopdf 0.10.0 beta4

Synopsis:
  wkhtmltopdf GLOBAL OPTION... OBJECT... 

Document objects:
  wkhtmltopdf is able to put several objecs into the output file, an object is
  either a single webpage, a cover webpage or a table of content.  The objects
  are put into the output document in the order they are specified on the
  commandline, options can be specified on a per object basis or in the global
  options area. Options from the Global Options section can only be placed in
  the global options area

  A page objects puts the content of a singe webpage into the output document.

  (page)? < input url/file name  > PAGE OPTION...
  Options for the page object can be placed in the global options and the page
  options areas. The applicable options can be found in the Page Options and
  Headers And Footer Options sections.

  A cover objects puts the content of a singe webpage into the output document,
  the page does not appear in the table of content, and does not have headers
  and footers.

  cover < input url/file name > PAGE OPTION...
  All options that can be specified for a page object can also be specified for
  a cover.

  A table of content object inserts a table of content into the output document.

  toc TOC OPTION...
  All options that can be specified for a page object can also be specified for
  a toc, further more the options from the TOC Options section can also be
  applied. The table of content is generated via xslt which means that it can be
  styled to look however you want it to look. To get an idear of how to do this
  you can dump the default xslt document by supplying the
  --dump-default-toc-xsl, and the outline it works on by supplying
  --dump-outline, see the Outline Options section.

Description:
  Converts one or more HTML pages into a PDF document, using wkhtmltopdf patched
  qt.

Global Options:
      --collate                       Collate when printing multiple copies
                                      (default)
      --no-collate                    Do not collate when printing multiple
                                      copies
      --copies                Number of copies to print into the pdf
                                      file (default 1)
  -H, --extended-help                 Display more extensive help, detailing
                                      less common command switches
  -g, --grayscale                     PDF will be generated in grayscale
  -h, --help                          Display help
  -l, --lowquality                    Generates lower quality pdf/ps. Useful to
                                      shrink the result document space
  -O, --orientation      Set orientation to Landscape or Portrait
                                      (default Portrait)
  -s, --page-size               Set paper size to: A4, Letter, etc.
                                      (default A4)
  -q, --quiet                         Be less verbose
      --read-args-from-stdin          Read command line arguments from stdin
      --title                   The title of the generated pdf file (The
                                      title of the first document is used if not
                                      specified)
  -V, --version                       Output version information an exit

Contact:
  If you experience bugs or want to request new features please visit
  , if you have any problems
  or comments please feel free to contact me: see

example:

# ./wkhtmltopdf-i386 http://tw.yahoo.com/ test.pdf

PDF SAMPLE

Read more here:
9 Useful PHP Functions and Features You Need to Know

Shared by 小董

的確很優~

1. Functions with Arbitrary Number of Arguments

You may already know that PHP allows you to define functions with optional arguments. But there is also a method for allowing completely arbitrary number of function arguments.

First, here is an example with just optional arguments:

// function with 2 optional arguments
function foo($arg1 = '', $arg2 = '') 

	echo "arg1: $arg1n";
	echo "arg2: $arg2n";

foo('hello','world');
/* prints:
arg1: hello
arg2: world
*/

foo();
/* prints:
arg1:
arg2:
*/

Now, let’s see how we can build a function that accepts any number of arguments. This time we are going to utilize func_get_args():

// yes, the argument list can be empty
function foo() 

	// returns an array of all passed arguments
	$args = func_get_args();

	foreach ($args as $k => $v)
		echo "arg".($k+1).": $vn";

}

foo();
/* prints nothing */

foo('hello');
/* prints
arg1: hello
*/

foo('hello', 'world', 'again');
/* prints
arg1: hello
arg2: world
arg3: again
*/

2. Using Glob() to Find Files

Many PHP functions have long and descriptive names. However it may be hard to tell what a function named glob() does unless you are already familiar with that term from elsewhere.

Think of it like a more capable version of the scandir() function. It can let you search for files by using patterns.

// get all php files
$files = glob('*.php');

print_r($files);
/* output looks like:
Array
(
    0 => phptest.php
    1 => pi.php
    2 => post_output.php
    3 => test.php
)
*/

You can fetch multiple file types like this:

// get all php files AND txt files
$files = glob('*.php,txt', GLOB_BRACE);

print_r($files);
/* output looks like:
Array
(
    0 => phptest.php
    1 => pi.php
    2 => post_output.php
    3 => test.php
    4 => log.txt
    5 => test.txt
)
*/

Note that the files can actually be returned with a path, depending on your query:

$files = glob('../images/a*.jpg');

print_r($files);
/* output looks like:
Array
(
    0 => ../images/apple.jpg
    1 => ../images/art.jpg
)
*/

If you want to get the full path to each file, you can just call the realpath() function on the returned values:

$files = glob('../images/a*.jpg');

// applies the function to each array element
$files = array_map('realpath',$files);

print_r($files);
/* output looks like:
Array
(
    0 => C:wampwwwimagesapple.jpg
    1 => C:wampwwwimagesart.jpg
)
*/

3. Memory Usage Information

By observing the memory usage of your scripts, you may be able optimize your code better.

PHP has a garbage collector and a pretty complex memory manager. The amount of memory being used by your script. can go up and down during the execution of a script. To get the current memory usage, we can use the memory_get_usage() function, and to get the highest amount of memory used at any point, we can use the memory_get_peak_usage() function.

echo "Initial: ".memory_get_usage()." bytes n";
/* prints
Initial: 361400 bytes
*/

// let's use up some memory
for ($i = 0; $i < 100000; $i++)
	$array []= md5($i);

// let's remove half of the array
for ($i = 0; $i < 100000; $i++)
	unset($array$i);

echo "Final: ".memory_get_usage()." bytes n";
/* prints
Final: 885912 bytes
*/

echo "Peak: ".memory_get_peak_usage()." bytes n";
/* prints
Peak: 13687072 bytes
*/

4. CPU Usage Information

For this, we are going to utilize the getrusage() function. Keep in mind that this is not available on Windows platforms.

print_r(getrusage());
/* prints
Array
(
    ru_oublock => 0
    ru_inblock => 0
    ru_msgsnd => 2
    ru_msgrcv => 3
    ru_maxrss => 12692
    ru_ixrss => 764
    ru_idrss => 3864
    ru_minflt => 94
    ru_majflt => 0
    ru_nsignals => 1
    ru_nvcsw => 67
    ru_nivcsw => 4
    ru_nswap => 0
    ru_utime.tv_usec => 0
    ru_utime.tv_sec => 0
    ru_stime.tv_usec => 6269
    ru_stime.tv_sec => 0
)

*/

That may look a bit cryptic unless you already have a system administration background. Here is the explanation of each value (you don’t need to memorize these):

• ru_oublock: block output operations
• ru_inblock: block input operations
• ru_msgsnd: messages sent
• ru_msgrcv: messages received
• ru_maxrss: maximum resident set size
• ru_ixrss: integral shared memory size
• ru_idrss: integral unshared data size
• ru_minflt: page reclaims
• ru_majflt: page faults
• ru_nsignals: signals received
• ru_nvcsw: voluntary context switches
• ru_nivcsw: involuntary context switches
• ru_nswap: swaps
• ru_utime.tv_usec: user time used (microseconds)
• ru_utime.tv_sec: user time used (seconds)
• ru_stime.tv_usec: system time used (microseconds)
• ru_stime.tv_sec: system time used (seconds)

To see how much CPU power the script has consumed, we need to look at the ‘user time’ and ‘system time’ values. The seconds and microseconds portions are provided separately by default. You can divide the microseconds value by 1 million, and add it to the seconds value, to get the total seconds as a decimal number.

Let’s see an example:

// sleep for 3 seconds (non-busy)
sleep(3);

$data = getrusage();
echo "User time: ".
	($data'ru_utime.tv_sec' +
	$data'ru_utime.tv_usec' / 1000000);
echo "System time: ".
	($data'ru_stime.tv_sec' +
	$data'ru_stime.tv_usec' / 1000000);

/* prints
User time: 0.011552
System time: 0
*/

Even though the script took about 3 seconds to run, the CPU usage was very very low. Because during the sleep operation, the script actually does not consume CPU resources. There are many other tasks that may take real time, but may not use CPU time, like waiting for disk operations. So as you see, the CPU usage and the actual length of the runtime are not always the same.

Here is another example:

// loop 10 million times (busy)
for($i=0;$i<10000000;$i++) 

$data = getrusage();
echo "User time: ".
	($data'ru_utime.tv_sec' +
	$data'ru_utime.tv_usec' / 1000000);
echo "System time: ".
	($data'ru_stime.tv_sec' +
	$data'ru_stime.tv_usec' / 1000000);

/* prints
User time: 1.424592
System time: 0.004204
*/

That took about 1.4 seconds of CPU time, almost all of which was user time, since there were no system calls.

System Time is the amount of time the CPU spends performing system calls for the kernel on the program’s behalf. Here is an example of that:

$start = microtime(true);
// keep calling microtime for about 3 seconds
while(microtime(true) - $start < 3) 

$data = getrusage();
echo "User time: ".
	($data'ru_utime.tv_sec' +
	$data'ru_utime.tv_usec' / 1000000);
echo "System time: ".
	($data'ru_stime.tv_sec' +
	$data'ru_stime.tv_usec' / 1000000);

/* prints
User time: 1.088171
System time: 1.675315
*/

Now we have quite a bit of system time usage. This is because the script calls the microtime() function many times, which performs a request through the operating system to fetch the time.

Also you may notice the numbers do not quite add up to 3 seconds. This is because there were probably other processes on the server as well, and the script was not using 100% CPU for the whole duration of the 3 seconds.

5. Magic Constants

PHP provides useful magic constants for fetching the current line number (__LINE__), file path (__FILE__), directory path (__DIR__), function name (__FUNCTION__), class name (__CLASS__), method name (__METHOD__) and namespace (__NAMESPACE__).

We are not going to cover each one of these in this article, but I will show you a few use cases.

When including other scripts, it is a good idea to utilize the __FILE__ constant (or also __DIR__ since PHP 5.3):

// this is relative to the loaded script's path
// it may cause problems when running scripts from different directories
require_once('config/database.php');

// this is always relative to this file's path
// no matter where it was included from
require_once(dirname(__FILE__) . '/config/database.php');

Using __LINE__ makes debugging easier. You can track down the line numbers:

// some code
// ...
my_debug("some debug message", __LINE__);
/* prints
Line 4: some debug message
*/

// some more code
// ...
my_debug("another debug message", __LINE__);
/* prints
Line 11: another debug message
*/

function my_debug($msg, $line)
	echo "Line $line: $msgn";

6. Generating Unique ID’s

There may be situations where you need to generate a unique string. I have seen many people use the md5() function for this, even though it’s not exactly meant for this purpose:

// generate unique string
echo md5(time() . mt_rand(1,1000000));

There is actually a PHP function named uniqid() that is meant to be used for this.

// generate unique string
echo uniqid();
/* prints
4bd67c947233e
*/

// generate another unique string
echo uniqid();
/* prints
4bd67c9472340
*/

You may notice that even though the strings are unique, they seem similar for the first several characters. This is because the generated string is related to the server time. This actually has a nice side effect, as every new generated id comes later in alphabetical order, so they can be sorted.

To reduce the chances of getting a duplicate, you can pass a prefix, or the second parameter to increase entropy:

// with prefix
echo uniqid('foo_');
/* prints
foo_4bd67d6cd8b8f
*/

// with more entropy
echo uniqid('',true);
/* prints
4bd67d6cd8b926.12135106
*/

// both
echo uniqid('bar_',true);
/* prints
bar_4bd67da367b650.43684647
*/

This function will generate shorter strings than md5(), which will also save you some space.

7. Serialization

Did you ever need to store a complex variable in a database or a text file? You do not have to come up with a fancy solution to convert your arrays or objects into formatted strings, as PHP already has functions for this purpose.

There are two popular methods of serializing variables. Here is an example that uses the serialize() and unserialize():

// a complex array
$myvar = array(
	'hello',
	42,
	array(1,'two'),
	'apple'
);

// convert to a string
$string = serialize($myvar);

echo $string;
/* prints
a:4:i:0;s:5:"hello";i:1;i:42;i:2;a:2:i:0;i:1;i:1;s:3:"two";i:3;s:5:"apple";}
*/

// you can reproduce the original variable
$newvar = unserialize($string);

print_r($newvar);
/* prints
Array
(
    0 => hello
    1 => 42
    2 => Array
        (
            0 => 1
            1 => two
        )

    3 => apple
)
*/

This was the native PHP serialization method. However, since JSON has become so popular in recent years, they decided to add support for it in PHP 5.2. Now you can use the json_encode() and json_decode() functions as well:

// a complex array
$myvar = array(
	'hello',
	42,
	array(1,'two'),
	'apple'
);

// convert to a string
$string = json_encode($myvar);

echo $string;
/* prints
"hello",42,,"apple"]
*/

// you can reproduce the original variable
$newvar = json_decode($string);

print_r($newvar);
/* prints
Array
(
    0 => hello
    1 => 42
    2 => Array
        (
            0 => 1
            1 => two
        )

    3 => apple
)
*/

It is more compact, and best of all, compatible with javascript and many other languages. However, for complex objects, some information may be lost.

8. Compressing Strings

When talking about compression, we usually think about files, such as ZIP archives. It is possible to compress long strings in PHP, without involving any archive files.

In the following example we are going to utilize the gzcompress() and gzuncompress() functions:

$string =
"Lorem ipsum dolor sit amet, consectetur
adipiscing elit. Nunc ut elit id mi ultricies
adipiscing. Nulla facilisi. Praesent pulvinar,
sapien vel feugiat vestibulum, nulla dui pretium orci,
non ultricies elit lacus quis ante. Lorem ipsum dolor
sit amet, consectetur adipiscing elit. Aliquam
pretium ullamcorper urna quis iaculis. Etiam ac massa
sed turpis tempor luctus. Curabitur sed nibh eu elit
mollis congue. Praesent ipsum diam, consectetur vitae
ornare a, aliquam a nunc. In id magna pellentesque
tellus posuere adipiscing. Sed non mi metus, at lacinia
augue. Sed magna nisi, ornare in mollis in, mollis
sed nunc. Etiam at justo in leo congue mollis.
Nullam in neque eget metus hendrerit scelerisque
eu non enim. Ut malesuada lacus eu nulla bibendum
id euismod urna sodales. ";

$compressed = gzcompress($string);

echo "Original size: ". strlen($string)."n";
/* prints
Original size: 800
*/

echo "Compressed size: ". strlen($compressed)."n";
/* prints
Compressed size: 418
*/

// getting it back
$original = gzuncompress($compressed);

We were able to achive almost 50% size reduction. Also the functions gzencode() and gzdecode() achive similar results, by using a different compression algorithm.

9. Register Shutdown Function

There is a function called register_shutdown_function(), which will let you execute some code right before the script finishes running.

Imagine that you want to capture some benchmark statistics at the end of your script execution, such as how long it took to run:

// capture the start time
$start_time = microtime(true);

// do some stuff
// ...

// display how long the script took
echo "execution took: ".
		(microtime(true) - $start_time).
		" seconds.";

At first this may seem trivial. You just add the code to the very bottom of the script and it runs before it finishes. However, if you ever call the exit() function, that code will never run. Also, if there is a fatal error, or if the script is terminated by the user (by pressing the Stop button in the browser), again it may not run.

When you use register_shutdown_function(), your code will execute no matter why the script has stopped running:

$start_time = microtime(true);

register_shutdown_function('my_shutdown');

// do some stuff
// ...

function my_shutdown()
	global $start_time;

	echo "execution took: ".
			(microtime(true) - $start_time).
			" seconds.";

Conclusion

Do you know any other PHP features that are not widely known but can be very useful? Please share with us in the comments. And thank you for reading!

Read the original here:
Object-Oriented PHP for Beginners

Shared by 小董

會利用物件導向的確可以省很多事 但誤用會多更多事

For many PHP programmers, object-oriented programming is a frightening concept, full of complicated syntax and other roadblocks. As detailed in my book, Pro PHP and jQuery, you’ll learn the concepts behind object-oriented programming (OOP), a style of coding in which related actions are grouped into classes to aid in creating more-compact, effective code.

Understanding Object-Oriented Programming

Object-oriented programming is a style of coding that allows developers to group similar tasks into classes. This helps keep code following the tenet “don’t repeat yourself” (DRY) and easy-to-maintain.

“Object-oriented programming is a style of coding that allows developers to group similar tasks into classes.”

One of the major benefits of DRY programming is that, if a piece of information changes in your program, usually only one change is required to update the code. One of the biggest nightmares for developers is maintaining code where data is declared over and over again, meaning any changes to the program become an infinitely more frustrating game of Where’s Waldo? as they hunt for duplicated data and functionality.

OOP is intimidating to a lot of developers because it introduces new syntax and, at a glance, appears to be far more complex than simple procedural, or inline, code. However, upon closer inspection, OOP is actually a very straightforward and ultimately simpler approach to programming.

Understanding Objects and Classes

Before you can get too deep into the finer points of OOP, a basic understanding of the differences between objects and classes is necessary. This section will go over the building blocks of classes, their different capabilities, and some of their uses.

Recognizing the Differences Between Objects and Classes

Photos by Instant Jefferson and John Wardell

“Developers start talking about objects and classes, and they appear to be interchangeable terms. This is not the case, however.”

Right off the bat, there’s confusion in OOP: seasoned developers start talking about objects and classes, and they appear to be interchangeable terms. This is not the case, however, though the difference can be tough to wrap your head around at first.

A class, for example, is like a blueprint for a house. It defines the shape of the house on paper, with relationships between the different parts of the house clearly defined and planned out, even though the house doesn’t exist.

An object, then, is like the actual house built according to that blueprint. The data stored in the object is like the wood, wires, and concrete that compose the house: without being assembled according to the blueprint, it’s just a pile of stuff. However, when it all comes together, it becomes an organized, useful house.

Classes form the structure of data and actions and use that information to build objects. More than one object can be built from the same class at the same time, each one independent of the others. Continuing with our construction analogy, it’s similar to the way an entire subdivision can be built from the same blueprint: 150 different houses that all look the same but have different
families and decorations inside.

Structuring Classes

The syntax to create a class is pretty straightforward: declare a class using the class keyword, followed by the name of the class and a set of curly braces ({}):

< ?php

class MyClass

    // Class properties and methods go here

?>

After creating the class, a new class can be instantiated and stored in a variable using the new keyword:

$obj = new MyClass;

To see the contents of the class, use var_dump():

var_dump($obj);

Try out this process by putting all the preceding code in a new file called test.php in your local testing folder:

< ?php

class MyClass

	// Class properties and methods go here

$obj = new MyClass;

var_dump($obj);

?>

Load the page in your browser at http://localhost/test.php and the following should display:

object(MyClass)#1 (0)

In its simplest form, you’ve just completed your first OOP script.

Defining Class Properties

To add data to a class, properties, or class-specific variables, are used. These work exactly like regular variables, except they’re bound to the object and therefore can only be accessed using the object.

To add a property to MyClass, add the following code to your script:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

$obj = new MyClass;

var_dump($obj);

?>

The keyword public determines the visibility of the property, which you’ll learn about a little later in this chapter. Next, the property is named using standard variable syntax, and a value is assigned (though class properties do not need an initial value).

To read this property and output it to the browser, reference the object from which to read and the property to be read:

echo $obj->prop1;

Because multiple instances of a class can exist, if the individual object is not referenced, the script would be unable to determine which object to read from. The use of the arrow (->) is an OOP construct that accesses the contained properties and methods of a given object.

Modify the script in test.php to read out the property rather than dumping the whole class by modifying the code as shown:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

$obj = new MyClass;

echo $obj->prop1; // Output the property

?>

Reloading your browser now outputs the following:

I'm a class property!

Defining Class Methods

Methods are class-specific functions. Individual actions that an object will be able to perform are defined within the class as methods.

For instance, to create methods that would set and get the value of the class property $prop1, add the following to your code:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

$obj = new MyClass;

echo $obj->prop1;

?>

Note — OOP allows objects to reference themselves using $this. When working within a method, use $this in the same way you would use the object name outside the class.

To use these methods, call them just like regular functions, but first, reference the object they belong to. Read the property from MyClass, change its value, and read it out again by making the modifications below:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

$obj = new MyClass;

echo $obj->getProperty(); // Get the property value

$obj->setProperty("I'm a new property value!"); // Set a new one

echo $obj->getProperty(); // Read it out again to show the change

?>

Reload your browser, and you’ll see the following:

I'm a class property!
I'm a new property value!

“The power of OOP becomes apparent when using multiple instances of the
same class.”

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create two objects
$obj = new MyClass;
$obj2 = new MyClass;

// Get the value of $prop1 from both objects
echo $obj->getProperty();
echo $obj2->getProperty();

// Set new values for both objects
$obj->setProperty("I'm a new property value!");
$obj2->setProperty("I belong to the second instance!");

// Output both objects' $prop1 value
echo $obj->getProperty();
echo $obj2->getProperty();

?>

When you load the results in your browser, they read as follows:

I'm a class property!
I'm a class property!
I'm a new property value!
I belong to the second instance!

As you can see, OOP keeps objects as separate entities, which makes for easy separation of different pieces of code into small, related bundles.

Magic Methods in OOP

To make the use of objects easier, PHP also provides a number of magic methods, or special methods that are called when certain common actions occur within objects. This allows developers to perform a number of useful tasks with relative ease.

Using Constructors and Destructors

When an object is instantiated, it’s often desirable to set a few things right off the bat. To handle this, PHP provides the magic method __construct(), which is called automatically whenever a new object is
created.

For the purpose of illustrating the concept of constructors, add a constructor to MyClass that will output a message whenever a new instance of the class is created:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create a new object
$obj = new MyClass;

// Get the value of $prop1
echo $obj->getProperty();

// Output a message at the end of the file
echo "End of file.";

?>

Note — __CLASS__ returns the name of the class in which it is called; this is what is known as a magic constant. There are several available magic constants, which you can read more about in the PHP manual.

Reloading the file in your browser will produce the following result:

The class "MyClass" was initiated!
I'm a class property!
End of file.

To call a function when the object is destroyed, the __destruct() magic method is available. This is useful for class cleanup (closing a database connection, for instance).

Output a message when the object is destroyed by defining the magic method
__destruct() in MyClass:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create a new object
$obj = new MyClass;

// Get the value of $prop1
echo $obj->getProperty();

// Output a message at the end of the file
echo "End of file.";

?>

With a destructor defined, reloading the test file results in the following output:

The class "MyClass" was initiated!
I'm a class property!
End of file.
The class "MyClass" was destroyed.

“When the end of a file is reached, PHP automatically releases all resources.”

To explicitly trigger the destructor, you can destroy the object using the
function unset():

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create a new object
$obj = new MyClass;

// Get the value of $prop1
echo $obj->getProperty();

// Destroy the object
unset($obj);

// Output a message at the end of the file
echo "End of file.";

?>

Now the result changes to the following when loaded in your browser:

The class "MyClass" was initiated!
I'm a class property!
The class "MyClass" was destroyed.
End of file.

Converting to a String

To avoid an error if a script attempts to output MyClass as a string, another magic method is used called __toString().

Without __toString(), attempting to output the object as a string results in a fatal error. Attempt to use echo to output the object without a magic method in place:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create a new object
$obj = new MyClass;

// Output the object as a string
echo $obj;

// Destroy the object
unset($obj);

// Output a message at the end of the file
echo "End of file.";

?>

This results in the following:

The class "MyClass" was initiated!

Catchable fatal error: Object of class MyClass could not be converted to string in /Applications/XAMPP/xamppfiles/htdocs/testing/test.php on line 40

To avoid this error, add a __toString() method:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

// Create a new object
$obj = new MyClass;

// Output the object as a string
echo $obj;

// Destroy the object
unset($obj);

// Output a message at the end of the file
echo "End of file.";

?>

In this case, attempting to convert the object to a string results in a call to the getProperty() method. Load the test script in your browser to see the result:

The class "MyClass" was initiated!
Using the toString method: I'm a class property!
The class "MyClass" was destroyed.
End of file.

Tip — In addition to the magic methods discussed in this section, several others are available. For a complete list of magic methods, see the PHP manual page.

Using Class Inheritance

Classes can inherit the methods and properties of another class using the extends keyword. For instance, to create a second class that extends MyClass and adds a method, you would add the following to your test file:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

}

// Create a new object
$newobj = new MyOtherClass;

// Output the object as a string
echo $newobj->newMethod();

// Use a method from the parent class
echo $newobj->getProperty();

?>

Upon reloading the test file in your browser, the following is output:

The class "MyClass" was initiated!
From a new method in MyOtherClass.
I'm a class property!
The class "MyClass" was destroyed.

Overwriting Inherited Properties and Methods

To change the behavior of an existing property or method in the new class, you can simply overwrite it by declaring it again in the new class:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function __construct()

        echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

}

// Create a new object
$newobj = new MyOtherClass;

// Output the object as a string
echo $newobj->newMethod();

// Use a method from the parent class
echo $newobj->getProperty();

?>

This changes the output in the browser to:

A new constructor in MyOtherClass.
From a new method in MyOtherClass.
I'm a class property!
The class "MyClass" was destroyed.

Preserving Original Method Functionality While Overwriting Methods

To add new functionality to an inherited method while keeping the original method intact, use the parent keyword with the scope resolution operator (::):

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    public function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function __construct()

        parent::__construct(); // Call the parent class's constructor
        echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

}

// Create a new object
$newobj = new MyOtherClass;

// Output the object as a string
echo $newobj->newMethod();

// Use a method from the parent class
echo $newobj->getProperty();

?>

This outputs the result of both the parent constructor and the new class’s constructor:

The class "MyClass" was initiated!
A new constructor in MyOtherClass.
From a new method in MyOtherClass.
I'm a class property!
The class "MyClass" was destroyed.

Assigning the Visibility of Properties and Methods

For added control over objects, methods and properties are assigned visibility. This controls how and from where properties and methods can be accessed. There are three visibility keywords: public, protected, and private. In addition to its visibility, a method or property can be declared as static, which allows them to be accessed without an instantiation of the class.

“For added control over objects, methods and properties are assigned visibility.”

Note — Visibility is a new feature as of PHP 5. For information on OOP compatibility with PHP 4, see the PHP manual page.

Public Properties and Methods

All the methods and properties you’ve used so far have been public. This means that they can be accessed anywhere, both within the class and externally.

Protected Properties and Methods

When a property or method is declared protected, it can only be accessed within the class itself or in descendant classes (classes that extend the class containing the protected method).

Declare the getProperty() method as protected in MyClass and try to access it directly from outside the class:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    protected function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function __construct()

        parent::__construct();
		echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

}

// Create a new object
$newobj = new MyOtherClass;

// Attempt to call a protected method
echo $newobj->getProperty();

?>

Upon attempting to run this script, the following error shows up:

The class "MyClass" was initiated!
A new constructor in MyOtherClass.

Fatal error: Call to protected method MyClass::getProperty() from context '' in /Applications/XAMPP/xamppfiles/htdocs/testing/test.php on line 55

Now, create a new method in MyOtherClass to call the getProperty() method:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    protected function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function __construct()

        parent::__construct();
		echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

    public function callProtected()

        return $this->getProperty();

}

// Create a new object
$newobj = new MyOtherClass;

// Call the protected method from within a public method
echo $newobj->callProtected();

?>

This generates the desired result:

The class "MyClass" was initiated!
A new constructor in MyOtherClass.
I'm a class property!
The class "MyClass" was destroyed.

Private Properties and Methods

A property or method declared private is accessible only from within the class that defines it. This means that even if a new class extends the class that defines a private property, that property or method will not be available at all within the child class.

To demonstrate this, declare getProperty() as private in MyClass, and attempt to call callProtected() from
MyOtherClass:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    private function getProperty()

        return $this->prop1 . "";

}

class MyOtherClass extends MyClass

    public function __construct()

        parent::__construct();
        echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

    public function callProtected()

        return $this->getProperty();

}

// Create a new object
$newobj = new MyOtherClass;

// Use a method from the parent class
echo $newobj->callProtected();

?>

Reload your browser, and the following error appears:

The class "MyClass" was initiated!
A new constructor in MyOtherClass.

Fatal error: Call to private method MyClass::getProperty() from context 'MyOtherClass' in /Applications/XAMPP/xamppfiles/htdocs/testing/test.php on line 49

Static Properties and Methods

A method or property declared static can be accessed without first instantiating the class; you simply supply the class name, scope resolution operator, and the property or method name.

“One of the major benefits to using static properties is that they keep their stored values for the duration of the script.”

To demonstrate this, add a static property called $count and a static method called plusOne() to MyClass. Then set up a do...while loop to output the incremented value of $count as long as the value is less than 10:

< ?php

class MyClass

    public $prop1 = "I'm a class property!";

    public static $count = 0;

    public function __construct()

        echo 'The class "', __CLASS__, '" was initiated!';

    public function __destruct()

        echo 'The class "', __CLASS__, '" was destroyed.';

    public function __toString()

        echo "Using the toString method: ";
        return $this->getProperty();

    public function setProperty($newval)

        $this->prop1 = $newval;

    private function getProperty()

        return $this->prop1 . "";

    public static function plusOne()

        return "The count is " . ++self::$count . ".";

}

class MyOtherClass extends MyClass

    public function __construct()

        parent::__construct();
        echo "A new constructor in " . __CLASS__ . ".";

    public function newMethod()

        echo "From a new method in " . __CLASS__ . ".";

    public function callProtected()

        return $this->getProperty();

}

do

    // Call plusOne without instantiating MyClass
    echo MyClass::plusOne();
 while ( MyClass::$count < 10 );

?>

Note — When accessing static properties, the dollar sign
($) comes after the scope resolution operator.

When you load this script in your browser, the following is output:

The count is 1.
The count is 2.
The count is 3.
The count is 4.
The count is 5.
The count is 6.
The count is 7.
The count is 8.
The count is 9.
The count is 10.

Commenting with DocBlocks

“The DocBlock commenting style is a widely
accepted method of documenting classes.”

While not an official part of OOP, the DocBlock commenting style is a widely accepted method of documenting classes. Aside from providing a standard for
developers to use when writing code, it has also been adopted by many of the most popular software development kits (SDKs), such as Eclipse and NetBeans, and will be used to generate code hints.

A DocBlock is defined by using a block comment that starts with an additional asterisk:

/**
 * This is a very basic DocBlock
 */

The real power of DocBlocks comes with the ability to use tags, which start with an at symbol (@) immediately followed by the tag name and the value of the tag. DocBlock tags allow developers to define authors of a file, the license for a class, the property or method information, and other useful information.

The most common tags used follow:

• @author: The author of the current element (which might be a class, file, method, or any bit of code) are listed using this tag. Multiple author tags can be used in the same DocBlock if more than one author is credited. The format for the author name is John Doe .
• @copyright: This signifies the copyright year and name of the copyright holder for the current element. The format is 2010 Copyright Holder.
• @license: This links to the license for the current element. The format for the license information is
  http://www.example.com/path/to/license.txt License Name.
• @var: This holds the type and description of a variable or class property. The format is type element description.
• @param: This tag shows the type and description of a function or method parameter. The format is type $element_name element description.
• @return: The type and description of the return value of a function or method are provided in this tag. The format is type return element description.

A sample class commented with DocBlocks might look like this:

< ?php

/**
 * A simple class
 *
 * This is the long description for this class,
 * which can span as many lines as needed. It is
 * not required, whereas the short description is
 * necessary.
 *
 * It can also span multiple paragraphs if the
 * description merits that much verbiage.
 *
 * @author Jason Lengstorf 
 * @copyright 2010 Ennui Design
 * @license http://www.php.net/license/3_01.txt PHP License 3.01
 */
class SimpleClass

    /**
     * A public variable
     *
     * @var string stores data for the class
     */
    public $foo;

    /**
     * Sets $foo to a new value upon class instantiation
     *
     * @param string $val a value required for the class
     * @return void
     */
    public function __construct($val)

        $this->foo = $val;

    /**
     * Multiplies two integers
     *
     * Accepts a pair of integers and returns the
     * product of the two.
     *
     * @param int $bat a number to be multiplied
     * @param int $baz a number to be multiplied
     * @return int the product of the two parameters
     */
    public function bar($bat, $baz)

        return $bat * $baz;

}

?>

Once you scan the preceding class, the benefits of DocBlock are apparent: everything is clearly defined so that the next developer can pick up the code and never have to wonder what a snippet of code does or what it should contain.

Comparing Object-Oriented and Procedural Code

There’s not really a right and wrong way to write code. That being said, this section outlines a strong argument for adopting an object-oriented approach in software development, especially in large applications.

Reason 1: Ease of Implementation

“While it may be daunting at first, OOP actually provides an easier approach to dealing with data.”

While it may be daunting at first, OOP actually provides an easier approach to dealing with data. Because an object can store data internally, variables don’t need to be passed from function to function to work properly.

Also, because multiple instances of the same class can exist simultaneously, dealing with large data sets is infinitely easier. For instance, imagine you have two people’s information being processed in a file. They need names, occupations, and ages.

The Procedural Approach

Here’s the procedural approach to our example:

< ?php

function changeJob($person, $newjob)

    $person'job' = $newjob; // Change the person's job
    return $person;

function happyBirthday($person)

    ++$person'age'; // Add 1 to the person's age
    return $person;

$person1 = array(
    'name' => 'Tom',
    'job' => 'Button-Pusher',
    'age' => 34
);

$person2 = array(
    'name' => 'John',
    'job' => 'Lever-Puller',
    'age' => 41
);

// Output the starting values for the people
echo "

Person 1: ", print_r($person1, TRUE), "

“;
echo “

Person 2: ", print_r($person2, TRUE), "

“;

// Tom got a promotion and had a birthday
$person1 = changeJob($person1, 'Box-Mover');
$person1 = happyBirthday($person1);

// John just had a birthday
$person2 = happyBirthday($person2);

// Output the new values for the people
echo “

Person 1: ", print_r($person1, TRUE), "

“;
echo “

Person 2: ", print_r($person2, TRUE), "

“;

?>

When executed, the code outputs the following:

Person 1: Array
(
    name => Tom
    job => Button-Pusher
    age => 34
)
Person 2: Array
(
    name => John
    job => Lever-Puller
    age => 41
)
Person 1: Array
(
    name => Tom
    job => Box-Mover
    age => 35
)
Person 2: Array
(
    name => John
    job => Lever-Puller
    age => 42
)

While this code isn’t necessarily bad, there’s a lot to keep in mind while coding. The array of the affected person’s attributes must be passed and returned from each function call, which leaves margin for error.

To clean up this example, it would be desirable to leave as few things up to the developer as possible. Only absolutely essential information for the current operation should need to be passed to the functions.

This is where OOP steps in and helps you clean things up.

The OOP Approach

Here’s the OOP approach to our example:

< ?php

class Person

    private $_name;
    private $_job;
    private $_age;

    public function __construct($name, $job, $age)

        $this->_name = $name;
        $this->_job = $job;
        $this->_age = $age;

    public function changeJob($newjob)

        $this->_job = $newjob;

    public function happyBirthday()

        ++$this->_age;

}

// Create two new people
$person1 = new Person("Tom", "Button-Pusher", 34);
$person2 = new Person("John", "Lever Puller", 41);

// Output their starting point
echo "

Person 1: ", print_r($person1, TRUE), "

“;
echo “

Person 2: ", print_r($person2, TRUE), "

“;

// Give Tom a promotion and a birthday
$person1->changeJob(“Box-Mover”);
$person1->happyBirthday();

// John just gets a year older
$person2->happyBirthday();

// Output the ending values
echo “

Person 1: ", print_r($person1, TRUE), "

“;
echo “

Person 2: ", print_r($person2, TRUE), "

“;

?>

This outputs the following in the browser:

Person 1: Person Object
(
    _name:private => Tom
    _job:private => Button-Pusher
    _age:private => 34
)

Person 2: Person Object
(
    _name:private => John
    _job:private => Lever Puller
    _age:private => 41
)

Person 1: Person Object
(
    _name:private => Tom
    _job:private => Box-Mover
    _age:private => 35
)

Person 2: Person Object
(
    _name:private => John
    _job:private => Lever Puller
    _age:private => 42
)

There’s a little bit more setup involved to make the approach object oriented, but after the class is defined, creating and modifying people is a breeze; a person’s information does not need to be passed or returned from methods, and only absolutely essential information is passed to each method.

“OOP will significantly reduce your workload if implemented properly.”

On the small scale, this difference may not seem like much, but as your applications grow in size, OOP will significantly reduce your workload if implemented properly.

Tip — Not everything needs to be object oriented. A quick function that handles something small in one place inside the application does not necessarily need to be wrapped in a class. Use your best judgment when deciding between object-oriented and procedural approaches.

Reason 2: Better Organization

Another benefit of OOP is how well it lends itself to being easily packaged and cataloged. Each class can generally be kept in its own separate file, and if a uniform naming convention is used, accessing the classes is extremely simple.

Assume you’ve got an application with 150 classes that are called dynamically through a controller file at the root of your application filesystem. All 150 classes follow the naming convention class.classname.inc.php and reside in the inc folder of your application.

The controller can implement PHP’s __autoload() function to dynamically pull in only the classes it needs as they are called, rather than including all 150 in the controller file just in case or coming up with some clever way of including the files in your own code:

< ?php
    function __autoload($class_name)

        include_once 'inc/class.' . $class_name . '.inc.php';

?>

Having each class in a separate file also makes code more portable and easier to reuse in new applications without a bunch of copying and pasting.

Reason 3: Easier Maintenance

Due to the more compact nature of OOP when done correctly, changes in the code are usually much easier to spot and make than in a long spaghetti code procedural implementation.

If a particular array of information gains a new attribute, a procedural piece of software may require (in a worst-case scenario) that the new attribute be added to each function that uses the array.

An OOP application could potentially be updated as easily adding the new property and then adding the methods that deal with said property.

A lot of the benefits covered in this section are the product of OOP in combination with DRY programming practices. It is definitely possible to create easy-to-maintain procedural code that doesn’t cause nightmares, and it is equally possible to create awful object-oriented code. Pro PHP and jQuery will attempt to demonstrate a combination of good coding habits in conjunction with OOP to generate clean code that’s easy to read and maintain.

Summary

At this point, you should feel comfortable with the object-oriented programming style. Learning OOP is a great way to take your programming to that next level. When implemented properly, OOP will help you produce easy-to-read, easy-to-maintain, portable code that will save you (and the developers who work with you) hours of extra work. Are you stuck on something that wasn’t covered in this article? Are you already using OOP and have some tips for beginners? Share them in the comments!

Link:
Cleanup WordPress Header

Shared by 小董

你知道這些狗屎header消耗多少資源嗎?恩~當你超過上萬篇文章就有感覺了~

WordPress implements new standard features in the head of the theme since version 2.5, that are always on the hook wp_head. Even in WordPress 2.8 new functions were added. If you don’t need them you can easily disable them by using the function remove_action.

Function remove_action

remove_action( $tag, $function_to_add, $priority, $accepted_args );

This function removes a function attached to a specified action hook. This method can be used to remove default functions attached to a specific action hook and possibly replace them with a substitute.

Important: To remove a hook, the $function_to_remove and $priority arguments must match when the hook was added. This goes for both filters and actions. No warning will be given on removal failure.
via: WP Codexy

The following syntax shows an excerpt, only a part of the output you can have in your theme. They result from the standard functions, which are loaded in the head of the theme. Visible, if you search in the file wp-includes/default-filters.php for the Hook wp_head. Not all filters should be deactivated, because in most cases they are useful. But WordPress is not only as classical blog in use and therefore some functions are not necessary.

< link rel="alternate" type="application/rss+xml" title="WP Engineer RSS Feed" href="http://wpengineer.com/feed/" />
< link rel="alternate" type="application/atom+xml" title="WP Engineer Atom Feed" href="http://wpengineer.com/feed/atom/" />
< link rel="pingback" href="http://wpengineer.com/blog/xmlrpc.php" />
< link rel="EditURI" type="application/rsd+xml" title="RSD" href="http://wpengineer.com/xmlrpc.php?rsd" />
< link rel='index' title='WP Engineer' href='http://wpengineer.com' />
< link rel='start' title='Use WordPress 2.7 Offline' href='http://wpengineer.com/use-wordpress-27-offline/' />
< link rel='prev' title='Recents Drafts All Authors' href='http://wpengineer.com/recents-drafts-all-authors/' />

This is an example, not a recommendation where some functions are deactivated. Check your header and turn off what you don’t need. Less markup and better loading time.

remove_action( 'wp_head', 'feed_links_extra', 3 ); // Display the links to the extra feeds such as category feeds
remove_action( 'wp_head', 'feed_links', 2 ); // Display the links to the general feeds: Post and Comment Feed
remove_action( 'wp_head', 'rsd_link' ); // Display the link to the Really Simple Discovery service endpoint, EditURI link
remove_action( 'wp_head', 'wlwmanifest_link' ); // Display the link to the Windows Live Writer manifest file.
remove_action( 'wp_head', 'index_rel_link' ); // index link
remove_action( 'wp_head', 'parent_post_rel_link', 10, 0 ); // prev link
remove_action( 'wp_head', 'start_post_rel_link', 10, 0 ); // start link
remove_action( 'wp_head', 'adjacent_posts_rel_link', 10, 0 ); // Display relational links for the posts adjacent to the current post.
remove_action( 'wp_head', 'wp_generator' ); // Display the XHTML generator that is generated on the wp_head hook, WP version

See the article here:
Our WordPress Developer Toolbox

Shared by 小董

我真的為這個文章喝采 他可讓我節省好多時間

Again and again the question comes in: What do you use as an environment to develop with WordPress. Some suggestions I would like to give, these are just my preferences, but I would be happy if you tell me your preferences of tools. Maybe there is one or the other useful tool included, I never heard of.

Platform

Currently I am working on Windows and Linux, so that should be a priority, that I can use my tools on both platforms. This is important to me because I consider a heterogeneous environment for conducive.

Browser

In my everyday environment of web development, I work primarily in the browser and the editor, therefore, these two tools for me are also the center of my work.

My favorite browser is Firefox, especially because of the great Add-ons. Therefore I have to mention the awesome Add-on FireBug , I cannot imagine to work without it. For this Add-on there are even more Add-ons, which I also use and recommend, especially YSlow, FirePHP and Page Speed.

Also I like to use the Add-on Web Developer to get access to certain content of the website, like Cookies or JavaScript. The possibilities of Web Developer are tremendous and therefore a wonderful tool. Some functionalities are included in Firebug and Web Developer, you have to decide which functions you like more in each Add-on.

Editor

Another important tool is the editor, and my favorite is UltraEdit. An editor, which is not Open Source, but I love to use since several years. Here I guess mainly the speed of the editor and the wonderful extensibility with your own tools is the part I really like. That’s why I parse PHP and validate HTML and CSS directly in the editor. For the parsing of CSS I also use CSSTidy, also available online. I parse PHP via web server that is integrated in the editor and also integrated via PHPLint, also in the additional tools of the editor.

Under Linux I can not quite decide whether I should use Geany or NetBeans, where NetBeans is already too slow and I really miss one or the other feature in Geany. UE is currently still in the testing and beta phase and we’ll see, maybe I can not yet get away off this editor.

Webserver & Tools

There are two other important tools to use in the context of web development. I work on the local environment under Windows with XAMPP and in Linux is the local web environment installed via package manager. So I have on each client an environment to work with PHP and mySQL.

Important in the development with PHP is error and warning output and debugging. In PHP, there are several different approaches and I use the module xdebug.
Furthermore, I write in the context the ErrorLog and evaluate them. The last tool I would like to point out is Webgrind, which is used as a web application. Alternatively, there are desktop tools that perform this work, for example WinCacheGrind under Windows. This evaluates perfectly the profiling and optimizes your code.

FTP

To get the development on the server, it usually requires a tool, which dominates the FTP protocol and provides a possible interface for managing the accounts. Here I use under Windows Total Commander, which can be perfectly adapted to your needs and I love it that I can open multiple connections in several tabs. On Linux I use the Add-on for Firefox FireFTP. There are several more tools, but I’ve never found the time to look at various other options.

WordPress

As I develop primarily in and for WordPress, I have a few small Plugins in the test environment active, which ease my view on certain data, and which specifically save errors or issues in WordPress. A small list with short explanation of Plugins, even if I don’t use all of them, but there might be one or two in this list you like.

• WP Developer Assistant – because it has some reports and feature, which are very handy
• CodeStyling Localization – because you can create a Plugin multilingual, it’s easy to create new language files
• Log Deprecated Calls – not always in use, but can be useful
• Error Reporting
• Debug Queries – Analysis of queries
• Debug Objects – Evaluates many values
• Adminer – for the fast access to your webspace or as Plugin directly in your WordPress
• FirePHP – as Plugin for WordPress to access specific content without crawling through your source code
• WordPress Hook Sniffer – interest idea; bad is the replacing of the core-file plugin.php

That should be enough, even there are many more for sure. The decisive factor, in my view are not the Plugins, but the environment with xDebug and the settings that WordPress offers as standard in this context. Therefore, I can only recommend to have the following lines in the wp-config.php of the environment.

/** Debugging WP */
define('WP_DEBUG', true); //enable the reporting of notices during development - E_ALL
define('WP_DEBUG_DISPLAY', true); //use the globally configured setting for display_errors and not force errors to be displayed
define('WP_DEBUG_LOG', true); //error logging to wp-content/debug.log
define('SCRIPT_DEBUG', true); //loads the development (non-minified) versions of all scripts and CSS and disables compression and concatenation,
define('E_DEPRECATED', false); //E_ALL & ~E_DEPRECATED & ~E_STRICT
 
define('AUTOSAVE_INTERVAL', '300');    // Autosave interval
define('SAVEQUERIES', true);    // Analyse queries
define('WP_POST_REVISIONS', false);

These definitions make the work easily with WordPress and there are many indications of WP to have a clean code and current functions. I change the autosave interval only to small values, if I work in this segment, so if I need the script as soon as possible.

Web Applications

On the web there are a variety of tools that are useful – I’d like to briefly introduce some them I use often and also to say my thanks to the people who make these services available.

• php.net – because you never get information fast enough, therefore I have in the Firefox Add-on an additional extension for the internal search field, which searches directly in the functions of php.net (You can use it if you like to)
• wpseek.com – the search for WordPress, also a search extension for Firefox is available
• PHP Cross Reference of WordPress Source – sometimes I’m faster with it than via editor

Conclusion

A small overview of my latest tools and perhaps you find one of them useful or you have suggestions as well for me.

Related posts:

• 3rd Door – Today The Advice: Don’t Steal Premium WordPress Themes
• YAML 3.1 Released
• Quick View on WordPress Settings
• wp_page_menu in WordPress 2.7
• A Chance: WordPress Plugin Competition

Thanks for subscribing our feed! Sponsor the WP Engineer Blog and get your brand in front of several hundred users per day!
© WP Engineer Team, All rights reserved (Digital Fingerprint: WPEngineer-be0254ce2b4972feb4b9cb72034a092d)

View original post here:
WordPress Theme Frameworks: Options You Should Consider

There is no doubt that WordPress is an awesome piece of open source application, and in addition, creating custom themes for it is very intuitive and relatively easy with the WordPress API.

With that said, creating your own custom themes from scratch can be very time-consuming, with plenty of unnecessarily repetitive tasks.

WordPress theme frameworks–which are themes that you can use as a foundation for the creation of your own themes–can drastically boost your performance and efficiency.

To help you learn about WordPress theme frameworks and make your job as developer a bit easier, we are going to review the best WordPress theme frameworks out there.

By the way, this article will not be covering WordPress theme frameworks that don’t use the General Public License that the WordPress core has, as this is the supported licensing type of WordPress.

Why Use a Framework?

In a web developer’s life, a framework helps the speed of production. Much like JavaScript frameworks like MooTools or jQuery, CSS frameworks like the 960 Grid System, or server-side scripting frameworks like Ruby on Rails or CakePHP, WordPress theme frameworks achieve the same sort of efficiency, reduction of errors through cross-browser compatibility, and the provision of useful and common functions.

Let’s draw out the pros and cons of using WordPress theme frameworks.

Pros

• Time savings
• Easier development
• Support via communities built around the WordPress theme frameworks
• Typically has optimized CSS, HTML, PHP functions, and SEO
• Typically has code that’s written with WordPress standards and best practices
• Ease of updating for future releases of WordPress

Cons

A disadvantage of using frameworks is at the beginning, where there is always going to be a learning curve as you adopt new stuff to your development workflow. Though the learning time is relatively short compared to, for example, a new server-side scripting language, you will still have to account for this time when considering the use of WordPress theme frameworks.

However, the best way to look at using any web development framework is that it will be a long-term investment. The time you spend learning the technology at the start pays off in the end in terms of development speed and efficiency.

Another possible disadvantage is that themes built on top of frameworks, depending on the skill of the web developer, could be slower in performance than building themes from scratch, since all frameworks, not just WordPress theme frameworks, provide an additional abstraction layer.

The Concept of Child Themes

Before we start reviewing each framework, it’s important that all of us understand what child themes are in the context of WordPress.

WordPress, by default, supports child themes. Child themes look exactly like their parent themes, unless you make modifications to them. Child themes inherit all the templates, functions, and CSS of parent themes. This compartmentalizes variations so that you can make changes without affecting the integrity of the parent theme.

A child theme is usually contained in a folder having a styles.css (required) and a functions.php file. functions.php is not mandatory, but you will need it if you want to include some custom functions on top of your parent theme (which, in this scenario, is the WordPress theme framework). Both the child theme and parent theme folders will be in the themes directory of your WordPress installation. You can override the inherited traits from its parent by modifying its own styles.css and functions.php files.

Here is how you declare a child theme (this goes inside styles.css, at the top).

/*  
Theme Name: Child Theme
Theme URI: http://sixrevisions.com
Description: A child theme description.
Author: Saad Bassi
Author URI: http://addictivefonts.com/
Template: My Framework (e.g thematic or Hybrid)
Version: 1.0
Tags: theme
*/

The Template attribute above instructs the WordPress core to inherit all the templates of “My Framework,” which is the name of the parent theme in our hypothetical scenario.

WordPress Theme Frameworks

Now let’s review the five best WordPress theme frameworks that you should consider if you are planning to take advantage of them.

1. ThemeHybrid

ThemeHybrid is a popular, free framework developed by the equally popular WordPress developer, Justin Tadlock.

ThemeHybrid is free, but to get support on its forums, you need to sign up for an Exclusive Membership to their Theme Club, which is $25 per year.

With a massive community, you will never get stuck on an issue. ThemeHybrid has many child themes available for download on its website, which you can use to give your WordPress installation a new look without much coding.

ThemeHybrid comes with plenty of WordPress widgets and page templates.

Want to extend the framework? Sky’s the limit and your only real limitation is your imagination (and WordPress theme development skills, of course).

While many people say that frameworks are bloated and slow, ThemeHybrid will change their mind as it is lightning fast and optimized for high performance.

2. Thematic

Thematic is a theme framework by WordPress theme developer, Ian Stewart. Thematic is completely free; from forums to child themes, everything is free!

Though the documentation of this theme is not as comprehensive as ThemeHybrid, you can get insightful tips and tricks from its forum.

Thematic has 13 widget areas that are more than enough for most of your needs. With the WordPress theme framework’s many filters and actions, you can customize your child theme in any way that you want. Its out-of-the-box simple and clean look can even be used without any aesthetical modifications–and it will still look great.

3. Canvas

Canvas is a premium theme framework from WooThemes. As to be expected with any WooThemes product, it has a huge number of options and customization features.

Canvas is best for novice developers and those that don’t want to be bogged down by the ins and outs of coding, but still want to take advantage of the many benefits of using a theme framework.

You can style each element of Canvas differently from its Theme Options panel. The theme framework supports child themes and also has 5 built-in page templates for your home page, including a magazine-style layout and a business site template.

Canvas also supports 6 CSS layouts for your blog and even provides you an option for choosing distinctive layouts for each post and page.

If you are a web designer that doesn’t want to mess with code too much, Canvas should be your pick. To witness the real power of Canvas, watch this video.

4. Genesis

Genesis is a premium theme framework that was built by StudioPress. Genesis has a child theme marketplace where you can buy all additional child themes. Genesis has native support for search engine optimization (which it focuses on). You can set all the options in the Genesis backend panel, just like with most good WordPress theme frameworks.

Similar to the Canvas WordPress theme framework, Genesis gives you the option to select separate layouts for each post and page. Genesis is intended for developers, as opposed to designers, because you will have to learn its hooks and filters before getting started with it, and thus, will need some coding proficiency.

5. Elemental

Elemental is a product of ProThemeDesign. One of its unique features is that it comes bundled with an admin menu bar that stays on top of your WordPress web pages if you are logged in. The admin menu bar allows you to go to the most common places inside the WordPress admin dashboard. The framework comes with 12 page templates and 7 custom widgets by default.

Conclusion

After reviewing these five WordPress theme frameworks, I pick ThemeHybrid as my personal choice–the helpful community coupled with the excellent set of features make it a clear winner in my book.

For WordPress themers just starting out and those that would like to take advantage of WordPress theme frameworks without being bogged down by code, I highly recommend you to go for Canvas, which allows you to modify everything right from the Theme Options panel.

The other three frameworks are also awesome, and the final selection will depend upon your needs and tastes (and, hopefully, this guide will have made making that decision easier for you).

Related Content

• WordPress 3.0: Ultimate Guide to New Features
• 50 Beautiful Free WordPress Themes
• Optimizing WordPress for Search Engines
• Related categories: WordPress and Web Development

About the Author

Saad Bassi is a 20-year-old web developer from Pakistan. He is the Co-Editor at CrispyTech, and blogs about Windows at Windows8Geek. Don’t forget to give him a “hello” on Twitter. Last but not least, make sure that you check out hist latest project, Addictive Fonts which focuses on free high quality font downloads.

Excerpt from:
Photo

View original post here:
Top 10 YouTube Videos About Your Web Interface

The graphical user interface or GUI shapes and defines how we interact with the Web. These YouTube videos on GUI innovation can guide us to a more fluid and natural way to interact with not just the web, but with computers in general.

There are no iPads or iPhones in this collection. Their groundbreaking contributions to GUI have been noted on our site often. Instead, our choices for the best YouTube videos in GUI include a Perceptive Pixel demo, 10 finger multi-touch, Microsoft Surface, a popular Linux interface and 3D touch display. Also of note is Hyposurface, which is a screen made out of physically movable pixels.

Sponsor

If you have any favorite videos about GUI that we didn’t choose, please let us know about them in the comments below.

1. Microsoft Surface Demo @ CES 2008

1,448,802 views

2. Perceptive pixel

294,342 views

3. GNU/LINUX UBUNTU 7.04 Feisty Fawn

286,200 views

4. CES 2009: Intel 3D Touch-screen Display

90,822 views

5. The world of Graphical User Interface.. me inside computer

78,956 views

6. BLUI: Blowable user interface

71,272 views

7. New technology of Korean touchpad

43,989 views

8. 10/GUI – 10 Finger Multitouch User Interface

36,057 views

9. Office of the Future

29,094 views

10. Hyposurface on WBZ Radio

13,435 views

Discuss

Continue reading here:
Introducing WordPress 3 Custom Taxonomies

Shared by 小董

滿適合拿來作商品屬性的~~

WordPress 3 fills in a number of important gaps towards being a serious content management system. The easy-to-use custom taxonomies function gives site designers some powerful tools for building a good information architecture. Learn what taxonomies are, why they’re useful, and how to use them in today’s tutorial!

What is a Taxonomy?

Taxonomies are different methods for classifying things.

Taxonomies are different methods for classifying things. This tutorial uses an example of posts about different desktop computers, which can be classified by a number of distinct criteria, including:

• Amount of RAM
• Size of hard drive
• Speed of CPU
• Type of CPU
• Operating system installed
• and so forth…

A Brief History of WordPress Taxonomies

Categories

Prior to version 2.3, WordPress had only one generic taxonomy, called Category, for Posts. This worked well for blogs, as you could create a top-level category called “Desktop Computers,” with a subcategory called “RAM,” which may have subcategories such as “Less than 1 GB,” “1 GB,” “2 GB to 4GB,” and so on. A second child category of “Desktop Computers” might be called “Operating System,” with subcategories such as “Windows XP,” “Mac OS,” “Red Hat,” “Ubuntu,” and so forth.

When a system allows you to have categories that can be divided into subcategories, we call it a hierarchical structure. The best you could do for a serious site architecture prior to WordPress version 2.3 was to create a large hierarchy of categories, where the top level categories represented large taxonomy groups.

Tags

Version 2.3 of WordPress added another type of taxonomy called Tags. While categories are usually thought out in advance, specific to the types of content on a site, tags provide a more freeform, impromptu method of classifying content.

For instance, when writing a Post about a particular desktop computer, tags allow the author to type one or more keywords such as “gaming,” “tivo,” “noisy fan,” and so forth. These keywords might not make sense as site-wide categories, but help provide some additional classification to a post. Site visitors could then easily find all the posts tagged with “noisy fan” later. The freeform nature of tags, however, doesn’t help us build a solid classification system around known values such as operating system types or CPU types. Tags are also one-dimensional, not allowing any hierarchical structure.

Single-Level Custom Taxonomies

WordPress version 2.8 made it possible to add custom classification schemes with just a few changes to the code on your site. This allowed you to build a list of possible operating systems, separate from a list of possible RAM types, and so on. It did not, however, allow these custom taxonomies to be built in a hierarchy similar to the generic categories taxonomy.

Fully Hierarchical Custom Taxonomies

Finally, WordPress version 3 gives us fully hierarchical custom taxonomies. Notice how the hierarchical nature allows us to simplify the Operating System taxonomy, for instance, by pushing all the different Windows variants under a “Windows” parent classification. This will allow visitors to see all posts classified with any Windows operating system, or allow them to be more specific and see only posts classified with Windows XP, for instance.

Creating a Custom Taxonomy

Editing your theme’s functions.php file

WordPress version 3 does not allow you to create custom taxonomies from the administration screen. To initially define your custom taxonomies without a plugin, you’ll need to add a little bit of code to your theme’s functions.php file. This isn’t too difficult — just follow my lead.

To add custom taxonomies, we need to edit the “functions.php” file found inside your theme directory. For instance, I’m using the default “twentyten” theme that comes with WordPress 3.0, and my WordPress installation is in a directory named “wp.” My functions.php file is then at:
website_root/wp/wp-content/themes/twentyten/functions.php.

Adding the Taxonomies in Code

We’ll stick with the Desktop Computer example, adding separate taxonomies for RAM, Hard Drive, and Operating System. At this point, we’re simply adding the taxonomies themselves, like empty containers. Fortunately, we can add and manage the different classifications, such as “Windows XP,” from the comfort of the admin dashboard.

Step 1 One Function to Create Them All

First, we need to build one function that creates all the taxonomies we need. We’ll call the function “build_taxonomies.” Let’s add this function to the bottom of the functions.php file.

function build_taxonomies()
    // code will go here

Step 2 Defining the Taxonomies

Next, for each taxonomy we want to create, we need to call a particular WordPress function with the right parameters. Here’s the function, and its important parameters explained.

register_taxonomy(
	'internal_name',
	'object_type',
	array(
		'hierarchical' => true,
		'label' => 'Human Readable Name',
		'query_var' => true,
		'rewrite' => true
	)
);

• internal_name: What will this taxonomy be called from inside WordPress, in the database and template files?
• object_type: Which types of content can be classified with this taxonomy? Possible values are “post, page, link,” and then names of custom post types we’ll learn to create in a future tutorial.
• Next comes an array of optional parameters. We’ll use the most important ones here in this tutorial, but a full list can be found on the Function Reference / register_taxonomy Codex page. The parameters we’ll use are:
• hierarchical: If ‘true,’ this taxonomy has hierarchical abilities like WordPress Categories. If ‘false,’ this taxonomy behaves much like freeform Tags.
• label: This is the human-readable name used in your site’s interface to label the taxonomy.
• query_var: If ‘true,’ we’ll be able to ask WordPress for posts dependent upon the selections for this taxonomy. For example, we could search for all the posts where the operating system taxonomy has ‘Windows’ selected.
• rewrite: If ‘true,’ WordPress will use friendly URL’s when viewing a page for this taxonomy. For example, a page listing all the posts with the “Windows” operating system selected would be represented by the following url: http://domain.com/operating_system/windows

Our entry specific to adding the Operating System taxonomy looks like so:

register_taxonomy( 'operating_system', 'post', array( 'hierarchical' => true, 'label' => 'Operating System', 'query_var' => true, 'rewrite' => true ) );

Go ahead and add that to your “build_taxonomies” function.

More information:

“register_taxonomy” is further defined within the WordPress codex.

Step 3 Calling the Taxonomy-Creating Function

We need to add one more line to the “functions.php” file so our “build_taxonomies” function will actually be executed. We’ll “hook” the “build_taxonomies” function to the “init” event by adding the following code:

add_action( 'init', 'build_taxonomies', 0 );

You can add this line anywhere, but I generally add it above the function we’re calling, so it would look like this:

// Custom Taxonomy Code
add_action( 'init', 'build_taxonomies', 0 );

function build_taxonomies()
    register_taxonomy( 'operating_system', 'post', array( 'hierarchical' => true, 'label' => 'Operating System', 'query_var' => true, 'rewrite' => true ) );

More information:

Learn more about add_action.

Adding Classifications to the New Taxonomy

Once you’ve added the “Operating System” taxonomy to the “functions.php” file correctly, it should show up as a new item in the “Posts” panel of your dashboard. Click the taxonomy’s name to add and edit the classifications you want to include.

Now, you can add and edit Operating Systems just as you would add generic Categories.

Adding More Taxonomies

If you want to add the “RAM” and “Hard Drive” taxonomies to follow along with the example, just add the following to your functions.php file:

register_taxonomy( 'ram', 'post', array( 'hierarchical' => true, 'label' => 'RAM', 'query_var' => true, 'rewrite' => true ) );
register_taxonomy( 'hard_drive', 'post', array( 'hierarchical' => true, 'label' => 'Hard Drive', 'query_var' => true, 'rewrite' => true ) );

Once finished, the changed section of your functions.php file will look something like this:

// Custom Taxonomy Code
add_action( 'init', 'build_taxonomies', 0 );

function build_taxonomies()
register_taxonomy( 'operating_system', 'post', array( 'hierarchical' => true, 'label' => 'Operating System', 'query_var' => true, 'rewrite' => true ) );
register_taxonomy( 'ram', 'post', array( 'hierarchical' => true, 'label' => 'RAM', 'query_var' => true, 'rewrite' => true ) );
register_taxonomy( 'hard_drive', 'post', array( 'hierarchical' => true, 'label' => 'Hard Drive', 'query_var' => true, 'rewrite' => true ) );

Creating a Post Using your New Taxonomy

Create a few new posts, and you’ll see your new taxonomy options appear in the Edit Post screen. Select whatever classifications you feel apply to your posts.

Showing a Post’s Various Taxonomies

Nothing we’ve done so far can be seen by your site visitors. We’d like for posts to show what custom taxonomies they’re classified in, just like posts commonly reveal their categories and tags.

To do so, we only need to make a simple addition to the loop in certain template files.

Displaying Taxonomy Classifications on Individual Pages

In the twentyten theme, and many others, a post’s categories and tags are listed below the body text. We’re going to add custom taxonomy information, if it exists, just before the category and tag information.

To make this happen, we’ll need to edit the “single.php” template file, which is normally called to display an individual post. My single.php file is at: website_root/wp/wp-content/themes/twentyten/single.php.

Step 1 Find the Right Place to Add Code

In single.php, find the line with:

This appears just before the:

In twentyten, this div contains the categories, tags, permalink, and other data for the current post. We’ll put our taxonomy information just above this div.

Step 2 Retrieve Taxonomy Information About the Current Post

Populate some variables for holding the taxonomy information output and the different taxonomy information we may expect to find.

< ?php
// Let's find out if we have taxonomy information to display
// Something to build our output in
$taxo_text = "";

// Variables to store each of our possible taxonomy lists
// This one checks for an Operating System classification
$os_list = get_the_term_list( $post->ID, 'operating_system', 'Operating System(s): ', ', ', '' );

Here, we’re calling the WordPress function “get_the_term” list with the following parameters:

• $post->ID : the id of the current post.
• ‘operating_system’ : the name of the custom taxonomy we’re checking for data. We’re asking if the current post has been given any classifications in the ‘operating_system’ taxonomy.
• ‘Operating System(s)’ : If anything is returned, this is the string we’d like to have in front of it.
• ‘, ‘ : If multiple items are returned, this is the string we’d like to have them separated by.
• ” : If anything is returned, this is the string we’d like to have behind it. In this case, we want nothing added behind the result.

We’ll do the same for the other two taxonomies we might expect to contain data:

$ram_list = get_the_term_list( $post->ID, 'ram', 'RAM Option(s): ', ', ', '' );
$hd_list = get_the_term_list( $post->ID, 'hard_drive', 'Hard Drive Option(s): ', ', ', '' );

More information:

Learn more about “get_the_term_list.”

Step 3 Format Results from Classifications, if Any

Check for results in each of the three possible taxonomies. If they exist, add them to our output, as well as a linebreak.

// Add OS list if this post was so tagged
if ( '' != $os_list )
    $taxo_text .= "$os_listn";

// Add RAM list if this post was so tagged
if ( '' != $ram_list )
    $taxo_text .= "$ram_listn";

// Add HD list if this post was so tagged
if ( '' != $hd_list )
    $taxo_text .= "$hd_listn";

Step 4 Display Classification Results, if Any

Check to see if the above steps resulted in any taxonomy information at all to output. If taxonomy info exists, we’ll output it wrapped in a div of class “entry-utility.”

// Output taxonomy information if there was any
// NOTE: We won't even open a div if there's nothing to put inside it.
if ( '' != $taxo_text )
?>

< ?php
echo $taxo_text;
?>


< ?
 // endif
?>

Step 5 Check Your Results

Visit a post page, and you should see any custom taxonomy classifications listed below.

Viewing a List of Posts by Taxonomy Classification

Now our individual posts tell us what custom taxonomies they have been classified with. When they list a custom taxonomy classification, they also provide a link to list all posts under that classification. For instance, clicking the “Mac OS” link next to “Operating Systems” under our post will theoretically list all the posts with the “Mac OS” operating system classification.

However, this doesn’t happen out of the box with WordPress version 3. We’ll have to make a custom template file for displaying taxonomy archives in order for it to work. WordPress already lets visitors view all posts assigned to a particular category, or all posts given a certain tag. When we’re done here, we’ll be able to view all posts assigned to particular classifications in our custom taxonomies, too.

To make this happen, we’ll need to create the “taxonomy.php” template file. WordPress will try to use this file any time it wants to list posts in a custom taxonomy.

Step 1

Open the “category.php” file, copy its contents, and paste it into a new file called “taxonomy.php.” Save taxonomy.php in the theme directory. For instance, my taxonomy.php file is at:
website_root/wp/wp-content/themes/twentyten/taxonomy.php.

Step 2 Get Information About Current Taxonomy Classification

In the taxonomy.php file, we need to get information about the taxonomy being listed. We’ll probably want the name and description (if any) for the selected classification.

Just under < ?php get_header(); ?>, add the following line:

$term = get_term_by( 'slug', get_query_var( 'term' ), get_query_var( 'taxonomy' ) );

This gets all of the information about the taxonomy that called this page and returns it as an object into the variable $term. For example, the “Mac OS” classification returns an object as such:

stdClass Object
(
    term_id => 13
    name => Mac OS
    slug => mac-os
    term_group => 0
    term_taxonomy_id => 22
    taxonomy => operating_system
    description =>
    parent => 0
    count => 2
)

Step 3 Display Classification Name and Description

We want to change the page name to tell visitors what they’re looking at. Since we started with the category.php template, we can take the line that used to print the category name and change it a bit to give us our desired page name and, if applicable, description.

Change the following line from category.php:

printf( __( 'Category Archives: %s', 'twentyten' ), '' . single_cat_title( '', false ) . '' );

To read as follows:

printf( __( 'Posts classified under: %s', 'twentyten' ), '' . $term_name . '' );

This changes the static text beginning the line, and then inserts the name of the classification. (Note: for proper localization, we would need to add ‘Posts classified under:’ correctly to the languages/twentyten.pot file. That’s outside the scope of this tutorial, but be aware of the transgression here.)

Then add the following:

if ('' != $term_descr )
echo "

$term_descr

n";

If a description exists for this classification, it will be displayed just beneath the title.

After making changes to taxonomy.php, visit one of your posts that has been given a custom taxonomy classification. Because of our earlier work in the file “single.php,” the post should show custom classifications below it. Simply click one of those classifications to see the taxonomy listing at work.

Conclusion

I hope this tutorial explained clearly what taxonomies are and showed you how to make use of them in WordPress 3 as a powerful organizational tool. I hope to provide a follow up tutorial soon explaining WordPress custom post types, their tight relationship with custom taxonomies, and how to use them. Thanks so much for taking the time to visit Nettuts!