/** * {@inheritdoc} */ protected function renderEntity(ReflectionEntity $entity) { if (!$entity instanceof DocumentSchema) { throw new DocumenterException("Unsupported entity type."); } $element = parent::renderEntity($entity); //Invalid methods if (!empty($entity->getFields()['_id'])) { $element->property('_id', '\\MongoId')->setAccess(AbstractElement::ACCESS_PUBLIC); } //Element Document must have defined create method $element->method('create', ['@param array|\\Traversable $fields', '@return ' . $entity->getShortName()], ['fields'])->setStatic(true)->parameter('fields')->setOptional(true, []); //Document has collection, let's clarify static methods if (!empty($entity->getCollection())) { $parent = $entity->getName(); $return = $entity->getShortName(); if ($entity->getParent(true) != $entity) { //Document parent (related to same collection) $parent = $entity->getParent(true)->getName(); $return = $entity->getShortName() . '|\\' . $parent; } $find = $this->helper('collection', $parent) . '|' . $this->helper('cursor', $parent) . '|\\' . $parent . '[]'; //Static collection methods $element->method('find', ['@param array $query', '@return ' . $find], ['query'])->setStatic(true)->parameter('query')->setOptional(true, [])->setType('array'); $findOne = $element->method('findOne', ['@param array $query', '@param array $sortBy', '@return ' . $return . '|null'], ['query', 'sortBy'])->setStatic(true); $findOne->parameter('query')->setOptional(true, [])->setType('array'); $findOne->parameter('sortBy')->setOptional(true, [])->setType('array'); $element->method('findByPK', ['@param mixed $mongoID', '@return ' . $return . '|null'], ['mongoID'])->setStatic(true); } //Composition (we only need to handle MANY compositions) foreach ($entity->getCompositions() as $name => $composition) { if ($composition['type'] == ODM::CMP_ONE) { continue; } //We are going to create helper compositor class $class = $composition['class']; $element->property($name, '@var ' . $this->helper('compositor', $class) . '|\\' . $class . '[]'); $element->method('get' . ucfirst($name))->setComment('@return ' . $this->helper('compositor', $class) . '|\\' . $class . '[]'); } //Aggregations foreach ($entity->getAggregations() as $name => $aggregation) { $aggregated = $this->builder->document($aggregation['class']); $parent = $aggregated->getParent(true)->getName(); if ($aggregation['type'] == Document::ONE) { //Simple ONE aggregation $element->method($name, ['@return \\' . $parent]); } else { $find = $this->helper('collection', $parent) . '|' . $this->helper('cursor', $parent) . '|\\' . $parent . '[]'; $element->method($name, ['@param array $query', '@return ' . $find], ['query'])->parameter('query')->setOptional(true, [])->setType('array'); } } return $element; }
/** * Get default value for composition. * * @param string $field * @param mixed $default Casted default value. * @return mixed */ private function compositionDefaults($field, $default) { $composition = $this->getCompositions()[$field]; if ($composition['type'] == ODM::CMP_MANY) { if (!empty($default) && $default !== []) { throw new SchemaException("Default value of {$this}.{$field} is not compatible with document composition."); } return []; } if (empty($default)) { return $this->builder->document($composition['class'])->getDefaults(); } return $default; }