PHP'nin komut satırından kullanımı

PHP 4.3.0 sürümünden beri, Komut Satırı Arayüzü anlamına gelen CLI isimli yeni bir SAPI türünü (Sunucu Uygulaması Yazılım Arayüzü) desteklemektedir. Adından da anlaşıldığı gibi, bu SAPI türünün ana odağı PHP ile kabuk (veya masaüstü) uygulamaları geliştirmektir. CLI SAPI'nin bu bölümde anlatılan diğer SAPI'lerden az bir farkı vardır. Söylemek gerekir ki, her ne kadar CLI ve CGI birçok aynı davranışı paylaşsa da farklı SAPI'lerdir.

CLI SAPI ilk kez PHP 4.2.0 ile dağıtıldı, fakat hala deneyseldi ve ./configure çalıştırılırken açıkça --enable-cli ile etkinleştirilmesi gerekiyordu. PHP 4.3.0'dan beri CLI SAPI deneysel değil ve --enable-cli öntanımlı olarak bulunmaktadır. Etkinliğini kaldırmak için --disable-cli kullanabilirsiniz.

PHP 4.3.0'dan beri, CLI/CGI çalıştırılabilirinin adı, yeri ve mevcudiyeti PHP'nin sisteminize nasıl kurulduğuna bağlı olarak değişecektir. make çalıştırıldığında öntanımlı olarak, hem CGI hem de CLI derlenir ve PHP kaynak ağacında sapi/cgi/php-cgi ve sapi/cli/php dizinlerine ayrı yerleştirilirler. Her ikisinin de adının php olduğunu farkedeceksiniz. make install çalıştırıldığında ne yaşanacağı yapılandırma satırınıza bağlıdır. Eğer yapılandırma sırasında apxs gibi bir SAPI modülü seçildiyse, veya --disable-cgi seçeneği kullanıldıysa, make install sırasında CLI {PREFIX}/bin/php dizinine kopyalanır, aksi takdirde buraya CGI yerleştirilir. Örneğin, --with--apxs yapılandırma satırınızda ise make install sırasında CLI {PREFIX}/bin/php dizinine kopyalanır. Eğer CGI kurulumunu etkisiz kılmak isterseniz, make install'dan sonra make install-cli kullanın. Ya da yapılandırma satırınızda --disable-cgi belirtebilirsiniz.

Bilginize: --enable-cli ve --enable-cgi öntanımlı olarak etkinleştirildiği için, yapılandırma satırınızda sadece --enable-cli olması CLI'nin make install sırasında {PREFIX}/bin/php dizinine kopyalanacağı anlamına gelmez.

PHP 4.2.0 ve PHP 4.2.3 arasındaki Windows paketlerinde CLI php-cli.exe olarak, CGI da aynı dizinde php.exe olarak dağıtılmıştır. PHP 4.3.0'la başlayarak Windows paketlerinde CLI, cli adlı farklı bir dizinde php.exe olarak dağıtılmıştır, böylece cli/php.exe olmuştur. PHP 5'le başlayarak, CLI ana dizinde php.exe adıyla dağıtılmıştır. CGI sürümü php-cgi.exe olarak dağıtılmaktadır.

PHP 5'den beri, php-win.exe isimli yeni bir dosya dağıtılmaktadır. Bu CLI sürümü ile aynıdır, fakat php-win herhangi çıktı vermez, bu nedenle konsol desteklemez (ekranda "dos penceresi" görünmez). Bu yaklaşım php-gtk ile benzerlik gösterir. --enable-cli-win32 ile yapılandırılması gerekir.

Bilginize: Bende hangi SAPI var?
Kabuktan, php -v yazımı php CGI mı CLI mi olduğunu söyler. Ayrıca php_sapi_name() işlevine ve PHP_SAPI sabitine bakınız.

Bilginize: PHP 4.3.2'de bir Unix kılavuz (man) sayfası eklendi. Bunu kabuk ortamınıza man php yazarak görüntüleyebilirsiniz.

CLI SAPI'nin diğer SAPI'lerden dikkate değer farklılıkları:

• CGI SAPI'den farklı olarak, çıktıya hiçbir başlık yazılmaz.

  CGI SAPI HTTP başlıklarını önlemek için bir yol sunsa da, CLI SAPI'de onları etkinleştirecek eşdeğer bir seçenek yoktur.

  CLI öntanımlı olarak sessiz kipte başlar, -q ve --no-header seçenekleri eski CGI betiklerinin kullanımına uyumluluk için tutulmaktadır.

  Çalışma dizinini betiğinki ile aynı yapmaz. (-C ve --no-chdir seçenekleri uyumluluk için tutulmaktadır)

  Düz metin hata iletileri (HTML biçimlendirmesi yok).

