AzaPhpGen
1.0.0
Anizoptera CMF PHP -Codegenerierung (Dump, Serialisierung) Komponente.
https://github.com/anizoptera/azaphpgen
Ermöglicht, komplexe Arrays, Objekte, Verschluss und grundlegende Datentypen als PHP -Code abzugeben. Zum Teil kann dies als eine Art Serialisierung bezeichnet werden. Und Sie können Ihren abgeladenen PHP -Code nach Belieben anpassen.
Es ist sehr nützlich für die Codekompilierung (normalerweise zu Zwischenspuren).
Merkmale:
Vorteile gegenüber var_export() :
var_export unterstützt keine Dumping von Verschlüssen;var_export unterstützt nur Objekte mit __set_state -Funktion. Azaphpgen unterstützt alle serialisierbaren Objekte;iterator_to_array );var_export einen sehr hässlichen Code, der umständlich zu verwenden ist und leicht beschädigt werden kann.var_export Code, der im Namespace nicht ausgewertet werden kann.IPhpGenerable -Schnittstellen ablegen.var_export gibt es nie aus :)Die empfohlene Möglichkeit zur Installation von Azaphpgen ist über Komponist. Sie können Paketinformationen auf Packagist sehen.
{
"require" : {
"aza/phpgen" : " ~1.0 "
}
}Sie können Beispiele/Beispiel.php verwenden, um alle Beispiele auszuführen.
// Get singleton instance of PhpGen (fast and simple variant)
$ phpGen = PhpGen:: instance ();
// Integer
echo $ phpGen -> getCode ( 123456789 ) . PHP_EOL ; // 123456789;
// String (binary strings are supported as well)
echo $ phpGen -> getCode ( ' some string ' . ' example ' ) . PHP_EOL ; // "some string example";
// Float without trailing semicolon
echo $ phpGen -> getCodeNoTail ( 12.345 ) . PHP_EOL ; // 12.345
// Simple serializable objects
$ var = new stdClass ();
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ; // unserialize("O:8:"stdClass":0:{}");
// Another object example
$ var = new DateTime ( ' 2013-02-23 00:49:36 ' , new DateTimeZone ( ' UTC ' ));
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ; // unserialize("O:8:"DateTime":3:{s:4:"date";s:19:"2013-02-23 00:49:36";s:13:"timezone_type";i:3;s:8:"timezone";s:3:"UTC";}"); // AzaPhpGen will use short array syntax if possible by default (PHP >= 5.4)
echo $ phpGen -> getCode ( array (
true , false , null
)) . PHP_EOL ;
/*
[
true,
false,
null,
];
*/
// Build code without formatting
echo $ phpGen -> getCodeNoFormat ( array (
true , false , null
)) . PHP_EOL ;
/*
[true,false,null];
*/
// Complex array (some sort of config for example)
$ array = array (
' key1 ' => ' value ' ,
' long_key ' => ' value ' ,
' array ' => array (
' short_value '
),
' array2 ' => array (
' very very very very very very very very very very very very long value '
),
' other ' ,
123456789
);
echo $ phpGen -> getCode ( $ array ) . PHP_EOL ;
/*
[
"key1" => "value",
"long_key" => "value",
"array" => ["short_value"],
"array2" => [
"very very very very very very very very very very very very long value",
],
0 => "other",
1 => 123456789,
];
*/
// And wothout formatting
echo $ phpGen -> getCodeNoFormat ( $ array ) . PHP_EOL ;
/*
["key1"=>"value","long_key"=>"value","array"=>["short_value"],"array2"=>["very very very very very very very very very very very very long value"],0=>"other",1=>123456789];
*/ Azaphpgen behandeln alle durchlaufbaren Objekte als Arrays (mit iterator_to_array).
$ var = new SplFixedArray ( 3 );
$ var [ 0 ] = ' a ' ;
$ var [ 1 ] = ' b ' ;
echo $ phpGen -> getCodeNoFormat ( $ var ) . PHP_EOL ; // ["a","b",null]; WARNUNG: Schließungen werden so abgeladen, wie es ist. So werden komplexe Schließungen nicht unterstützt:
$this variablen Verwendung; $ closure = function ( $ a , $ b ) {
return round ( $ a , $ b ) . " example tn" ;
};
echo $ phpGen -> getCode ( $ closure ) . PHP_EOL ;
/*
function($a, $b) {
return round($a, $b) . "exampletn";
};
*/
echo $ phpGen -> getCode ( array ( ' key ' => $ closure )) . PHP_EOL ;
/*
[
"key" => function($a, $b) {
return round($a, $b) . "exampletn";
},
];
*/ Sie können das Dumping Ihrer Klassen anpassen, indem Sie die IPhpGenerable -Schnittstelle implementieren.
class ExampleCustomCode implements IPhpGenerable
{
public function generateCode ()
{
return ' 32434 + 5678 ' ;
}
}
$ var = new ExampleCustomCode ();
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ; // 32434 + 5678;
echo $ phpGen -> getCode ( array ( $ var )) . PHP_EOL ; // [32434 + 5678]; Für die einfachste Varint der IPhpGenerable -Schnittstellen -Verwendungen können Sie eine gebündelte Klasse - CustomCode verwenden. Es nimmt nur den erforderlichen Code als Konstruktorargument.
$ var = new CustomCode ( ' "some code" . PHP_EOL ' );
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ; // "some code" . PHP_EOL;
echo $ phpGen -> getCode ( array ( $ var )) . PHP_EOL ; // ["some code" . PHP_EOL]; Zweite Varint der resultierenden Codeanpassung - Verwendung definierter Handler (Hooks) für die Klassen. Auf diese Weise können Sie die Müllkippe einer möglichen Klasse anpassen!
// Set custom handler for DateTime type
$ phpGen -> addCustomHandler ( ' DateTime ' , function ( $ data ) use ( $ phpGen ) {
/** @var $data DateTime */
return $ phpGen -> getCodeNoTail (
$ data -> format ( " Y-m-dO " )
);
});
// Build code
$ var = new DateTime ( ' 2013-02-23 00:49:36 ' , new DateTimeZone ( ' UTC ' ));
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ; // "2013-02-23+0000"; Azaphpgen hat viele Optionen. Daher ist es sehr einfach, Ihren resultierenden Code für Ihre besonderen Bedürfnisse zu konfigurieren (z. B. Codestil). Sie können alle verfügbaren Optionen im Code von PhpGen -Klasse sehen.
// Disable short array syntax and use 6 spaces for indentation
$ phpGen -> shortArraySyntax = false ;
$ phpGen -> useSpaces = true ;
$ phpGen -> tabLength = 6 ;
$ var = array ( array ( array ( 23 => ' example ' )));
echo $ phpGen -> getCode ( $ var ) . PHP_EOL ;
/*
array(
array(
array(
23 => "example",
),
),
);
*/ Die Tests befinden sich im Tests Ordner und erreichen 100% Code-Deckung. Um sie auszuführen, brauchen Sie Phpunit. Beispiel:
$ phpunit --configuration phpunit.xml.dist
Oder mit Deckungsbericht:
$ phpunit --configuration phpunit.xml.dist --coverage-html code_coverage/
Azaphpgen ist Teil von Anizoptera CMF, geschrieben von Amal Samally (Amal.Amally bei gmail.com) und dem Azagroup -Team.
Unter der MIT -Lizenz veröffentlicht.
