capwelton / libapp

programs/Set/AppCustomFieldSet.php

<?php

// -------------------------------------------------------------------------
// OVIDENTIA http://www.ovidentia.org
// Ovidentia is free software; you can redistribute it and/or modify
// it under the terms of the GNU General Public License as published by
// the Free Software Foundation; either version 2, or (at your option)
// any later version.
//
// This program is distributed in the hope that it will be useful, but
// WITHOUT ANY WARRANTY; without even the implied warranty of
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
// See the GNU General Public License for more details.
//
// You should have received a copy of the GNU General Public License
// along with this program; if not, write to the Free Software
// Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307,
// USA.
// -------------------------------------------------------------------------
/**
 * @license http://opensource.org/licenses/gpl-license.php GNU General Public License (GPL)
 * @copyright Copyright (c) 2022 by SI4YOU ({@link https://www.siforyou.com})
 */
namespace Capwelton\LibApp\Set;

use bab_functionality;

$test = bab_functionality::get("LibOrm");
use Capwelton\LibApp\Func_App;
use Capwelton\LibApp\Exceptions\AppSaveException;
use function Capwelton\LibOrm\ORM_StringField;

The function Capwelton\LibOrm\ORM_StringField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_TextField;

The function Capwelton\LibOrm\ORM_TextField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_EnumField;

The function Capwelton\LibOrm\ORM_EnumField was not found. Maybe you did not declare it correctly or list all dependencies?

use function Capwelton\LibOrm\ORM_BoolField;

The function Capwelton\LibOrm\ORM_BoolField was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\LibOrm\ORMRecord;

The type Capwelton\LibOrm\ORMRecord was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\LibOrm\Criteria\ORMCriteria;

The type Capwelton\LibOrm\Criteria\ORMCriteria was not found. Maybe you did not declare it correctly or list all dependencies?

use Capwelton\LibApp\Set\AppCustomField;

/**
 * @property ORM_StringField $name
 * @property ORM_StringField $fieldname
 * @property ORM_TextField $description
 * @property ORM_EnumField $object
 * @property ORM_EnumField $fieldtype
 * @property ORM_TextField $enumvalues
 * @property ORM_BoolField $mandatory
 *
 * @method app_CustomField get(mixed $criteria)
 * @method app_CustomField request(mixed $criteria)
 * @method app_CustomField[] select(\ORM_Criteria $criteria = null)
 * @method app_CustomField newRecord()
 * @method Func_App App()
 */
class AppCustomFieldSet extends AppTraceableRecordSet
{
    
    /**
     * @param Func_App $App
     */
    public function __construct(Func_App $App = null)
    {
        parent::__construct($App);

It seems like $App can also be of type null; however, parameter $App of Capwelton\LibApp\Set\AppTraceableRecordSet::__construct() does only seem to accept Capwelton\LibApp\Func_App, maybe add an additional type check?

        $this->setTableName("app_customfield");
        
        $this->setDescription('Custom field');
        
        $this->setPrimaryKey('id');
        
        $this->addFields(
            ORM_StringField('name')->setDescription('Field label'), 
            ORM_StringField('fieldname')->setDescription('Name of field used in table, not modifiable'), 
            ORM_TextField('description')->setDescription('Description'), 
            ORM_EnumField('object', $this->getObjects())->setDescription('Applies to'), 
            ORM_EnumField('fieldtype', $this->getFieldTypes())->setDescription('Field type'), 
            ORM_TextField('enumvalues')->setDescription('serialized array of values for enum fields'), 
            ORM_BoolField('mandatory')->setDescription('Mandatory'), 
            ORM_StringField('section')->setDescription($App->translate('Section')), 

The method translate() does not exist on null.

            ORM_BoolField('importable')->setOutputOptions($App->translate('No'), $App->translate('Yes'))->setDescription($App->translate('Importable')), 
            ORM_BoolField('searchable')->setOutputOptions($App->translate('No'), $App->translate('Yes'))->setDescription($App->translate('Searchable')), 
            ORM_BoolField('visible')->setOutputOptions($App->translate('No'), $App->translate('Yes'))->setDescription($App->translate('Column in list'))
        );
        
        if($App->onlineShop){

The property onlineShop does not exist on Capwelton\LibApp\Func_App. Since you implemented __get, consider adding a @property annotation.

            $this->addFields(ORM_BoolField('visible_in_shop'));
        }
    }
    
    public function save(ORMRecord $record, $noTrace = false)
    {
        if(! $record->fieldname){
            $record->fieldname = $this->getFieldName($record->name);
        }
        
        return parent::save($record, $noTrace);
    }
    
    /**
     * Get a field name from a custom field name
     *
     * @param string $name
     * @throws AppSaveException
     * @return string
     */
    public function getFieldName($name)
    {
        // create the field name automatically
        $name = bab_removeDiacritics($name);
        $name = preg_replace('/[^a-zA-Z0-9]+/', '', $name);
        $name = mb_strtolower($name);
        
        if(empty($name)){
            throw new AppSaveException($this->App()->translate('The name is mandatory'));
        }
        
        return '_' . $name;
    }
    
    /**
     * List of objects where custom fields are applicable.
     *
     * @return string[]
     */
    public function getObjects()
    {
        $App = $this->App();
        
        $arr = array();
        
        if(isset($App->Article)){

The property Article does not exist on Capwelton\LibApp\Func_App. Since you implemented __get, consider adding a @property annotation.

            $arr['Article'] = $App->translate('Products database');
        }
        
        return $arr;
    }
    
    /**
     * list of ORM fields to use for a custom field
     */
    public function getFieldTypes()
    {
        $App = $this->App();
        
        return array(
            'String' => $App->translate('Line edit'),
            'Text' => $App->translate('Text edit'),
            'Bool' => $App->translate('Checkbox'),
            'Int' => $App->translate('Integer number'),
            'Decimal' => $App->translate('Decimal number'),
            'Date' => $App->translate('Date'),
            'DateTime' => $App->translate('Date and time'),
            'Time' => $App->translate('Time'),
            'Enum' => $App->translate('Selection list'),
            'Set' => $App->translate('Multi-selection list'),
            'Url' => $App->translate('Url'),
            'Email' => $App->translate('Email address'),
            'File' => $App->translate('File')
        );
    }
    
    /**
     * {@inheritdoc}
     * @see AppRecordSet::isCreatable()
     */
    public function isCreatable()
    {
        return true;
    }
    
    /**
     * @return ORMCriteria
     */
    public function isReadable()
    {
        return $this->all();
    }
    
    /**
     * @return ORMCriteria
     */
    public function isUpdatable()
    {
        return $this->all();
    }
    
    /**
     * @return ORMCriteria
     */
    public function isDeletable()
    {
        return $this->isUpdatable();
    }
}