En İyi Uygulamalar: PHP'de uzun, çok satırlı dizelerle mi çalışıyorsunuz?

Not: Bu son derece basit bir soru ise özür dilerim ama kodumun biçimlendirilmesi konusunda biraz saplantılı bir kompulsifim var.

Bir e-posta gövde metnini yapacak bir dize döndüren bir işlevi olan bir sınıf var. Bu metnin e-postada doğru görünmesi için biçimlendirilmesini istiyorum, aynı zamanda kodumu korkak göstermiyor. Demek istediğim şu:

class Something
{
    public function getEmailText($vars)
    {
        $text = 'Hello ' . $vars->name . ",

The second line starts two lines below.

I also don't want any spaces before the new line, so it's butted up against the left side of the screen.";
        return $text;
    }
}

ancak şu şekilde de yazılabilir:

public function getEmailText($vars)
{
    $text = "Hello {$vars->name},\n\rThe second line starts two lines below.\n\rI also don't want any spaces before the new line, so it's butted up against the left side of the screen.";
    return $text;
}

ama yeni hatlar ve satır başı ile olan anlaşma nedir? Fark ne? Mı \n\neşdeğer \r\rveya \n\r? Çizgiler arasında çizgi boşluğu oluştururken hangisini kullanmalıyım?

Sonra çıktı tamponlama ve yorumlu sözdizimi seçeneği var.

Nesnelerinizde uzun çok satırlı dizeler kullanmakla nasıl başa çıkıyorsunuz?

HEREDOC veya NOWDOC kullanmalısınız.

$var = "some text";
$text = <<<EOT
  Place your text between the EOT. It's
  the delimiter that ends the text
  of your multiline string.
  $var
EOT;

Heredoc ve Nowdoc arasındaki fark, bir heredoc içine gömülü PHP kodunun yürütülmesidir, Nowdoc'daki PHP kodu ise yazdırılacaktır.

$var = "foo";
$text = <<<'EOT'
  My $var
EOT;

Bu durumda $ text değeri olacaktır My $var.

Not: kapanmadan önce EOT;boşluk veya sekme olmamalıdır. aksi takdirde bir hata alırsınız

Ben pix0r gibi benzer bir sistem kullanın ve bu kodu oldukça okunabilir hale düşünüyorum. Bazen aslında satır sonlarını çift tırnak içinde ayırmak ve dizenin geri kalanı için tek tırnak kullanmak kadar ileri gider. Bu şekilde, metnin geri kalanından öne çıkarlar ve çift tırnaklı dizeye enjekte etmek yerine birleştirme kullanırsanız değişkenler de daha iyi görünür. Orijinal örneğinizle böyle bir şey yapabilirim:

$text = 'Hello ' . $vars->name . ','
      . "\r\n\r\n"
      . 'The second line starts two lines below.'
      . "\r\n\r\n"
      . 'I also don\'t want any spaces before the new line,'
      . ' so it\'s butted up against the left side of the screen.';

return $text;

Satır sonlarıyla ilgili olarak, e-posta ile her zaman \ r \ n kullanmalısınız. PHP_EOL, php'nin üzerinde çalıştığı işletim sisteminde kullanılması amaçlanan dosyalar içindir.

Uzun metin için şablonlar kullanıyorum:

email-template.txt içeriği

hello {name}!
how are you? 

PHP bunu yapmak:

$email = file_get_contents('email-template.txt');
$email = str_replace('{name},', 'Simon', $email);

Dizenin içine \nve / veya \rortasına ekleme ve ikinci örnekte olduğu gibi çok uzun bir kod satırına sahip olmak doğru gelmiyor: kodu okuduğunuzda sonucu görmüyorsunuz ve kaydırmanız gerekiyor .

Bu tür durumlarda her zaman Heredoc kullanıyorum (Veya PHP> = 5.3 kullanıyorsanız Nowdoc) : yazması kolay, okunması kolay, süper uzun satırlara gerek yok, ...

Örneğin :

$var = 'World';
$str = <<<MARKER
this is a very
long string that
doesn't require
horizontal scrolling, 
and interpolates variables :
Hello, $var!
MARKER;

Sadece bir şey: son işaretleyici (ve ;ondan sonra ' ') satırındaki tek şey olmalı: önce veya sonra boşluk / sekme yok!

Elbette, HEREDOC'u kullanabilirsiniz, ancak kod okunabilirliği söz konusu olduğunda, dizeyi birden çok satıra sarıp ilk örnekten daha iyi değildir.

