capwelton / libapp

programs/Set/AppLinkSet.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 Capwelton\LibApp\Func_App;
use Capwelton\LibOrm\ORMIterator;

The type Capwelton\LibOrm\ORMIterator 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\LibOrm\Criteria\ORMIsCriterion;

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

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?

/**
 * An arbitrary link between two records.
 *
 * @property ORM_StringField $sourceClass
 * @property ORM_StringField $sourceId
 * @property ORM_StringField $targetClass
 * @property ORM_StringField $targetId
 * @property ORM_StringField $type
 * @property ORM_StringField $data
 *
 * @method app_Link get()
 * @method app_Link request()
 * @method app_Link[]|\ORM_Iterator select()
 * @method app_Link newRecord()
 * @method Func_App App()
 */
class AppLinkSet extends AppRecordSet
{
    
    /**
     * @param Func_App $App
     */
    public function __construct(Func_App $App)
    {
        parent::__construct($App);
        
        $App = $this->App();

The assignment to $App is dead and can be removed.

        $this->setTableName("app_link");
        $this->setPrimaryKey('id');
        
        $this->addFields(
            ORM_StringField('sourceClass')->setDescription('Source object class'), 
            ORM_StringField('sourceId')->setDescription('Source object id'), 
            ORM_StringField('targetClass')->setDescription('Target object class'), 
            ORM_StringField('targetId')->setDescription('Target object id'), 
            ORM_StringField('type')->setDescription('Link type'), 
            ORM_StringField('data')->setDescription('Additional data')
        );
    }
    
    /**
     * Link record to $source
     *
     * @param AppRecord $source
     * @param string $linkType
     * @param string $data
     * @return self
     */
    
    /**
     * Create a link from $source to $target with the specified type and optional associated data.
     *
     * @param AppRecord $source
     * @param AppRecord $target
     * @param string $linkType
     * @param string $data
     * @return AppLink
     */
    public function create(AppRecord $source, AppRecord $target, $linkType = '', $data = '')
    {
        $link = $this->newRecord();
        $sourceClass = $source->getClassName();
        if(strpos($sourceClass, '\\')){
            $sourceClass = (new \ReflectionClass($sourceClass))->getShortName();
        }
        $targetClass = $target->getClassName();
        if(strpos($targetClass, '\\')){
            $targetClass = (new \ReflectionClass($targetClass))->getShortName();
        }
        $link->sourceClass = $sourceClass;
        $link->sourceId = $source->id;
        $link->targetClass = $targetClass;
        $link->targetId = $target->id;
        $link->type = $linkType;
        $link->data = $data;
        $link->save();
        
        return $link;
    }
    
    /**
     * @param string $sourceClass
     */
    public function joinSource($sourceClass)
    {
        if(strpos($sourceClass, '\\')){
            $sourceClass = (new \ReflectionClass($sourceClass))->getShortName();
        }
        if(! $this->sourceId instanceof $sourceClass){
            $this->hasOne('sourceId', $sourceClass . 'Set');
            $this->join('sourceId');
        }
    }
    
    /**
     * @param string $targetClass
     */
    public function joinTarget($targetClass = null)
    {
        if(strpos($targetClass, '\\')){

It seems like $targetClass can also be of type null; however, parameter $haystack of strpos() does only seem to accept string, maybe add an additional type check?

            $targetClass = (new \ReflectionClass($targetClass))->getShortName();
        }
        if(! $this->targetId instanceof $targetClass){
            $this->hasOne('targetId', $targetClass . 'Set');
            $this->join('targetId');
        }
    }
    
    /**
     * @param string $recordClass
     * @return ORMIsCriterion
     */
    public function sourceIsA($recordClass)
    {
        if(strpos($recordClass, '\\')){
            $recordClass = (new \ReflectionClass($recordClass))->getShortName();
        }
        return $this->sourceClass->is($recordClass);
    }
    
    /**
     * @param AppRecord $record
     * @return ORMCriteria
     */
    public function sourceIs(AppRecord $record)
    {
        return $this->all($this->sourceId->is($record->id), $this->sourceIsA($record->getClassName()));
    }
    