• Kabuk ortamında birşey ifade etmedikleri için CLI SAPI tarafından geçersiz kılınan bazı php.ini yönergeleri vardır:

  Geçersiz kılınan php.ini yönergeleri

  Yönerge	CLI SAPI öntanımlı değeri	Yorum
  html_errors	FALSE	Hata iletileri HTML etiketleri ile karıştırılmışken, kabukta bunları okumak oldukça zor olacağı için bu yönerge öntanımlı olarak FALSE değerlidir.
  implicit_flush	TRUE	print(), echo() ve arkadaşlarından gelen çıktıların önbellekte tutulmadan hemen çıktıya yazılması istenir. Eğer standart çıktıyı ertelemek veya işlemek isterseniz çıktı önbellekleme kullanabilirsiniz.
  max_execution_time	0 (sınırsız)	Kabuk ortamlarında PHP kullanımının sonsuz olasılığı olduğu için, azami işletim süresi sınırsız olarak belirtilmiştir. HTML üretmek için yazılan uygulamalar genellikle çok çabuk işletilse de, kabuk uygulamaları daha fazla işletim zamanı harcama eğilimindedirler.
  register_argc_argv	TRUE	Bu ayar TRUE olduğu için CLI SAPIdeki argc (uygulamaya aktarılan değiştirge sayısı) ve argv (gerçek değiştirgeler dizisi) değerlerine her zaman erişebilirsiniz. PHP 4.3.0'dan beri, CLI SAPI kullanırken $argc ve $argv PHP değişkenleri uygun değerlerle doldurulur ve kaydedilir. Bu sürümden önce, bu değişkenlerin yaratılışı register_globals PHP yönergesi değerinin on olmasını gerektiren CGI ve modül sürümlerindeki gibi davranırdı. Sürüme ve register_globals ayarına bakmaksızın $_SERVER veya $HTTP_SERVER_VARS üzerinden kullanabilirsiniz. Örnek: $_SERVER['argv']

  Bilginize: Bu yönergeler php.ini yapılandırma dosyasından başka bir değerle ilklendirilemezler. Bu bir sınırlamadır çünkü bu öntanımlı değerler bütün yapılandırma dosyaları çözümlendikten sonra uygulanırlar. Fakat, çalışma anında bunların değerleri değişirilebilir (bu yönergeler için birşey ifade etmez, örn. register_argc_argv).
  

• Kabuk ortamında kolay çalışmak için aşağıdaki sabitler tanımlanmıştır:

  CLI'ye özel Sabitler

  Sabit	Açıklama
  STDIN	stdin'e açılmış bir akımdır. Aşağıdaki örnek akımı açıp geleni kaydeder: <?php $stdin = fopen('php://stdin', 'r'); ?> Eğer stdin'den tek satır okumak istenirse şu kullanılabilir: <?php $line = trim(fgets(STDIN));     //  STDIN'den bir satır okur fscanf(STDIN, "%d\n", $number); // STDIN'den sayı okur ?>
  STDOUT	stdout'a açılmış bir akımdır. Aşağıdaki örnek akımı açıp gideni kaydeder: <?php $stdout = fopen('php://stdout', 'w'); ?>
  STDERR	stderr'e açılmış bir akımdır. Aşağıdaki örnek akımı açıp çıktıyı kaydeder: <?php $stderr = fopen('php://stderr', 'w'); ?>

  Yukarıda verilene göre, örneğin stderr için bir akım açmanız gerekmez, ancak akım kaynağı yerine sabit kullanabilirsiniz:

  php -r 'fwrite(STDERR, "stderr\n");'

  Betik sonlandığında PHP özdevinimli olarak akımları kapattığı için sizin ayrıca kapatmanız gerekmez.

  Bilginize: Bu sabitler, PHP betiğinin stdin'den okunması halinde mevcut değildir.
  

• CLI SAPI geçerli dizini betiğin işletildiği dizine değiştirmez!

  CGI SAPI farkını gösteren örnek:

  <?php
