Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/dangdungcntt/object-mapper
An ObjectMapper for PHP (inspired by ObjectMapper in java)
https://github.com/dangdungcntt/object-mapper
object-mapper php
Last synced: about 1 month ago
JSON representation
An ObjectMapper for PHP (inspired by ObjectMapper in java)
- Host: GitHub
- URL: https://github.com/dangdungcntt/object-mapper
- Owner: dangdungcntt
- License: mit
- Created: 2020-12-03T02:26:14.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2021-10-18T03:18:42.000Z (about 3 years ago)
- Last Synced: 2024-11-18T09:51:42.561Z (about 2 months ago)
- Topics: object-mapper, php
- Language: PHP
- Homepage:
- Size: 118 KB
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: .github/SECURITY.md
Awesome Lists containing this project
README
# Object mapper
[](https://packagist.org/packages/nddcoder/object-mapper)
[](https://github.com/nddcoder/object-mapper/actions?query=workflow%3Arun-tests+branch%3Amaster)
[](https://packagist.org/packages/nddcoder/object-mapper)
An `ObjectMapper` for PHP (inspired by ObjectMapper in java)
## Installation
You can install the package via composer:
```bash
composer require nddcoder/object-mapper
```
## Usage
``` php
use Nddcoder\ObjectMapper\ObjectMapper;
class User {
public string $name;
public string $email;
}
$objectMapper = new ObjectMapper();
//Make object from json string
$jsonString = '{"name":"Dung Nguyen Dang","email":"[email protected]"}';
$user = $objectMapper->readValue($jsonString, User::class);
echo $user->name; //Dung Nguyen Dang
echo $user->email; //[email protected]
//You can pass an associative array to readValue function instead of string
$user = $objectMapper->readValue(['name' => 'Dung Nguyen Dang', 'email' => '[email protected]'], User::class);
//Convert object to json string
$userJsonString = $objectMapper->writeValueAsString($user);
echo $userJsonString; //{"name":"Dung Nguyen Dang","email":"[email protected]"}
```
#### Array Property
Use `ArrayProperty` Attribute to specific type of array item
``` php
use Nddcoder\ObjectMapper\ObjectMapper;
use Nddcoder\ObjectMapper\Attributes\ArrayProperty;
class Comment {
public string $from;
public string $content;
}
class Post {
public string $title;
#[ArrayProperty(Comment::class)]
public array $comments;
}
$objectMapper = new ObjectMapper();
//Make object from json string
$jsonString = '{"title":"New Blog Post","comments":[{"from":"nddcoder","content":"Hello"}]}';
$post = $objectMapper->readValue($jsonString, Post::class);
echo $post->title; //New Blog Post
print_r($post->comments);
/*
Array
(
[0] => Comment Object
(
[from] => nddcoder
[content] => Hello
)
)
*/
```
#### Custom JSON property
You can use `JsonProperty('')` to custom name for a property
``` php
use Nddcoder\ObjectMapper\ObjectMapper;
use Nddcoder\ObjectMapper\Attributes\JsonProperty;
class Post {
public string $title;
#[JsonProperty('body')]
public string $content;
}
$objectMapper = new ObjectMapper();
//Make object from json string
$jsonString = '{"title":"New Blog Post","body":"Blog body here"}';
$post = $objectMapper->readValue($jsonString, Post::class);
echo $post->title; //New Blog Post
echo $post->content; //Blog body here
//Convert object to json string
$postJsonString = $objectMapper->writeValueAsString($post);
echo $postJsonString; //{"title":"New Blog Post","body":"Blog body here"}
```
#### Custom behavior via getter/setter
You can define getter/setter to custom behavior when get/set a property
``` php
use Nddcoder\ObjectMapper\ObjectMapper;
use Nddcoder\ObjectMapper\Attributes\JsonProperty;
class User {
public string $username;
protected string $password;
public function setUsername(string $username): void
{
$this->username = strtolower($username);
}
public function getPassword(): ?string
{
return null;
}
public function setPassword(string $password): void
{
$this->password = md5($password);
}
}
$objectMapper = new ObjectMapper();
//Make object from json string
$jsonString = '{"username":"NDDCoder","password":"secret"}';
$user = $objectMapper->readValue($jsonString, User::class);
print_r($user);
/*
User Object
(
[username] => nddcoder
[password:protected] => 5ebe2294ecd0e0f08eab7690d2a6ee69
)
*/
//Convert object to json string
$userJsonString = $objectMapper->writeValueAsString($user);
echo $userJsonString; //{"username":"nddcoder","password":null}
```
#### Encoders
By default, package included 2 encoders for `DateTimeInterface` and `stdClass`
You can create your custom encoder by implements `ObjectMapperEncoder` interface
```php
use MongoDB\BSON\ObjectId;
use Nddcoder\ObjectMapper\Contracts\ObjectMapperEncoder;
class ObjectIdEncoder implements ObjectMapperEncoder
{
public function encode(mixed $value, ?string $className = null): string
{
return (string) $value;
}
public function decode(mixed $value, ?string $className = null): mixed
{
return new ObjectId($value);
}
}
```
and then using `ObjectMapper::addGlobalEncoder` to add it as global or `addEncoder` to add it to current instance only
```php
ObjectMapper::addGlobalEncoder(ObjectId::class, ObjectIdEncoder::class);
$objectMapper->addEncoder(ObjectId::class, ObjectIdEncoder::class);
```
You can remove global encoder using `ObjectMapper::removeGlobalEncoder` or `removeEncoder` to remove encoder from current instance only
```php
ObjectMapper::removeGlobalEncoder(ObjectId::class);
$objectMapper->removeEncoder(ObjectId::class);
```
## Testing
``` bash
composer test
```
## Changelog
Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently.
## Contributing
Please see [CONTRIBUTING](.github/CONTRIBUTING.md) for details.
## Security Vulnerabilities
Please review [our security policy](../../security/policy) on how to report security vulnerabilities.
## Credits
- [Dung Nguyen Dang](https://github.com/dangdungcntt)
- [All Contributors](../../contributors)
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.