ilBiblTranslationFactory Class Reference

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V. More...

Inheritance diagram for ilBiblTranslationFactory:

Collaboration diagram for ilBiblTranslationFactory:

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

Protected Attributes
ILIAS DI Container	$dic
ilBiblFieldFactoryInterface	$field_factory

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

Detailed Description

This file is part of ILIAS, a powerful learning management system published by ILIAS open source e-Learning e.V.

ILIAS is licensed with the GPL-3.0, see https://www.gnu.org/licenses/gpl-3.0.en.html You should have received a copy of said license along with the source code, too.

If this is not the case or you just want to try ILIAS, you'll find us at: https://www.ilias.de https://github.com/ILIAS-eLearning Class ilBiblTranslationFactory

Author

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

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

Constructor & Destructor Documentation

__construct()

ilBiblTranslationFactory::__construct

(

ilBiblFieldFactoryInterface

$field_factory

)

ilBiblTranslationFactory constructor.

Definition at line 31 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

(

int

$id

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

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

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

References $id.

findArCreateInstanceForFieldAndlanguage()

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

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

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

     : \ilBiblTranslationInterface {
        $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 ilBiblFieldInterface\getId().

Here is the call graph for this function:

findById()

ilBiblTranslationFactory::findById

(

int

$id

)

@inheritDoc

@noinspection PhpIncompatibleReturnTypeInspection

Implements ilBiblTranslationFactoryInterface.

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

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

References $id, and ActiveRecord\findOrFail().

Here is the call graph for this function:

getAllTranslationsForField()

ilBiblTranslationFactory::getAllTranslationsForField

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

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

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

getAllTranslationsForFieldAsArray()

ilBiblTranslationFactory::getAllTranslationsForFieldAsArray

(

ilBiblFieldInterface

$field

)

@inheritDoc

Implements ilBiblTranslationFactoryInterface.

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

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

getCollectionOfTranslationsForField()

ilBiblTranslationFactory::getCollectionOfTranslationsForField ( ilBiblFieldInterface  $field )

private

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

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

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

Referenced by getInstanceForFieldAndSystemsLanguage(), getInstanceForFieldAndUsersLanguage(), and translationExistsForField().

Here is the call graph for this function:

Here is the caller graph for this function:

getFieldFactory()

ilBiblTranslationFactory::getFieldFactory

(

)

Implements ilBiblTranslationFactoryInterface.

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

                                     : \ilBiblFieldFactoryInterface
    {
        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

@noinspection PhpIncompatibleReturnTypeInspection

Implements ilBiblTranslationFactoryInterface.

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

                                                                                      : ?\ilBiblTranslationInterface
    {
        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

@noinspection PhpIncompatibleReturnTypeInspection

Implements ilBiblTranslationFactoryInterface.

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

                                                                                    : ?\ilBiblTranslationInterface
    {
        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

)

Translates a field in the current users language in tho folowing order:

• if standard-field, user ILIAS ilLanguage
• if a explicit translation in the users language is available, use this
• if a translation is only for the systems language, us this
• return string like "bib_year"

Implements ilBiblTranslationFactoryInterface.

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

                                                          : string
    {
        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

)

Implements ilBiblTranslationFactoryInterface.

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

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

References translate().

Here is the call graph for this function:

translateAttributeString()

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

Implements ilBiblTranslationFactoryInterface.

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

                                                                                               : string
    {
        $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

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

                                                                 : string
    {
        $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 106 of file class.ilBiblTranslationFactory.php.

                                                                          : bool
    {
        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 98 of file class.ilBiblTranslationFactory.php.

                                                                                            : bool
    {
        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 90 of file class.ilBiblTranslationFactory.php.

                                                                                          : bool
    {
        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

ILIAS DI Container ilBiblTranslationFactory::$dic

protected

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

$field_factory

ilBiblFieldFactoryInterface ilBiblTranslationFactory::$field_factory

protected

Definition at line 26 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