ilBiblTranslationFactory Class Reference

Class ilBiblTranslationFactory. More...

Inheritance diagram for ilBiblTranslationFactory:

Collaboration diagram for ilBiblTranslationFactory:

Public Member Functions
	__construct (ilBiblFieldFactoryInterface $field_factory)
	ilBiblTranslationFactory constructor. More...
	translate (ilBiblFieldInterface $field)
	translateAttribute (ilBiblAttributeInterface $attribute)
	@inheritDoc More...
	translateAttributeString ($type_id, ilBiblAttributeInterface $attribute)
	@inheritDoc More...
	getFieldFactory ()
	translationExistsForFieldAndUsersLanguage (ilBiblFieldInterface $field)
	@inheritDoc More...
	translationExistsForFieldAndSystemsLanguage (ilBiblFieldInterface $field)
	@inheritDoc More...
	translationExistsForField (ilBiblFieldInterface $field)
	@inheritDoc More...
	getInstanceForFieldAndUsersLanguage (ilBiblFieldInterface $field)
	@inheritDoc More...
	getInstanceForFieldAndSystemsLanguage (ilBiblFieldInterface $field)
	@inheritDoc More...
	findArCreateInstanceForFieldAndlanguage (ilBiblFieldInterface $field, $language_key)
	@inheritDoc More...
	getAllTranslationsForField (ilBiblFieldInterface $field)
	@inheritDoc More...
	getAllTranslationsForFieldAsArray (ilBiblFieldInterface $field)
	@inheritDoc More...
	findById ($id)
	@inheritDoc More...
	deleteById ($id)
	@inheritDoc More...
	translate (ilBiblFieldInterface $field)
	Translates a field in the current users language in tho folowing order: More...
	translateAttribute (ilBiblAttributeInterface $attribute)
	translateAttributeString ($type_id, ilBiblAttributeInterface $attribute)
	getFieldFactory ()
	translationExistsForFieldAndUsersLanguage (ilBiblFieldInterface $field)
	translationExistsForFieldAndSystemsLanguage (ilBiblFieldInterface $field)
	translationExistsForField (ilBiblFieldInterface $field)
	getInstanceForFieldAndUsersLanguage (ilBiblFieldInterface $field)
	getInstanceForFieldAndSystemsLanguage (ilBiblFieldInterface $field)
	findArCreateInstanceForFieldAndlanguage (ilBiblFieldInterface $field, $language_key)
	getAllTranslationsForField (ilBiblFieldInterface $field)
	getAllTranslationsForFieldAsArray (ilBiblFieldInterface $field)
	findById ($id)
	deleteById ($id)

Protected Attributes
	$dic
	$field_factory

Private Member Functions
	translateInCore (ilBiblFieldInterface $field)
	getCollectionOfTranslationsForField (ilBiblFieldInterface $field)

Detailed Description

Class ilBiblTranslationFactory.

Author

Fabian Schmid fs@st.nosp@m.uder.nosp@m.-raim.nosp@m.ann..nosp@m.ch

Definition at line 8 of file class.ilBiblTranslationFactory.php.

Constructor & Destructor Documentation

__construct()

ilBiblTranslationFactory::__construct

(

ilBiblFieldFactoryInterface

$field_factory

)

ilBiblTranslationFactory constructor.

Parameters

\ilBiblFieldFactoryInterface

$field_factory

Definition at line 26 of file class.ilBiblTranslationFactory.php.

    {
        global $DIC;
        $this->dic = $DIC;
        $this->field_factory = $field_factory;
    }

References $DIC, and $field_factory.

Member Function Documentation

deleteById()

ilBiblTranslationFactory::deleteById

