PHPLOC(1)

📦
version 7.0.2 · 2 versions
, in ubuntu jammy, ubuntu noble

✨ NAME ✨

phploc — it's the PHPLOC command line interface, bestie 💅 (yes, this is the phploc(1) page, user commands section, we're fancy like that)

🦋 SYNOPSIS 🦋

phploc [options] <directory>

🌸 DESCRIPTION 🌸

okay so basically you point phploc at a <directory> and it does its little analysis thing. but the real tea is in the options, and they come in three lil flavour groups. let's get into it 🫶

🎀 Options for selecting files 🎀

  • --suffix <suffix> — include files with names ending in <suffix> in the analysis. the default is .php, and lowkey you can give this one multiple times if you're feeling extra.
  • --exclude <path> — exclude files that have <path> anywhere in their path from the analysis. also can be given multiple times, no cap.

🔥 Options for analysing files 🔥

  • --count-tests — count PHPUnit test case classes and test methods. it's giving coverage-adjacent main character energy ✨

👑 Options for report generation 👑

  • --log-csv <file> — write results in CSV format to <file>.
  • --log-json <file> — write results in JSON format to <file>.
  • --log-xml <file> — write results in XML format to <file>.
not me keeping every single flag, default, and file path exactly as it was — the facts stay iconic, only the vibe got a glow-up 💖

this page is from phploc 7.0.2, dated January 2022. go forth and analyse, queen 🌈💅

📦 where this page comes from