// deneme.php isimli basit deneme uygulamamız
echo getcwd(), "\n";
?>

  CGI sürümününü kullanınca, çıktı şöyle olur:

  $ pwd
  /tmp
  
  $ php -q bir_dizin/deneme.php
  /tmp/bir_dizin
  

  Bu açıkça gösteriyor ki PHP geçerli dizinini betiğin çalıştığı dizine değiştiriyor.

  CLI SAPI kullanımı sonucu:

  $ pwd
  /tmp
  
  $ php -f bir_dizin/deneme.php
  /tmp
  

  Bu, PHP'de kabuk araçları yazarken daha fazla esneklik imkanı verir.

  Bilginize: CGI SAPI bu CLI SAPI davranışını komut satırından çalışırken -C seçeneği ile destekler.
  

PHP çalıştırılabiliri tarafından desteklenen komut satırı seçenekleri listesi istenirse PHP -h seçeneği ile çalıştırılarak sorgulanabilir:

Kullanım: php [seçenekler] [-f] <dosya> [--] [değiştirgeler...]
  php [seçenekler] -r <kod> [--] [değiştirgeler...]
  php [seçenekler] [-B <başlangıç_kodu>] -R <kod> [-E <bitiş_kodu>] [--] [değiştirgeler...]
  php [seçenekler] [-B <başlangıç_kodu>] -F <dosya> [-E <bitiş_kodu>] [--] [değiştirgeler...]
  php [seçenekler] -- [değiştirgeler...]
  php [seçenekler] -a

  -a               Etkileşimli çalışır
  -c <yol>|<dosya> php.ini dosyası bu dizinde aranır
  -n               Hiçbir php.ini dosyası kullanılmayacak
  -d foo[=bar]     'bar' değerli bir foo INI girdisi tanımlar
  -e               Hata ayıklayıcı/profilci için genişletilmiş bilgi üretir
  -f <dosya>       <dosya>'yı çözümler ve çalıştırır
  -h               Bu yardım iletisini gösterir
  -i               PHP bilgisi
  -l               Sadece söz dizimi denetimi (lint)
  -m               Modül olarak derlenenleri gösterir
  -r <kod>         PHP <kod>unu <?..?> betik etiketleri olmadan çalıştırır
  -B <başlangıç_kodu>  PHP <başlangıç_kodu>nu girdi satırlarından önce
                   çalıştırır
  -R <kod>         PHP <kod>unu her girdi satırı için çalıştırır
  -F <dosya>       Her girdi satırı için <dosya>yı çözümler ve çalıştırır
  -E <bitiş_kodu>  PHP <bitiş_kodu>nu bütün girdi satırlarını işledikten
                   sonra çalıştırır
  -H               Harici araçlardan aktarılan bütün değiştirgeleri gizler
  -s               Kaynağı renklendirilmiş söz dizimi ile gösterir
  -v               Sürüm bilgilerini gösterir
  -w               Kaynağı boşluklar ve yorumlardan arındırılmış olarak
                   gösterir
  -z <dosya>       <dosya> Zend eklentisini yükler

  değiştirgeler... Betiğe aktarılan değiştirgeler. Eğer betik stdin'den
                   okunuyorsa veya ilk değiştirge - ile başlıyorsa
                   -- değiştirgeler kullanın

  --ini            Yapılandırma dosyası isimlerini gösterir

  --rf <isim>      <isim> işlevi hakkında bilgi gösterir
  --rc <isim>      <isim> sınıfı hakkında bilgi gösterir
  --re <isim>      <isim> eklentisi hakkında bilgi gösterir
  --ri <isim>      <isim> eklentisi için yapılandırmayı gösterir

CLI SAPI çalıştırmak istediğiniz PHP kodunu getirmek için üç farklı yola sahiptir:

1. PHP'ye belli bir dosyayı çalıştırmasını söyleyerek.

   php ornek_betik.php
   
   php -f ornek_betik.php
   

   Her iki yolla da (-f seçeneğini olsun olmasın) ornek_betik.php dosyası çalıştırılır. Çalıştırmak için herhangi bir dosyayı seçebilirsiniz - PHP betikleriniz .php uzantısı ile bitmek zorunda değildir, istediğiniz herhangi bir isim ve uzantıya sahip olabilirler.

   Bilginize: Eğer betiklerinize değiştirgeler aktarmanız gerekirse -f seçeneğini kullandığınızda ilk değiştirge olarak -- aktarmanız gerekir.
   

2. Doğrudan komut satırında işletmek üzere PHP kodunu aktararak.

   php -r 'print_r(get_defined_constants());'
   

   Kabuk değişken değişimi ve tırnak kullanımı için özel bir çaba sarfetmek gerekir.

   Bilginize: Örneği dikkatle okuyunuz, hiçbir başlangıç veya bitiş etiketi yok! -r seçeneği bunlara ihtiyaç duymaz. Bunların kullanımı çözümleme hatasına yol açar.
   