    /**
     * @param string $recordClass
     * @return ORMIsCriterion
     */
    public function targetIsA($recordClass)
    {
        if(strpos($recordClass, '\\')){
            $recordClass = (new \ReflectionClass($recordClass))->getShortName();
        }
        return $this->targetClass->is($recordClass);
    }
    
    /**
     * @param AppRecord $record
     * @return ORMCriteria
     */
    public function targetIs(AppRecord $record)
    {
        return $this->all($this->targetId->is($record->id), $this->targetIsA($record->getClassName()));
    }
    
    /**
     * @return ORMIterator
     */
    public function selectForSource(AppRecord $object, $targetClass = null, $linkType = null)
    {
        $criteria = $this->sourceIs($object);
        
        
        if(isset($targetClass)){
            if(strpos($targetClass, '\\')){
                $targetClass = (new \ReflectionClass($targetClass))->getShortName();
            }
            $this->joinTarget($targetClass);
            $criteria = $criteria->_AND_($this->targetClass->is($targetClass));
        }
        
        if(isset($linkType)){
            if(is_array($linkType)){
                $criteria = $criteria->_AND_($this->type->in($linkType));
            }
            else{
                $criteria = $criteria->_AND_($this->type->is($linkType));
            }
        }
        
        if(is_a($this->targetId, 'app_TraceableRecordSet')){
            $criteria = $criteria->_AND_($this->targetId->deleted->is(false));
        }
        
        return $this->select($criteria);

The call to Capwelton\LibApp\Set\AppLinkSet::select() has too many arguments starting with $criteria.

The expression return $this->select($criteria) returns the type Capwelton\LibApp\Set\app_Link[]&ORM_Iterator which is incompatible with the documented return type Capwelton\LibOrm\ORMIterator.

    }
    
    /**
     * @return ORMIterator
     */
    public function selectForSources($objects, $targetClass, $linkType = null)
    {
        $sourceClass = null;
        $sourceIds = array();
        
        foreach ($objects as $obj){
            if(is_null($sourceClass)){
                $sourceClass = $obj->getClassName();
            }
            $sourceIds[] = $obj->id;
        }
        $criteria = $this->sourceId->in($sourceIds)->_AND_($this->sourceClass->is($sourceClass));
        
        if(isset($targetClass)){
            if(strpos($targetClass, '\\')){
                $targetClass = (new \ReflectionClass($targetClass))->getShortName();
            }
            $this->joinTarget($targetClass);
            $criteria = $criteria->_AND_($this->targetClass->is($targetClass));
        }
        
        if(isset($linkType)){
            if(is_array($linkType)){
                $criteria = $criteria->_AND_($this->type->in($linkType));
            }
            else{
                $criteria = $criteria->_AND_($this->type->is($linkType));
            }
        }
        return $this->select($criteria);

The call to Capwelton\LibApp\Set\AppLinkSet::select() has too many arguments starting with $criteria.

The expression return $this->select($criteria) returns the type Capwelton\LibApp\Set\app_Link[]&ORM_Iterator which is incompatible with the documented return type Capwelton\LibOrm\ORMIterator.

    }
    
    /**
     * @return ORMIterator
     */
    public function selectForTarget(AppRecord $object, $sourceClass = null, $linkType = null)
    {
        $criteria = $this->targetIs($object);
        
        if(isset($sourceClass)){
            if(strpos($sourceClass, '\\')){
                $sourceClass = (new \ReflectionClass($sourceClass))->getShortName();
            }
            $this->joinSource($sourceClass);
            $criteria = $criteria->_AND_($this->sourceClass->is($sourceClass));
        }
        
        if(isset($linkType)){
            if(is_array($linkType)){
                $criteria = $criteria->_AND_($this->type->in($linkType));
            }
            else{
                $criteria = $criteria->_AND_($this->type->is($linkType));
            }
        }
        
        return $this->select($criteria);

The expression return $this->select($criteria) returns the type Capwelton\LibApp\Set\app_Link[]&ORM_Iterator which is incompatible with the documented return type Capwelton\LibOrm\ORMIterator.

The call to Capwelton\LibApp\Set\AppLinkSet::select() has too many arguments starting with $criteria.

    }
    
