tebe tbreuss

PHP Style Guide

All rules and guidelines in this document apply to PHP files unless otherwise noted. References to PHP/HTML files can be interpreted as files that primarily contain HTML, but use PHP for templating purposes.

The keywords "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in RFC 2119.

Most sections are broken up into two parts:

Overview of all rules with a quick example
Each rule called out with examples of do's and don'ts

People

`:bowtie:`	😄 `:smile:`	😆 `:laughing:`
😊 `:blush:`	😃 `:smiley:`	☺️ `:relaxed:`
😏 `:smirk:`	😍 `:heart_eyes:`	😘 `:kissing_heart:`
😚 `:kissing_closed_eyes:`	😳 `:flushed:`	😌 `:relieved:`
😆 `:satisfied:`	😁 `:grin:`	😉 `:wink:`
😜 `:stuck_out_tongue_winking_eye:`	😝 `:stuck_out_tongue_closed_eyes:`	😀 `:grinning:`
😗 `:kissing:`	😙 `:kissing_smiling_eyes:`	😛 `:stuck_out_tongue:`

	<?php

	class WsseHeader
	{
	const NS_WSSE = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-wssecurity-secext-1.0.xsd';
	const NS_WSSEPSWD = 'http://docs.oasis-open.org/wss/2004/01/oasis-200401-wss-username-token-profile-1.0#PasswordText';

	public function build($username, $password)
	{
	$header = sprintf(

	<?php
	/**
	*
	* Code was adapted from SitePoint
	* http://www.sitepoint.com/forums/showthread.php?697857-Copy-mysql-table-from-one-server-to-another-through-php&s=b5b25e09ff44749d2e49e0d7c1640fd8&p=4680578&viewfull=1#post4680578
	*
	*/

	// Prevent script from timing out
	set_time_limit(0);

	# ---------------------------------------------------------------------------
	#
	# Description: This file holds all my BASH configurations and aliases
	#
	# Sections:
	# 1. Environment Configuration
	# 2. Make Terminal Better (remapping defaults and adding functionality)
	# 3. File and Folder Management
	# 4. Searching
	# 5. Process Management

	<?php
	// using generators (yield) to recursively read files from a source path
	// more: http://www.php.net/manual/en/language.generators.php

	foreach (readFileSubDir('~/testdir') as $fileItem) {
	echo($fileItem . "\n");
	}


	function readFileSubDir($scanDir) {

	<!DOCTYPE html>
	<html>
	<head>
	<meta charset="utf-8">
	<title>Building a router</title>
	<script>
	// Put John's template engine code here...

	(function () {
	// A hash to store our routes:

	<?xml version="1.0" encoding="UTF-8"?>
	<project name="Composer Targets" default="build">

	<property name="builddir" value="${basedir}/build"/>
	<property name="composer" value="${builddir}/composer.phar"/>

	<target name="php-check">
	<condition property="php" value="php">
	<not>
	<isset property="${php}"/>

	/**
	* [ description]
	* @param {string} tpl the template
	* @param {literal\|function} obj a literal for substitution or a function that will
	* return the substitution given as parameter a string
	* @param {string} start optional- the opening placeholder delimitator (%)
	* @param {string} end optional- the closing placeholder delimitator (%)
	* @param {string} fb optional- a fallback value in case an element is not found
	* @return {string} the resulting string with replaced values
	*/

	# Makefile
	#
	# Converts Markdown to other formats (HTML, PDF, DOCX, RTF, ODT, EPUB) using Pandoc
	# <http://johnmacfarlane.net/pandoc/>
	#
	# Run "make" (or "make all") to convert to all other formats
	#
	# Run "make clean" to delete converted files

	# Convert all files in this directory that have a .md suffix