3. Çalıştırılacak PHP kodunu standart girdiden (stdin) yollamak suretiyle.

   Bu, PHP kodunu devingen olarak oluşturma ve bunu çalıştırma yeteneği sağlar. Örneğin:

   $ bir_uygulama | bir_suzgec | php | sort -u > nihai_sonuc.txt
   

Kodu çalıştırmak için bu üç yol birlikte kullanılamaz.

Her kabuk uygulamasındaki gibi, PHP çalıştırılabiliri bir takım değiştirgeler alabildiği gibi PHP betiğiniz de değiştirgeler alabilir. Betiğinize aktarabileceğiniz değiştirge sayısı PHP tarafından sınırlandırılmamıştır (kabukta aktarılabilecek karakter sayısı sınırlıdır; genellikle bu sınıra ulaşmazsınız). Betiğinize aktarılan değiştirgeler $argv küresel dizisinde bulunur. Sıfır indisi her zaman betik adını içerir (PHP kodu standart girdiden veya -r komut satırı seçeneğiyle çalıştıysa betik adı - olur). İkinci kayıtlı küresel değişken $argc'dir ve $argv dizisindeki eleman sayısını içerir (betiğe aktarılan değiştirge sayısını değil).

Betiğinize aktarmak istediğiniz değiştirgeler - karakteriyle başlamadığı sürece, özel bir şeye dikkat etmeniz gerekmez. Betiğinize - ile başlayan bir değiştirge aktarımı sorun yaratır çünkü PHP bunu kendisinin işlemesi gerektiğini düşünecektir. Bunu önlemek için, değiştirge listesi ayracı olan -- kullanın, bunu izleyen her değiştirge ellenmeden betiğinize aktarılır.

# Bu verilen kodu çalıştırmaz fakat PHP kullanımını gösterir
$ php -r 'var_dump($argv);' -h
Usage: php [options] [-f] <file> [args...]
[...]

# Bu '-h' değiştirgesini betiğinize aktarır ve
# PHP'nin değiştirgeyi görmesini önler
$ php -r 'var_dump($argv);' -- -h
array(2) {
  [0]=>
  string(1) "-"
  [1]=>
  string(2) "-h"
}

Kabuk betikleri için PHP farklı bir yoldan kullanılabilir. İlk satırı #!/usr/bin/php ile başlayan bir betik yazabilirsiniz. Bunu takip eden satırlara başlangıç ve bitiş etiketlerine sahip normal PHP kodunuzu yerleştirebilirsiniz. Dosyanın çalıştırma izinlerini ayarladığınızda (örn. chmod +x deneme) betiğiniz normal bir kabuk veya perl betiği gibi işletilir.

$ chmod +x deneme
$ ./deneme -h -- foo
array(4) {
  [0]=>
  string(6) "./deneme"
  [1]=>
  string(2) "-h"
  [2]=>
  string(2) "--"
  [3]=>
  string(3) "foo"
}

Gördüğünüz gibi, bu durumda betiğinize - ile başlayan değiştirge aktarırken hiçbir şeye dikkat etmeniz gerekmez.

Uzun seçenekler PHP 4.3.3'den beri mevcuttur.

$ php -c /ozel/dizin/ ornek_betik.php

$ php -c /ozel/dizin/ozel-dosya.ini ornek_betik.php

-d ayar_yönergesi[=değer]

# Değer kısmını atlamak yapılandırma yönergesini "1" yapar
$ php -d max_execution_time
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(1) "1"

# Boş değer aktarınca yapılandırma yönergesinine "" atanır
php -d max_execution_time=
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(0) ""

# Yapılandırma yönergesine '=' karakterinden sonra aktarılan değer atanır
$  php -d max_execution_time=20
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(2) "20"
$  php
        -d max_execution_time=herhangi_bir_sey
        -r '$foo = ini_get("max_execution_time"); var_dump($foo);'
string(15) "herhangi_bir_sey"

$ php -m
[PHP Modules]
xml
tokenizer
standard
session
posix
pcre
overload
mysql
mbstring
ctype

[Zend Modules]

$ find projem | php -B '$l=0;' -R '$l += count(@file($argn));' -E 'echo "Toplam Satır Sayısı: $l\n";'
Toplam Satır Sayısı: 37328