Çok satırlı dizenizin iyi görünmesini ve kodunuzla iyi akmasını istiyorsanız, dizeleri bir araya getirmenizi tavsiye ederim:

$text = "Hello, {$vars->name},\r\n\r\n"
    . "The second line starts two lines below.\r\n"
    . ".. Third line... etc";

Bu, HEREDOC veya çok satırlı bir dizeden biraz daha yavaş olabilir, ancak kodunuzun girintisiyle iyi akar ve okumayı kolaylaştırır.

Javascript için bu yöntemi biraz daha seviyorum ama henüz belirtilmemiş çünkü buraya dahil etmeye değer görünüyor.

$var = "pizza";

$text = implode(" ", [
  "I love me some",
  "really large",
  $var,
  "pies.",
]);

// "I love me some really large pizza pies."

Daha küçük şeyler için, sıralı dizelerle karşılaştırıldığında dizi yapılarıyla çalışmanın daha kolay olduğunu düşünüyorum.

İlgili: implode vs concat performans

Buna inanan

"abc\n" . "def\n"

çok satırlı dize yanlış. Bu, çok satırlı bir dize değil, birleştirme operatörüne sahip iki dize. Bu tür birleştirilmiş dizeler, örneğin önceden tanımlanmış dizilerin anahtarları olarak kullanılamaz. Ne yazık ki php şeklinde gerçek çok satırlı dizeleri sunmuyor

"abc\n"
"def\n"

yalnızca HEREDOCve NOWDOCsözdizimi, ki bu şablonlar için daha uygundur, çünkü iç içe kod girintisi bu sözdizimi tarafından kesilir.

Ayrıca kullanabilirsiniz:

<?php
ob_start();
echo "some text";
echo "\n";

// you can also use: 
?> 
some text can be also written here, or maybe HTML:
<div>whatever<\div>
<?php
echo "you can basically write whatever you want";
// and then: 
$long_text = ob_get_clean();

Yeni satırlar ve satır başı ile ilgili sorunuzla ilgili olarak:

Platformlar arası uyumluluk sorunlarını çözeceği için önceden tanımlanmış global sabit PHP_EOL kullanmanızı öneririm .

Bu soru daha önce SO üzerinde gündeme getirilmiştir ve " PHP sabiti PHP_EOL ne zaman kullanılır? "

ama yeni hatlar ve satır başı ile olan anlaşma nedir? Fark ne? \ N \ n \ r \ r veya \ n \ r eşdeğeri mi? Çizgiler arasında çizgi boşluğu oluştururken hangisini kullanmalıyım?

Buradaki hiç kimse bu soruya gerçekten cevap vermedi, bu yüzden buradayım.

\r 'taşıma-dönüşü' temsil eder

\n 'satır beslemeyi' temsil eder

Onların asıl nedeni daktilolara geri dönüyor. Siz yazarken, 'satır başı' yavaşça, karakter karakter, daktilonun sağında kayar. Eğer hattın sonuna geldiğimde sen olur taşıyıcıyı döndürmek ve sonra yeni bir satıra gidin . Yeni satıra gitmek için satırları tür yazara besleyen bir kolu çevirirsiniz . Bu nedenle, bu eylemlere, birleşik dönüş hattı besleme denir . Kelimenin tam anlamıyla:

Bir satır besleme, bir \nsonraki satıra geçme anlamına gelir.

Bir satır başı,, \rimleci satırın başına taşıma anlamına gelir.

Sonuçta Hello\n\nWorldekranda aşağıdaki çıktı ile sonuçlanmalıdır:

Hello

     World

Nerede olduğu gibi aşağıdaki çıktı ileHello\r\rWorld sonuçlanmalıdır .

Sadece 2 karakteri birleştirirken \r\n, ortak satırda bilgi sahibi olursunuz. IE Hello\r\nWorldşunlarla sonuçlanmalıdır:

Hello
World

Ve tabii ki \n\raynı görsel çıktı ile sonuçlanacaktır \r\n.

Başlangıçta bilgisayarlar aldı \rve \nkelimenin tam anlamıyla. Ancak bu günlerde taşıma iadesi desteği seyrek. Genellikle her sistemde \nkendi başınıza kullanmaktan kurtulabilirsiniz . Asla işletim sistemine bağlı değildir, ancak çıktıyı ne görüntülediğinize bağlıdır.

Yine de \r\nher zaman mümkün olan her yerde kullanmanızı tavsiye ederim!