how to use phpdocument使用方法

環境準備Prepare
By yum
$ sudo yum -y install php-pear php-xml
$ sudo pear channel-discover pear.phpdoc.org
$ sudo pear install -a phpdoc/phpDocumentor
$ sudo yum install php-intl
$ sudo yum install graphviz (option)
By composer
$ sudo php composer.phar require phpdocumentor/phpdocumentor


php.ini設定
date.timezone = 'Asia/Tokyo'

生成
cd /path/to/root/of/project
phpdoc -c app/phpdoc.xml --template="clean"
phpdoc -d /path/to/source/folder
phpdoc -t /path/to/file

-c: 設定ファイルを利用すること
default config: phpdoc.dist.xml

phpdoc template:list
* abstract
* checkstyle
* clean
* new-black
* old-ocean
* responsive
* responsive-twig
* xml
* zend

Sample of phpdoc.xml

	<?xml version="1.0" encoding="UTF-8" ?>
	<phpdocumentor>
	<parser>
	<target>www/phpdoc</target>
	<encoding>utf8</encoding>
	</parser>
	<transformer>
	<target>www/phpdoc</target>
	</transformer>
	<files>
	<file>src/Controller/*</file>
	<file>tests/TestCase/Controller/*</file>
	<file>tests/TestCase/View/*</file>
	<!-- ignore -->
	<ignore>src/Controller/Component/*</ignore>
	</files>
	<transformations>
	<template name="clean"/>
	<template name="checkstyle"/>
	</transformations>
	</phpdocumentor>

view raw phpdoc.xml hosted with ❤ by GitHub

blogspot: data for title

site name + post title
<data:blog.pageTitle/>

post title
<data:view.title.escaped/>

Mock assert function | PHPUnit

mixed is ...

メソッド	意味
assertNull($var)	$varがNULLである
assertEquals($val1, $val2)	$val1が$val2と等しい
assertSame($val1, $val2)	$val1と$val2が型も含めて等しい
assertInternalType($type, $val)	$valの型名が$typeである

number is ...

メソッド	意味
assertGreaterThan($expect, $var)	$expect < $var が成立する
assertGreaterThanOrEqual($expect, $var)	$expect <= $var が成立する
assertLessThan($expect, $var)	$expect > $var が成立する
assertLessThanOrEqual($expect, $var)	$expect >= $var が成立する

string is ...

メソッド	意味
assertJsonStringEqualsJsonString($str1, $str2)	$str1と$str2がjsonとして等しい
assertRegExp($ptn, $str)	$strが正規表現$ptnにマッチする

boolean is ...

メソッド	意味
assertTrue($var)	$varがTRUEである
assertFalse($var)	$varがFALSEである

array is ...

メソッド	意味
assertArrayHasKey($key, $array)	配列$arrayにキー$keyが存在する
assertContains($val, $array)	配列$arrayに値$valが存在する
assertContainsOnly($type, $array)	配列$arrayの値の型がすべて$typeである
assertCount($count, $array)	配列$arrayの値の数が$countである
assertEmpty($array)	配列$arrayが空である

object/class is ...

メソッド	意味
assertObjectHasAttribute($attr, $object)	オブジェクト$objectにプロパティ変数$attrが存在する
assertClassHasAttribute($attr, $class)	クラス名$classにプロパティ変数$attrが存在する
assertClassHasStaticAttribute($attr, $class)	クラス名$classに静的プロパティ変数$attrが存在する
assertInstanceOf($class, $instance)	$instanceがクラス名$classのインスタンスである

file is ...

メソッド	意味
assertFileExists($file)	$fileが存在する
assertFileEquals($file1, $file2)	$file1と$file2の内容が等しい
assertJsonFileEqualsJsonFile($file1, $file2)	$file1と$file2の内容がjsonとして等しい
assertJsonStringEqualsJsonFile($file1, $json)	$file1の内容と$jsonがjsonとして等しい