(

$id

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 221 of file class.ilBiblTranslationFactory.php.

    {
        self::findById($id)->delete();
 
        return true;
    }

References $id, and findById().

Here is the call graph for this function:

findArCreateInstanceForFieldAndlanguage()

ilBiblTranslationFactory::findArCreateInstanceForFieldAndlanguage	(	ilBiblFieldInterface	$field,
			$language_key
	)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 163 of file class.ilBiblTranslationFactory.php.

    {
        $inst = $this->getCollectionOfTranslationsForField($field)
                     ->where([ "language_key" => $language_key, ])
                     ->get();
 
        if (!$inst) {
            $inst = new ilBiblTranslation();
            $inst->setFieldId($field->getId());
            $inst->setLanguageKey($language_key);
            $inst->create();
        }
 
        return $inst;
    }

References getCollectionOfTranslationsForField(), and ilBiblFieldInterface\getId().

Here is the call graph for this function:

findById()

ilBiblTranslationFactory::findById

(

$id

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 212 of file class.ilBiblTranslationFactory.php.

    {
        return ilBiblTranslation::findOrFail($id);
    }

References $id, and ActiveRecord\findOrFail().

Referenced by deleteById().

Here is the call graph for this function:

Here is the caller graph for this function:

getAllTranslationsForField()

ilBiblTranslationFactory::getAllTranslationsForField

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 183 of file class.ilBiblTranslationFactory.php.

    {
        return $this->getCollectionOfTranslationsForField($field)->get();
    }

References getCollectionOfTranslationsForField().

Here is the call graph for this function:

getAllTranslationsForFieldAsArray()

ilBiblTranslationFactory::getAllTranslationsForFieldAsArray

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 192 of file class.ilBiblTranslationFactory.php.

    {
        return $this->getCollectionOfTranslationsForField($field)->getArray();
    }

References getCollectionOfTranslationsForField().

Here is the call graph for this function:

getCollectionOfTranslationsForField()

ilBiblTranslationFactory::getCollectionOfTranslationsForField ( ilBiblFieldInterface  $field )

private

Parameters

\ilBiblFieldInterface

$field

Returns

\ActiveRecordList

Definition at line 203 of file class.ilBiblTranslationFactory.php.

    {
        return ilBiblTranslation::where([ 'field_id' => $field->getId() ])->orderBy('language_key');
    }

References ilBiblFieldInterface\getId(), and ActiveRecord\where().

Referenced by findArCreateInstanceForFieldAndlanguage(), getAllTranslationsForField(), getAllTranslationsForFieldAsArray(), getInstanceForFieldAndSystemsLanguage(), getInstanceForFieldAndUsersLanguage(), and translationExistsForField().

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldFactory()

ilBiblTranslationFactory::getFieldFactory

(

)

Returns

\ilBiblFieldFactoryInterface

Implements ilBiblTranslationFactoryInterface.

Definition at line 83 of file class.ilBiblTranslationFactory.php.

    {
        return $this->field_factory;
    }

References $field_factory.

Referenced by translateAttributeString(), and translateInCore().

Here is the caller graph for this function:

getInstanceForFieldAndSystemsLanguage()

ilBiblTranslationFactory::getInstanceForFieldAndSystemsLanguage

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 149 of file class.ilBiblTranslationFactory.php.

    {
        global $DIC;
        $lng = $DIC->language()->getDefaultLanguage();
 
        return $this->getCollectionOfTranslationsForField($field)
                    ->where([ "language_key" => $lng, ])
                    ->first();
    }

References $DIC, $lng, and getCollectionOfTranslationsForField().

Referenced by translate(), and translationExistsForFieldAndSystemsLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

getInstanceForFieldAndUsersLanguage()

ilBiblTranslationFactory::getInstanceForFieldAndUsersLanguage

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 136 of file class.ilBiblTranslationFactory.php.

    {
        global $DIC;
 
        return $this->getCollectionOfTranslationsForField($field)
                    ->where([ "language_key" => $DIC->user()->getCurrentLanguage(), ])
                    ->first();
    }

References $DIC, and getCollectionOfTranslationsForField().

Referenced by translate(), and translationExistsForFieldAndUsersLanguage().

Here is the call graph for this function:

Here is the caller graph for this function:

translate()

ilBiblTranslationFactory::translate

(

ilBiblFieldInterface

$field

)

Parameters

\ilBiblFieldInterface

$field

Returns

string

Implements ilBiblTranslationFactoryInterface.

Definition at line 39 of file class.ilBiblTranslationFactory.php.

    {
        if ($this->translationExistsForFieldAndUsersLanguage($field)) {
            return $this->getInstanceForFieldAndUsersLanguage($field)->getTranslation();
        }
        if ($this->translationExistsForFieldAndSystemsLanguage($field)) {
            return $this->getInstanceForFieldAndSystemsLanguage($field)->getTranslation();
        }
 
        $core_translation = $this->translateInCore($field);
        if (strpos($core_translation, "-") !== 0) {
            return $core_translation;
        }
 
        return $field->getIdentifier();
    }

References ilBiblFieldInterface\getIdentifier(), getInstanceForFieldAndSystemsLanguage(), getInstanceForFieldAndUsersLanguage(), translateInCore(), translationExistsForFieldAndSystemsLanguage(), and translationExistsForFieldAndUsersLanguage().

Referenced by translateAttribute(), and translateAttributeString().

Here is the call graph for this function:

Here is the caller graph for this function:

translateAttribute()

ilBiblTranslationFactory::translateAttribute

(

ilBiblAttributeInterface

$attribute

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 60 of file class.ilBiblTranslationFactory.php.

    {
        $field = $this->field_factory->findOrCreateFieldOfAttribute($attribute);
 
        return $this->translate($field);
    }

References translate().

Here is the call graph for this function:

translateAttributeString()

ilBiblTranslationFactory::translateAttributeString	(		$type_id,
		ilBiblAttributeInterface	$attribute
	)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 71 of file class.ilBiblTranslationFactory.php.

    {
        $field = $this->getFieldFactory()
                      ->findOrCreateFieldByTypeAndIdentifier($type_id, $attribute->getIdentifier());
 
        return $this->translate($field);
    }

References getFieldFactory(), and translate().

Here is the call graph for this function:

translateInCore()

ilBiblTranslationFactory::translateInCore ( ilBiblFieldInterface  $field )

private

Parameters

\ilBiblFieldInterface

$field

Returns

string

Definition at line 94 of file class.ilBiblTranslationFactory.php.

    {
        $prefix = $this->getFieldFactory()->getType()->getStringRepresentation();
        $middle = "default";
        $identifier = $field->getIdentifier();
 
        $topic = implode("_", [ $prefix, $middle, $identifier ]);
 
        return $this->dic->language()->txt(strtolower($topic));
    }

References getFieldFactory(), and ilBiblFieldInterface\getIdentifier().

Referenced by translate().

Here is the call graph for this function:

Here is the caller graph for this function:

translationExistsForField()

ilBiblTranslationFactory::translationExistsForField

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 127 of file class.ilBiblTranslationFactory.php.

    {
        return $this->getCollectionOfTranslationsForField($field)->hasSets();
    }

References getCollectionOfTranslationsForField().

Here is the call graph for this function:

translationExistsForFieldAndSystemsLanguage()

ilBiblTranslationFactory::translationExistsForFieldAndSystemsLanguage

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 118 of file class.ilBiblTranslationFactory.php.

    {
        return !is_null($this->getInstanceForFieldAndSystemsLanguage($field));
    }

References getInstanceForFieldAndSystemsLanguage().

Referenced by translate().

Here is the call graph for this function:

Here is the caller graph for this function:

translationExistsForFieldAndUsersLanguage()

ilBiblTranslationFactory::translationExistsForFieldAndUsersLanguage

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

Definition at line 109 of file class.ilBiblTranslationFactory.php.

    {
        return !is_null($this->getInstanceForFieldAndUsersLanguage($field));
    }

References getInstanceForFieldAndUsersLanguage().

Referenced by translate().

Here is the call graph for this function:

Here is the caller graph for this function:

Field Documentation

$dic

ilBiblTranslationFactory::$dic

protected

Definition at line 14 of file class.ilBiblTranslationFactory.php.

$field_factory

ilBiblTranslationFactory::$field_factory

protected

Definition at line 18 of file class.ilBiblTranslationFactory.php.

Referenced by __construct(), and getFieldFactory().

---

The documentation for this class was generated from the following file:

• Modules/Bibliographic/classes/Translation/class.ilBiblTranslationFactory.php