Skip to content

Commit 92d76d0

Browse files
committed
optmize readme for object schema
1 parent 19ed8cf commit 92d76d0

1 file changed

Lines changed: 11 additions & 6 deletions

File tree

README.md

Lines changed: 11 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -265,16 +265,21 @@ use Chubbyphp\Parsing\Parser;
265265

266266
$p = new Parser();
267267

268+
// stdClass example
268269
$schema = $p->object(['name' => $p->string()]);
270+
$object = $schema->parse(['name' => 'example']);
269271

270-
// create a new schema based on a existing once
271-
$schema2 = $p->object([...$schema->getFieldToSchema(), 'value' => $p->string()]);
272+
// SampleNamespace\SampleClass example
273+
$schema = $p->object(['name' => $p->string()], SampleNamespace\SampleClass::class);
274+
$object = $schema->parse(['name' => 'example']);
272275

273-
// stdClass object
274-
$data = $schema->parse(['name' => 'example']);
276+
// getFieldToSchema
277+
$schema = $p->object(['name' => $p->string()]);
278+
$extendedSchema = $p->object([...$schema->getFieldToSchema(), 'value' => $p->string()]);
275279

276-
// SampleClass object
277-
$data = $schema->parse(['name' => 'example'], SampleNamespace\SampleClass::class);
280+
// getFieldSchema
281+
$schema = $p->object(['name' => $p->string()]);
282+
$nameSchema = $schema->getFieldSchema('name');
278283

279284
// if the key 'name' does not exist on input, it won't exists on the output
280285
$schema->optional(['name']);

0 commit comments

Comments
 (0)