Merge pull request skrz#13 from jakubkulhan/feature-fields

Fields - composite set of fields/properties
Sanasport · Feb 18, 2016 · ff8af1b · ff8af1b
2 parents e57de97 + b108edf
commit ff8af1b
Show file tree

Hide file tree

Showing 48 changed files with 1,090 additions and 61 deletions.
diff --git a/README.md b/README.md
@@ -8,7 +8,7 @@
 
 ## Requirements
 
-`Skrz\Meta` requires PHP `>= 5.3.0` and Symfony `>= 2.7.0`.
+`Skrz\Meta` requires PHP `>= 5.4.0` and Symfony `>= 2.7.0`.
 
 ## Installation
 
@@ -166,6 +166,40 @@ var_export($someCategory->name === "Some category");
 // TRUE
 ```
 
+### Fields
+
+- Fields represent set of symbolic field paths.
+- They are composite (fields can have sub-fields).
+- Fields can be supplied as `$filter` parameters in `to*()` methods.
+
+```php
+use Skrz\API\Category;
+use Skrz\API\Meta\CategoryMeta;
+use Skrz\Meta\Fields\Fields;
+
+$parentCategory = new Category();
+$parentCategory->name = "The parent category";
+$parentCategory->slug = "parent-category";
+
+$childCategory = new Category();
+$childCategory->name = "The child category";
+$childCategory->slug = "child-category";
+$childCategory->parentCategory = $parentCategory;
+
+
+var_export(CategoryMeta::toArray($childCategory, null, Fields::fromString("name,parentCategory{name}")));
+// array(
+//     "name" => "The child category",
+//     "parentCategory" => array(
+//         "name" => "The parent category",
+//     ),
+// )
+```
+
+Fields are inspired by:
+
+- [Facebook Graph API's `?fields=...` query parameter](https://developers.facebook.com/docs/graph-api/using-graph-api#fields)
+- [Google Protocol Buffers' `FieldMask`](https://github.com/google/protobuf/blob/master/src/google/protobuf/field_mask.proto) (and its [JSON serialization](https://developers.google.com/protocol-buffers/docs/proto3#json))
 
 ### Annotations
 

diff --git a/bin/generate-reflection.php b/bin/generate-reflection.php
@@ -185,6 +185,8 @@ public function aMethod($aParameter = AClass::A_CONSTANT, AnInterface $anotherPa
 			$method->getName() !== "getStaticProperties" &&
 			$method->getName() !== "isCloneable" &&
 			$method->getName() !== "isVariadic" &&
+			$method->getName() !== "getType" && // TODO: PHP 7
+			$method->getName() !== "isAnonymous" && // TODO: PHP 7
 //			$method->getName() !== "getDefaultProperties" &&
 			(strncmp($method->getName(), "get", 3) === 0 || ($is = (strncmp($method->getName(), "is", 2) === 0))) &&
 			($method->getNumberOfParameters() === 0 || $method->getName() === "getProperties" || $method->getName() === "getMethods")

diff --git a/composer.json b/composer.json
@@ -10,11 +10,11 @@
     }
   ],
   "require": {
-    "php": ">=5.3",
+    "php": ">=5.4",
     "doctrine/annotations": "~1.2",
     "nette/php-generator": "~2.3",
-    "symfony/finder": "~2.7",
-    "symfony/console": "~2.7"
+    "symfony/finder": "~2.7|~3.0",
+    "symfony/console": "~2.7|~3.0"
   },
   "require-dev": {
     "phpunit/phpunit": "~4.6"

diff --git a/gen-src/Google/Protobuf/Compiler/CodeGeneratorResponse/Meta/FileMeta.php b/gen-src/Google/Protobuf/Compiler/CodeGeneratorResponse/Meta/FileMeta.php
@@ -250,7 +250,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Compiler/Meta/CodeGeneratorRequestMeta.php b/gen-src/Google/Protobuf/Compiler/Meta/CodeGeneratorRequestMeta.php
@@ -260,7 +260,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Compiler/Meta/CodeGeneratorResponseMeta.php b/gen-src/Google/Protobuf/Compiler/Meta/CodeGeneratorResponseMeta.php
@@ -233,7 +233,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/DescriptorProto/Meta/ExtensionRangeMeta.php b/gen-src/Google/Protobuf/DescriptorProto/Meta/ExtensionRangeMeta.php
@@ -210,7 +210,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/DescriptorProto/Meta/ReservedRangeMeta.php b/gen-src/Google/Protobuf/DescriptorProto/Meta/ReservedRangeMeta.php
@@ -210,7 +210,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/DescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/DescriptorProtoMeta.php
@@ -438,7 +438,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/EnumDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/EnumDescriptorProtoMeta.php
@@ -253,7 +253,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/EnumOptionsMeta.php b/gen-src/Google/Protobuf/Meta/EnumOptionsMeta.php
@@ -236,7 +236,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/EnumValueDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/EnumValueDescriptorProtoMeta.php
@@ -240,7 +240,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/EnumValueOptionsMeta.php b/gen-src/Google/Protobuf/Meta/EnumValueOptionsMeta.php
@@ -223,7 +223,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/FieldDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/FieldDescriptorProtoMeta.php
@@ -367,7 +367,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/FieldOptionsMeta.php b/gen-src/Google/Protobuf/Meta/FieldOptionsMeta.php
@@ -288,7 +288,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/FileDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/FileDescriptorProtoMeta.php
@@ -459,7 +459,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/FileDescriptorSetMeta.php b/gen-src/Google/Protobuf/Meta/FileDescriptorSetMeta.php
@@ -210,7 +210,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/FileOptionsMeta.php b/gen-src/Google/Protobuf/Meta/FileOptionsMeta.php
@@ -450,7 +450,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/MessageOptionsMeta.php b/gen-src/Google/Protobuf/Meta/MessageOptionsMeta.php
@@ -262,7 +262,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/MethodDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/MethodDescriptorProtoMeta.php
@@ -297,7 +297,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/MethodOptionsMeta.php b/gen-src/Google/Protobuf/Meta/MethodOptionsMeta.php
@@ -223,7 +223,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/OneofDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/OneofDescriptorProtoMeta.php
@@ -206,7 +206,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/ServiceDescriptorProtoMeta.php b/gen-src/Google/Protobuf/Meta/ServiceDescriptorProtoMeta.php
@@ -253,7 +253,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/ServiceOptionsMeta.php b/gen-src/Google/Protobuf/Meta/ServiceOptionsMeta.php
@@ -223,7 +223,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/SourceCodeInfoMeta.php b/gen-src/Google/Protobuf/Meta/SourceCodeInfoMeta.php
@@ -211,7 +211,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/Meta/UninterpretedOptionMeta.php b/gen-src/Google/Protobuf/Meta/UninterpretedOptionMeta.php
@@ -323,7 +323,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/SourceCodeInfo/Meta/LocationMeta.php b/gen-src/Google/Protobuf/SourceCodeInfo/Meta/LocationMeta.php
@@ -311,7 +311,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Google/Protobuf/UninterpretedOption/Meta/NamePartMeta.php b/gen-src/Google/Protobuf/UninterpretedOption/Meta/NamePartMeta.php
@@ -219,7 +219,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Skrz/Meta/Fixtures/Protobuf/ClassWithEmbeddedMessageProperty/Meta/EmbeddedMeta.php b/gen-src/Skrz/Meta/Fixtures/Protobuf/ClassWithEmbeddedMessageProperty/Meta/EmbeddedMeta.php
@@ -185,7 +185,7 @@ public static function fromArray($input, $group = NULL, $object = NULL)
 	 *
 	 * @return array
 	 */
-	public static function toArray($object, $group = NULL, array $filter = NULL)
+	public static function toArray($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -275,7 +275,7 @@ public static function fromObject($input, $group = NULL, $object = NULL)
 	 *
 	 * @return object
 	 */
-	public static function toObject($object, $group = NULL, array $filter = NULL)
+	public static function toObject($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -393,7 +393,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Skrz/Meta/Fixtures/Protobuf/Meta/ClassWithEmbeddedMessagePropertyMeta.php b/gen-src/Skrz/Meta/Fixtures/Protobuf/Meta/ClassWithEmbeddedMessagePropertyMeta.php
@@ -186,7 +186,7 @@ public static function fromArray($input, $group = NULL, $object = NULL)
 	 *
 	 * @return array
 	 */
-	public static function toArray($object, $group = NULL, array $filter = NULL)
+	public static function toArray($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -276,7 +276,7 @@ public static function fromObject($input, $group = NULL, $object = NULL)
 	 *
 	 * @return object
 	 */
-	public static function toObject($object, $group = NULL, array $filter = NULL)
+	public static function toObject($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -393,7 +393,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';
 

diff --git a/gen-src/Skrz/Meta/Fixtures/Protobuf/Meta/ClassWithFixed64PropertyMeta.php b/gen-src/Skrz/Meta/Fixtures/Protobuf/Meta/ClassWithFixed64PropertyMeta.php
@@ -185,7 +185,7 @@ public static function fromArray($input, $group = NULL, $object = NULL)
 	 *
 	 * @return array
 	 */
-	public static function toArray($object, $group = NULL, array $filter = NULL)
+	public static function toArray($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -275,7 +275,7 @@ public static function fromObject($input, $group = NULL, $object = NULL)
 	 *
 	 * @return object
 	 */
-	public static function toObject($object, $group = NULL, array $filter = NULL)
+	public static function toObject($object, $group = NULL, $filter = NULL)
 	{
 		if ($object === null) {
 			return null;
@@ -391,7 +391,7 @@ public static function fromProtobuf($input, $object = NULL, &$start = 0, $end =
 	 *
 	 * @return string
 	 */
-	public static function toProtobuf($object, array $filter = NULL)
+	public static function toProtobuf($object, $filter = NULL)
 	{
 		$output = '';