init

vendor/yiisoft/yii2-mongodb/src/validators/MongoDateValidator.php

@@ -0,0 +1,84 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\mongodb\validators;
+
+use MongoDB\BSON\UTCDateTime;
+use yii\validators\DateValidator;
+
+/**
+ * MongoDateValidator is an enhanced version of [[DateValidator]], which supports [[\MongoDate]] values.
+ *
+ * Usage example:
+ *
+ * ```php
+ * class Customer extends yii\mongodb\ActiveRecord
+ * {
+ *     ...
+ *     public function rules()
+ *     {
+ *         return [
+ *             ['date', 'yii\mongodb\validators\MongoDateValidator', 'format' => 'MM/dd/yyyy']
+ *         ];
+ *     }
+ * }
+ * ```
+ *
+ * @see DateValidator
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.0.4
+ */
+class MongoDateValidator extends DateValidator
+{
+    /**
+     * @var string the name of the attribute to receive the parsing result as [[\MongoDate]] instance.
+     * When this property is not null and the validation is successful, the named attribute will
+     * receive the parsing result as [[\MongoDate]] instance.
+     *
+     * This can be the same attribute as the one being validated. If this is the case,
+     * the original value will be overwritten with the value after successful validation.
+     */
+    public $mongoDateAttribute;
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validateAttribute($model, $attribute)
+    {
+        $mongoDateAttribute = $this->mongoDateAttribute;
+        if ($this->timestampAttribute === null) {
+            $this->timestampAttribute = $mongoDateAttribute;
+        }
+
+        $originalErrorCount = count($model->getErrors($attribute));
+        parent::validateAttribute($model, $attribute);
+        $afterValidateErrorCount = count($model->getErrors($attribute));
+
+        if ($originalErrorCount === $afterValidateErrorCount) {
+            if ($this->mongoDateAttribute !== null) {
+                $timestamp = $model->{$this->timestampAttribute};
+                $mongoDateAttributeValue = $model->{$this->mongoDateAttribute};
+                // ensure "dirty attributes" support :
+                if (!($mongoDateAttributeValue instanceof UTCDateTime) || $mongoDateAttributeValue->sec !== $timestamp) {
+                    $model->{$this->mongoDateAttribute} = new UTCDateTime($timestamp * 1000);
+                }
+            }
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function parseDateValue($value)
+    {
+        return $value instanceof UTCDateTime
+            ? $value->toDateTime()->getTimestamp()
+            : parent::parseDateValue($value);
+    }
+}

vendor/yiisoft/yii2-mongodb/src/validators/MongoIdValidator.php

@@ -0,0 +1,115 @@
+<?php
+/**
+ * @link http://www.yiiframework.com/
+ * @copyright Copyright (c) 2008 Yii Software LLC
+ * @license http://www.yiiframework.com/license/
+ */
+
+namespace yii\mongodb\validators;
+
+use MongoDB\BSON\ObjectID;
+use yii\base\InvalidConfigException;
+use yii\validators\Validator;
+use Yii;
+
+/**
+ * MongoIdValidator verifies if the attribute is a valid Mongo ID.
+ * Attribute will be considered as valid, if it is an instance of [[\MongoId]] or a its string value.
+ *
+ * Usage example:
+ *
+ * ```php
+ * class Customer extends yii\mongodb\ActiveRecord
+ * {
+ *     ...
+ *     public function rules()
+ *     {
+ *         return [
+ *             ['_id', 'yii\mongodb\validators\MongoIdValidator']
+ *         ];
+ *     }
+ * }
+ * ```
+ *
+ * This validator may also serve as a filter, allowing conversion of Mongo ID value either to the plain string
+ * or to [[\MongoId]] instance. You can enable this feature via [[forceFormat]].
+ *
+ * @author Paul Klimov <klimov.paul@gmail.com>
+ * @since 2.0.4
+ */
+class MongoIdValidator extends Validator
+{
+    /**
+     * @var string|null specifies the format, which validated attribute value should be converted to
+     * in case validation was successful.
+     * valid values are:
+     * - 'string' - enforce value converted to plain string.
+     * - 'object' - enforce value converted to [[\MongoId]] instance.
+     *   If not set - no conversion will be performed, leaving attribute value intact.
+     */
+    public $forceFormat;
+
+
+    /**
+     * {@inheritdoc}
+     */
+    public function init()
+    {
+        parent::init();
+        if ($this->message === null) {
+            $this->message = Yii::t('yii', '{attribute} is invalid.');
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    public function validateAttribute($model, $attribute)
+    {
+        $value = $model->$attribute;
+        $mongoId = $this->parseMongoId($value);
+        if (is_object($mongoId)) {
+            if ($this->forceFormat !== null) {
+                switch ($this->forceFormat) {
+                    case 'string' : {
+                        $model->$attribute = $mongoId->__toString();
+                        break;
+                    }
+                    case 'object' : {
+                        $model->$attribute = $mongoId;
+                        break;
+                    }
+                    default: {
+                        throw new InvalidConfigException("Unrecognized format '{$this->forceFormat}'");
+                    }
+                }
+            }
+        } else {
+            $this->addError($model, $attribute, $this->message, []);
+        }
+    }
+
+    /**
+     * {@inheritdoc}
+     */
+    protected function validateValue($value)
+    {
+        return is_object($this->parseMongoId($value)) ? null : [$this->message, []];
+    }
+
+    /**
+     * @param mixed $value
+     * @return ObjectID|null
+     */
+    private function parseMongoId($value)
+    {
+        if ($value instanceof ObjectID) {
+            return $value;
+        }
+        try {
+            return new ObjectID($value);
+        } catch (\Exception $e) {
+            return null;
+        }
+    }
+}