$ php -v
PHP 5.3.0alpha3-dev (cli) (built: Nov 13 2008 18:20:00)
Copyright (c) 1997-2008 The PHP Group
Zend Engine v2.3.0, Copyright (c) 1998-2008 Zend Technologies

$ php --ini
Configuration File (php.ini) Path: /usr/dev/php/5.2/lib
Loaded Configuration File:         /usr/dev/php/5.2/lib/php.ini
Scan for additional .ini files in: (none)
Additional .ini files parsed:      (none)

$ php --rf var_dump
Function [ <internal> public function var_dump ] {

  - Parameters [2] {
    Parameter #0 [ <required> $var ]
    Parameter #1 [ <optional> $... ]
  }
}

$ php --rc Directory
Class [ <internal:standard> class Directory ] {

  - Constants [0] {
  }

  - Static properties [0] {
  }

  - Static methods [0] {
  }

  - Properties [0] {
  }

  - Methods [3] {
    Method [ <internal> public method close ] {
    }

    Method [ <internal> public method rewind ] {
    }

    Method [ <internal> public method read ] {
    }
  }
}

$ php --re json
Extension [ <persistent> extension #19 json version 1.2.1 ] {

  - Functions {
    Function [ <internal> function json_encode ] {
    }
    Function [ <internal> function json_decode ] {
    }
  }
}

$ php --ri date

date

date/time support => enabled
"Olson" Timezone Database Version => 2008.9
Timezone Database => internal
Default timezone => Europe/Helsinki

Directive => Local Value => Master Value
date.timezone => no value => no value
date.default_latitude => 31.7667 => 31.7667
date.default_longitude => 35.2333 => 35.2333
date.sunset_zenith => 90.583333 => 90.583333
date.sunrise_zenith => 90.583333 => 90.583333

PHP çalıştırılabiliri HTTP sunucusundan tamamen bağımsız olarak PHP betikleri çalıştırmak için kullanılabilir. Eğer Unix sistemi üzerindeyseniz, PHP betiğinizin başına özel bir satır eklemeli ve dosyanızı çalıştırılabilir yapmalısınız; böylece sistem betiğinizi hangi programın çalıştıracağını bilir. Windows üzerinde .php dosyalarına çift tıklama seçeneği ile php.exe ilişkilendirebilir veya betiği PHP üzerinden çalıştıracak bir yığın dosyası yapabilirsiniz. Unix'de çalışması için betiğe eklenen ilk satır Windows'da sorun çıkarmaz, böylece platformdan bağımsız programlar yazabilirsiniz. Örnek basit bir komut satırı PHP programı aşağıdaki gibi olabilir.

Yukarıdaki betikte, bu dosyanın PHP tarafından çalıştırılması gerektiğini belirten özel bir ilk satır kullandık. Burada CLI sürümü ile çalışıyoruz, böylece HTTP başlık çıktıları olmayacak. PHP ile komut satırı uygulamaları yazarken kullanabileceğiniz iki değişken vardır: $argc ve $argv. Birincisi değiştirge sayısından bir fazlasıdır (çalışan betiğin adı). İkincisi değiştirgeleri içeren bir dizidir, sıfır numarayla başlar ve ilk elemanında betik adını içerir ($argv[0]).

Yukarıdaki programda birden farklı sayıda değiştirge olup olmadığını kontrol ettik. Ayrıca eğer değiştirge --help, -help, -h veya -? ise yardım iletisini yazdırdık ve betik adını devingen olarak yazdırdık. Eğer bazı başka değiştirgeler aldıysak yazdırdık.

Eğer yukarıdaki betiği Unix üzerinde çalıştırmak isterseniz betiği çalıştırılabilir yapmalı ve betik.php echothis veya betik.php -h ile çağırmalısınız. Windows'da bu iş için bir yığın dosyası yapabilirsiniz:

@echo OFF
"C:\php\php.exe" script.php %*

Yukarıdaki programı betik.php olarak adlandırdığınız ve C:\php\php.exe içinde CLI'nin php.exe olduğu varsayılarak bu yığın dosyası sizin eklediğiniz seçeneklerle çalışacaktır: betik.bat echothis veya betik.bat -h.

PHP'deki komut satırı uygulamalarını iyileştirmek için kullanabileceğiniz işlevlerle ilgili bilgi için Readline eklentisinin belgesine bakınız.

Windows üzerindeyseniz PHP, Command Line PHP on Microsoft Windows bölümünde açıklandığı gibi .php uzantısına veya C:\php\php.exe çalıştırılabilirinin belirtilmesine gerek kalmadan çalıştırılmak üzere yapılandırılabilir.