Edit docs

Author: Myks92

docs/readme.md

@@ -4,59 +4,18 @@ Using Value Objects will avoid duplication of code, as well as make your propert
 ## Usage
 Value Objects this library are divided into several logical groups:
 
+- [String](usage/string.md)
+- [Number](usage/number.md)
+- [Enum](usage/enum.md)
 - [Web](usage/web.md)
 - [Identity](usage/identity.md)
 - [Security](usage/security.md)
 - [Person](usage/person.md)
 - [Geography](usage/geography.md)
 - [Money](usage/money.md)
 - [Payment](usage/payment.md)
-- [Enum](usage/enum.md)
 
 This separation is only a structuring of the Value Objects in library. You can use these objects as you discretion.
 
 ### Creating own Value Objects
-This library has only popular value objects. But you can always create your own objects. Abstract classes are available in this library (`StringLiteral`,` Integer`, `Enum`), with which you can implement your own value objects, for example:
-
-For string type
-```php
-use Myks92\ValueObjects\String\StringLiteral;
-
-final class MyTitle extends StringLiteral
-{
-}
-$myTitle = new MyTitle('Title');
-$myTitle->getValue(); //Title
-```
-
-For integer type
-```php
-use Myks92\ValueObjects\Number\Integer;
-
-final class MyAge extends Integer
-{
-}
-
-$myAge = new MyAge(12);
-$myAge->getValue(); //12
-```
-
-For option type
-```php
-use Myks92\ValueObjects\Enum\Enum;
-/**
- * @method static MyStatus wait()
- * @method static MyStatus active()
- * @method static MyStatus blocked()
- */
-final class MyStatus extends Enum
-{
-    private const WAIT = 'wait';
-    private const ACTIVE = 'active';
-    private const BLOCKED = 'blocked';
-}
-
-$myStatus = MyStatus::wait()->getValue(); //wait
-$myStatus = MyStatus::active()->getValue(); //active
-$myStatus = MyStatus::blocked()->getValue(); //blocked
-```
+This library has only popular value objects. But you can always create your own and complement exists objects, extends them.

docs/usage/enum.md

@@ -10,6 +10,7 @@ This groups Value Objects use for any options, e.g status, role, gender or anoth
 Static methods:
 * `toArray()` method Returns all possible values as an array (constant name in key, constant value in value)
 
+### Example Status VO
 ```php
 use Myks92\ValueObjects\Enum\Enum;
 
@@ -74,4 +75,88 @@ class Status extends Enum
     private const ACTIVE = 'active';
     private const BLOCKED = 'blocked';
 }
+```
+
+### Example Gender VO
+```php
+use Myks92\ValueObjects\Enum\Enum;
+
+/**
+ * @method static Gender male()
+ * @method static Gender female()
+ * @method static Gender other()
+ */
+class Gender extends Enum
+{
+    /**
+     * @var string value for male
+     */
+    public const MALE = 'male';
+    /**
+     * @var string value for female
+     */
+    public const FEMALE = 'female';
+    /**
+     * @var string value for other
+     */
+    public const OTHER = 'other';
+
+    /**
+     * Create male
+     *
+     * @return static
+     */
+    public static function male(): self
+    {
+        return new self(self::MALE);
+    }
+
+    /**
+     * Create female
+     *
+     * @return static
+     */
+    public static function female(): self
+    {
+        return new self(self::FEMALE);
+    }
+
+    /**
+     * Create other
+     *
+     * @return static
+     */
+    public static function other(): self
+    {
+        return new self(self::OTHER);
+    }
+
+    /**
+     * @return bool
+     */
+    public function isMale(): bool
+    {
+        return $this->getValue() === self::MALE;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isFemale(): bool
+    {
+        return $this->getValue() === self::FEMALE;
+    }
+
+    /**
+     * @return bool
+     */
+    public function isOther(): bool
+    {
+        return $this->getValue() === self::OTHER;
+    }
+}
+// Static method:
+$gender = Gender::male();
+$gender = Gender::female();
+$gender = Gender::other();
 ```

docs/usage/number.md

@@ -0,0 +1,31 @@
+# Number
+This groups Value Objects use for any string type
+
+## Integer
+### Available Methods
+* `__construct()` The constructor create the value
+* `__toString()` You can `echo $myValue`, it will display the string value.
+* `getValue()` Returns the current value
+* `isEqualTo()` Tests whether instances are equal (returns `true` if values are equal, `false` otherwise)
+
+### Example
+```php
+use Myks92\ValueObjects\Number\Integer;
+
+final class MyAge extends Integer
+{
+}
+
+final class MyAge2 extends Integer
+{
+}
+
+$myAge = new MyAge(12);
+$myAge->getValue(); //12
+
+$myAge2 = new MyAge2(14);
+$myAge2->getValue(); //14
+$myAge2->isEqualTo($myAge); //false
+
+echo $myAge; //'12'
+```

docs/usage/string.md

@@ -0,0 +1,20 @@
+# String
+This groups Value Objects use for any string type
+
+## String
+### Available Methods
+* `__construct()` The constructor checks that the value not empty
+* `__toString()` You can `echo $myValue`, it will display the string value.
+* `getValue()` Returns the current value
+* `isEqualTo()` Tests whether instances are equal (returns `true` if values are equal, `false` otherwise)
+
+### Example
+```php
+use Myks92\ValueObjects\String\StringLiteral;
+
+final class MyTitle extends StringLiteral
+{
+}
+$myTitle = new MyTitle('Title');
+$myTitle->getValue(); //Title
+```