    /**
     * @return ORMIterator
     */
    public function selectForTargets($objects, $sourceClass = null, $linkType = null)
    {
        $targetClass = null;
        $targetIds = array();
        
        foreach ($objects as $obj){
            if(is_null($targetClass)){
                $targetClass = $obj->getClassName();
            }
            $targetIds[] = $obj->id;
        }
        $criteria = $this->targetId->in($targetIds)->_AND_($this->targetClass->is($targetClass));
        
        if(isset($sourceClass)){
            if(strpos($sourceClass, '\\')){
                $sourceClass = (new \ReflectionClass($sourceClass))->getShortName();
            }
            $this->joinSource($sourceClass);
            $criteria = $criteria->_AND_($this->sourceClass->is($sourceClass));
        }
        
        if(isset($linkType)){
            if(is_array($linkType)){
                $criteria = $criteria->_AND_($this->type->in($linkType));
            }
            else{
                $criteria = $criteria->_AND_($this->type->is($linkType));
            }
        }
        
        return $this->select($criteria);

The call to Capwelton\LibApp\Set\AppLinkSet::select() has too many arguments starting with $criteria.

The expression return $this->select($criteria) returns the type Capwelton\LibApp\Set\app_Link[]&ORM_Iterator which is incompatible with the documented return type Capwelton\LibOrm\ORMIterator.

    }
    
    /**
     * delete all links to an object
     *
     * @param AppRecord $object
     * @param string $targetClass
     *            if target class is set, links will be deleted only for target classes
     * @param bool $deleteTarget
     *            if set to true, the target will be deleted to
     */
    public function deleteForSource(AppRecord $object, $targetClass = null, $deleteTarget = false, $linkType = null)
    {
        $set = clone $this;
        $App = $object->App();
        
        $criteria = $set->sourceId->is($object->id)->_AND_($set->sourceClass->is($object->getClassName()));
        
        if(null !== $targetClass){
            if(strpos($targetClass, '\\')){
                $targetClass = (new \ReflectionClass($targetClass))->getShortName();
            }
            $criteria = $criteria->_AND_($set->targetClass->is($targetClass));
        }
        if(null !== $linkType){
            $criteria = $criteria->_AND_($set->type->is($linkType));
        }
        
        if($deleteTarget){
            foreach ($set->select($criteria) as $link){

The call to Capwelton\LibApp\Set\AppLinkSet::select() has too many arguments starting with $criteria.

                
                $className = $link->targetClass . 'Set';
                
                // remove prefix
                
                $className = mb_substr($className, 1 + mb_strpos($className, '_'));
                $targetSet = $App->$className();
                
                $targetSet->delete($targetSet->id->is($link->targetId));
            }
        }
        
        return $set->delete($criteria);
    }
    
    /**
     * Deletes links between two objects
     *
     * @param AppRecord $source
     * @param AppRecord $target
     * @param string $linkType
     * @return self
     */
    public function deleteLink($source, $target, $linkType = null)
    {
        $sourceClass = $source->getClassName();
        if(strpos($sourceClass, '\\')){
            $sourceClass = (new \ReflectionClass($sourceClass))->getShortName();
        }
        $targetClass = $target->getClassName();
        if(strpos($targetClass, '\\')){
            $targetClass = (new \ReflectionClass($targetClass))->getShortName();
        }
        $criteria = $this->sourceId->is($source->id)
            ->_AND_($this->sourceClass->is($sourceClass))
            ->_AND_($this->targetId->is($target->id))
            ->_AND_($this->targetClass->is($targetClass));
        if(isset($linkType)){
            if(is_array($linkType)){

The condition is_array($linkType) is always false.

                $criteria = $criteria->_AND_($this->type->in($linkType));
            }
            else{
                $criteria = $criteria->_AND_($this->type->is($linkType));
            }
        }
        
        $this->delete($criteria);
        return $this;
    }
}