samsoncms / api

     * @throws ParentEntityNotFound

     * @throws \samsoncms\api\exception\AdditionalFieldTypeNotFound

     */

    public function analyze($type, $filter = null)

    {

        $metadataCollection = [];

        // Iterate all structures, parents first

        foreach ($this->entityNavigations($type) as $structureRow) {

            // If filter is the function and filter return false then skip this structure

            if (is_callable($filter) && (false === $filter($structureRow))) {

                continue;

            }

            // Fill in entity metadata

            $metadata = new Metadata($type);

            // Get CapsCase and transliterated entity name

            $metadata->entity = $this->entityName($structureRow['Name']);

            $metadata->entityClassName = $this->fullEntityName($metadata->entity);

            $metadata->entityRealName = $structureRow['Name'];

            $metadata->entityID = $structureRow['StructureID'];

            // Try to find entity parent identifier for building future relations

            $metadata->parentID = $this->entityParent($structureRow['StructureID']);

            // Generate application from current entity

            $metadata->generateApplication = $structureRow['applicationGenerate'];

            // Show application from current entity

            $metadata->showApplication = $structureRow['applicationOutput'];

            // Icon for application from current entity

            $metadata->iconApplication = $structureRow['applicationIcon'];

            // Render application on main page

            $metadata->renderMainApplication = $structureRow['applicationRenderMain'];

            // TODO: Add multiple parent and fetching their data in a loop

            // Set pointer to parent entity

            if (null !== $metadata->parentID && $metadata->type !== Metadata::TYPE_TABLE) {

                if (array_key_exists($metadata->parentID, $this->metadata)) {

                    $metadata->parent = $this->metadata[$metadata->parentID];

                    // Add all parent metadata to current object

                    $metadata->defaultValues = $metadata->parent->defaultValues;

                    $metadata->realNames = $metadata->parent->realNames;

                    $metadata->allFieldIDs = $metadata->parent->allFieldIDs;

                    $metadata->allFieldNames = $metadata->parent->allFieldNames;

                    $metadata->allFieldValueColumns = $metadata->parent->allFieldValueColumns;

                    $metadata->allFieldTypes = $metadata->parent->allFieldTypes;

                    $metadata->fieldDescriptions = $metadata->parent->fieldDescriptions;

                    $metadata->localizedFieldIDs = $metadata->parent->localizedFieldIDs;

                    $metadata->notLocalizedFieldIDs = $metadata->parent->notLocalizedFieldIDs;

                } else {

                    throw new ParentEntityNotFound($metadata->parentID);

                }

            }

            // Get old AR collections of metadata

            $metadata->arSelect = \samson\activerecord\material::$_sql_select;

            $metadata->arAttributes = \samson\activerecord\material::$_attributes;

            $metadata->arMap = \samson\activerecord\material::$_map;

            $metadata->arFrom = \samson\activerecord\material::$_sql_from;

            $metadata->arGroup = \samson\activerecord\material::$_own_group;

            $metadata->arRelationAlias = \samson\activerecord\material::$_relation_alias;

            $metadata->arRelationType = \samson\activerecord\material::$_relation_type;

            $metadata->arRelations = \samson\activerecord\material::$_relations;

            // Add SamsonCMS material needed data

            $metadata->arSelect['this'] = ' STRAIGHT_JOIN ' . $metadata->arSelect['this'];

            $metadata->arFrom['this'] .= "\n" .

                'LEFT JOIN ' . dbMySQLConnector::$prefix . 'materialfield as _mf

            ON ' . dbMySQLConnector::$prefix . 'material.MaterialID = _mf.MaterialID';

            $metadata->arGroup[] = dbMySQLConnector::$prefix . 'material.MaterialID';

            // Iterate entity fields

            foreach ($this->navigationFields($structureRow['StructureID']) as $fieldID => $fieldRow) {

                // Get camelCase and transliterated field name

                $fieldName = $this->fieldName($fieldRow['Name']);

                // TODO: Set default for additional field storing type accordingly.

                // Store field metadata

                $metadata->realNames[$fieldRow['Name']] = $fieldName;

                $metadata->allFieldIDs[$fieldID] = $fieldName;

                $metadata->allFieldNames[$fieldName] = $fieldID;

                $metadata->allFieldValueColumns[$fieldID] = Field::valueColumn($fieldRow[Field::F_TYPE]);

                $metadata->allFieldTypes[$fieldID] = Field::phpType($fieldRow['Type']);

                $metadata->allFieldCmsTypes[$fieldID] = (int)$fieldRow['Type'];

                $metadata->fieldDescriptions[$fieldID] = $fieldRow['Description'] . ', ' . $fieldRow['Name'] . '#' . $fieldID;

                $metadata->fieldRawDescriptions[$fieldID] = $fieldRow['Description'];

                // Fill localization fields collections

                if ($fieldRow[Field::F_LOCALIZED] == 1) {

                    $metadata->localizedFieldIDs[$fieldID] = $fieldName;

                } else {

                    $metadata->notLocalizedFieldIDs[$fieldID] = $fieldName;

                }

                // Fill all fields which should display in list

                if ($fieldRow['showInList'] == 1) {

                    $metadata->showFieldsInList[] = $fieldID;

                }

                // Save custom type

                $metadata->customTypeFields[$fieldID] = $fieldRow['customTypeName'];

                // Set old AR collections of metadata

                $metadata->arAttributes[$fieldName] = $fieldName;

                $metadata->arMap[$fieldName] = dbMySQLConnector::$prefix . 'material.' . $fieldName;

                // Add additional field column to entity query

                $equal = '((_mf.FieldID = ' . $fieldID . ')&&(_mf.locale ' . ($fieldRow['local'] ? ' = "@locale"' : 'IS NULL') . '))';

                $metadata->arSelect['this'] .= "\n\t\t" . ',MAX(IF(' . $equal . ', _mf.`' . Field::valueColumn($fieldRow['Type']) . '`, NULL)) as `' . $fieldName . '`';

            }

            // Get id of child navigation

            foreach ($this->entityChildNavigation($structureRow['StructureID']) as $childNavigation) {

                $metadata->childNavigationIDs[] = $childNavigation['StructureID'];

            }

            // Store metadata by entity identifier

            $metadataCollection[$structureRow['StructureID']] = $metadata;

        }

        return $metadataCollection;

    }

    /** @return array Get collection of navigation objects */

    protected function entityNavigations($type = 0)

     * @throws ParentEntityNotFound

     * @throws \samsoncms\api\exception\AdditionalFieldTypeNotFound

     */

    public function fillMetadata($type, $filter = null)

    {

        $metadataCollection = [];

        // Iterate all structures, parents first

        foreach ($this->entityNavigations($type) as $structureRow) {

            // If filter is the function and filter return false then skip this structure

            if (is_callable($filter) && (false === $filter($structureRow))) {

                continue;

            }

            // Fill in entity metadata

            $metadata = new Metadata($type);

            // Get CapsCase and transliterated entity name

            $metadata->entity = $this->entityName($structureRow['Name']);

            $metadata->entityClassName = $this->fullEntityName($metadata->entity);

            $metadata->entityRealName = $structureRow['Name'];

            $metadata->entityID = $structureRow['StructureID'];

            // Try to find entity parent identifier for building future relations

            $metadata->parentID = $this->entityParent($structureRow['StructureID']);

            // Generate application from current entity

            $metadata->generateApplication = $structureRow['applicationGenerate'];

            // Show application from current entity

            $metadata->showApplication = $structureRow['applicationOutput'];

            // Icon for application from current entity

            $metadata->iconApplication = $structureRow['applicationIcon'];

            // Render application on main page

            $metadata->renderMainApplication = $structureRow['applicationRenderMain'];

            // TODO: Add multiple parent and fetching their data in a loop

            // Set pointer to parent entity

            if (null !== $metadata->parentID && $metadata->type !== Metadata::TYPE_TABLE) {

                if (array_key_exists($metadata->parentID, $this->metadata)) {

                    $metadata->parent = $this->metadata[$metadata->parentID];

                    // Add all parent metadata to current object

                    $metadata->defaultValues = $metadata->parent->defaultValues;

                    $metadata->realNames = $metadata->parent->realNames;

                    $metadata->allFieldIDs = $metadata->parent->allFieldIDs;

                    $metadata->allFieldNames = $metadata->parent->allFieldNames;

                    $metadata->allFieldValueColumns = $metadata->parent->allFieldValueColumns;

                    $metadata->allFieldTypes = $metadata->parent->allFieldTypes;

                    $metadata->fieldDescriptions = $metadata->parent->fieldDescriptions;

                    $metadata->localizedFieldIDs = $metadata->parent->localizedFieldIDs;

                    $metadata->notLocalizedFieldIDs = $metadata->parent->notLocalizedFieldIDs;

                } else {

                    throw new ParentEntityNotFound($metadata->parentID);

                }

            }

            // Get old AR collections of metadata

            $metadata->arSelect = \samson\activerecord\material::$_sql_select;

            $metadata->arAttributes = \samson\activerecord\material::$_attributes;

            $metadata->arMap = \samson\activerecord\material::$_map;

            $metadata->arFrom = \samson\activerecord\material::$_sql_from;

            $metadata->arGroup = \samson\activerecord\material::$_own_group;

            $metadata->arRelationAlias = \samson\activerecord\material::$_relation_alias;

            $metadata->arRelationType = \samson\activerecord\material::$_relation_type;

            $metadata->arRelations = \samson\activerecord\material::$_relations;

            // Add SamsonCMS material needed data

            $metadata->arSelect['this'] = ' STRAIGHT_JOIN ' . $metadata->arSelect['this'];

            $metadata->arFrom['this'] .= "\n" .

                'LEFT JOIN ' . dbMySQLConnector::$prefix . 'materialfield as _mf

            ON ' . dbMySQLConnector::$prefix . 'material.MaterialID = _mf.MaterialID';

            $metadata->arGroup[] = dbMySQLConnector::$prefix . 'material.MaterialID';

            // Iterate entity fields

            foreach ($this->navigationFields($structureRow['StructureID']) as $fieldID => $fieldRow) {

                // Get camelCase and transliterated field name

                $fieldName = $this->fieldName($fieldRow['Name']);

                // TODO: Set default for additional field storing type accordingly.

                // Store field metadata

                $metadata->realNames[$fieldRow['Name']] = $fieldName;

                $metadata->allFieldIDs[$fieldID] = $fieldName;

                $metadata->allFieldNames[$fieldName] = $fieldID;

                $metadata->allFieldValueColumns[$fieldID] = Field::valueColumn($fieldRow[Field::F_TYPE]);

                $metadata->allFieldTypes[$fieldID] = Field::phpType($fieldRow['Type']);

                $metadata->allFieldCmsTypes[$fieldID] = (int)$fieldRow['Type'];

                $metadata->fieldDescriptions[$fieldID] = $fieldRow['Description'] . ', ' . $fieldRow['Name'] . '#' . $fieldID;

                $metadata->fieldRawDescriptions[$fieldID] = $fieldRow['Description'];

                // Fill localization fields collections

                if ($fieldRow[Field::F_LOCALIZED] == 1) {

                    $metadata->localizedFieldIDs[$fieldID] = $fieldName;

                } else {

                    $metadata->notLocalizedFieldIDs[$fieldID] = $fieldName;

                }

                // Fill all fields which should display in list

                if ($fieldRow['showInList'] == 1) {

                    $metadata->showFieldsInList[] = $fieldID;

                }

                // Save custom type

                $metadata->customTypeFields[$fieldID] = $fieldRow['customTypeName'];

                // Set old AR collections of metadata

                $metadata->arAttributes[$fieldName] = $fieldName;

                $metadata->arMap[$fieldName] = dbMySQLConnector::$prefix . 'material.' . $fieldName;

                // Add additional field column to entity query

                $equal = '((_mf.FieldID = ' . $fieldID . ')&&(_mf.locale ' . ($fieldRow['local'] ? ' = "@locale"' : 'IS NULL') . '))';

                $metadata->arSelect['this'] .= "\n\t\t" . ',MAX(IF(' . $equal . ', _mf.`' . Field::valueColumn($fieldRow['Type']) . '`, NULL)) as `' . $fieldName . '`';

            }

            // Get id of child navigation

            foreach ($this->entityChildNavigation($structureRow['StructureID']) as $childNavigation) {

                $metadata->childNavigationIDs[] = $childNavigation['StructureID'];

            }

            // Store metadata by entity identifier

            $metadataCollection[$structureRow['StructureID']] = $metadata;

        }

        return $metadataCollection;

    }

    /** @return array Get collection of navigation objects */

    protected function entityNavigations($type = 0)