class.arViewFields.php

Go to the documentation of this file.

<?php
include_once('./Services/ActiveRecord/Fields/class.arField.php');
include_once('./Services/ActiveRecord/Views/class.arViewField.php');

class arViewFields {

        const FIELD_CLASS = 'arViewField';
        protected $fields = array();
        protected $fields_for_display = NULL;
        protected $active_record = NULL;
        protected $txt_prefix = "";
        protected $created_by_field = NULL;
        protected $modified_by_field = NULL;
        protected $creation_date_field = NULL;
        protected $modification_date_field = NULL;


        public function __construct(ActiveRecord $ar) {
                $this->active_record = $ar;
                $this->generateFields();
        }


        protected function generateFields() {
                $fields = $this->active_record->getArFieldList()->getFields();
                foreach ($fields as $standard_field) {
                        $current_class = get_called_class();
                        $field_class = $current_class::FIELD_CLASS;
                        $field = $field_class::castFromFieldToViewField($standard_field);
                        $this->addField($field);
                }

                return true;
        }


        public function addField(arViewField $field) {
                $this->fields[$field->getName()] = $field;
        }


        public function getFields() {
                return $this->fields;
        }


        public function getPrimaryField() {
                return $this->getField(arFieldCache::getPrimaryFieldName($this->active_record));
        }


        public function sortFields() {
                uasort($this->fields, function (arViewField $field_a, arViewField $field_b) {
                        return $field_a->getPosition() > $field_b->getPosition();
                });
        }


        public function getFieldsForDisplay() {
                if (!$this->fields_for_display && $this->getFields()) {
                        foreach ($this->getFields() as $field) {
                                if (($field->getVisible() || $field->getPrimary())) {
                                        $this->fields_for_display[] = $field;
                                }
                        }
                }

                return $this->fields_for_display;
        }


        public function getField($field_name) {
                return $this->fields[$field_name];
        }


        public function setTxtPrefix($txt_prefix) {
                $this->txt_prefix = $txt_prefix;
                foreach ($this->getFields() as $field) {
                        $field->setTxtPrefix($txt_prefix);
                }
        }


        public function getTxtPrefix() {
                return $this->txt_prefix;
        }


        public function setCreatedByField($created_by_field) {
                $created_by_field->setIsCreatedByField(true);
                $this->created_by_field = $created_by_field;
        }


        public function getCreatedByField() {
                if (!$this->created_by_field) {
                        foreach ($this->getFields() as $field) {
                                if ($field->getIsCreatedByField()) {
                                        return $this->created_by_field = $field;
                                }
                        }
                }

                return $this->created_by_field;
        }


        public function setCreationDateField($creation_date_field) {
                $creation_date_field->setIsCreationDateField(true);
                $this->creation_date_field = $creation_date_field;
        }


        public function getCreationDateField() {
                if (!$this->creation_date_field) {
                        foreach ($this->getFields() as $field) {
                                if ($field->getIsCreationDateField()) {
                                        return $this->creation_date_field = $field;
                                }
                        }
                }

                return $this->creation_date_field;
        }


        public function setModificationDateField($modification_date_field) {
                $modification_date_field->setIsModificationDateField(true);
                $this->modification_date_field = $modification_date_field;
        }


        public function getModificationDateField() {
                if (!$this->modification_date_field) {
                        foreach ($this->getFields() as $field) {
                                if ($field->getIsModificationDateField()) {
                                        return $this->modification_date_field = $field;
                                }
                        }
                }

                return $this->modification_date_field;
        }


        public function setModifiedByField($modified_by_field) {
                $modified_by_field->setIsModifiedByField(true);
                $this->modified_by_field = $modified_by_field;
        }


        public function getModifiedByField() {
                if (!$this->modified_by_field) {
                        foreach ($this->getFields() as $field) {
                                if ($field->getIsModifiedByField()) {
                                        return $this->modified_by_field = $field;
                                }
                        }
                }

                return $this->modified_by_field;
        }
}