ilTermsOfServiceAgreementByLanguageProvider Class Reference

Inheritance diagram for ilTermsOfServiceAgreementByLanguageProvider:

Collaboration diagram for ilTermsOfServiceAgreementByLanguageProvider:

Public Member Functions
	__construct (ilLanguage $lng)
	setSourceDirectories ($terms_of_service_source_directories)
	getSourceDirectories ()
	setLanguageAdapter ($lng)
	getLanguageAdapter ()
	getList (array $params, array $filter)
	{ Parameters array $params Table paramaters like limit or order array $filter Filter settings Returns array }

Protected Member Functions
	initSourceDirectories ()
	collectData ()

Protected Attributes
	$lng
	$data = array()
	$source_directories = array()

Detailed Description

Author

Michael Jansen mjans.nosp@m.en@d.nosp@m.ataba.nosp@m.y.de

Version

$Id$

Definition at line 10 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

Constructor & Destructor Documentation

ilTermsOfServiceAgreementByLanguageProvider::__construct

(

ilLanguage

$lng

)

Parameters

ilLanguage

$lng

Definition at line 30 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

References initSourceDirectories(), and setLanguageAdapter().

        {
                $this->setLanguageAdapter($lng);
                $this->initSourceDirectories();
        }

Here is the call graph for this function:

Member Function Documentation

ilTermsOfServiceAgreementByLanguageProvider::collectData ( )

protected

Definition at line 97 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

References $file, getLanguageAdapter(), and getSourceDirectories().

Referenced by getList().

        {
                $i = 0;
                foreach($this->getLanguageAdapter()->getInstalledLanguages() as $iso2_language_code)
                {
                        $this->data['items'][$i]['language']                           = $iso2_language_code;
                        $this->data['items'][$i]['agreement']                          = false;
                        $this->data['items'][$i]['agreement_document']                 = null;
                        $this->data['items'][$i]['agreement_document_modification_ts'] = null;

                        foreach($this->getSourceDirectories() as $directory)
                        {
                                $file = $directory . '/agreement_' . $iso2_language_code . '.html';
                                if(is_file($file) && is_readable($file))
                                {
                                        $this->data['items'][$i]['agreement_document']                 = $file;
                                        $this->data['items'][$i]['agreement_document_modification_ts'] = filemtime($file);
                                        $this->data['items'][$i]['agreement']                          = true;
                                        break;
                                }
                        }

                        ++$i;
                }

                $this->data['cnt'] = $i;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::getLanguageAdapter

(

)

Returns

ilLanguage

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

References $lng.

Referenced by collectData(), and ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderShouldReturnLanguageAdapterWhenLanguageAdapterIsSet().

        {
                return $this->lng;
        }

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::getList	(	array	$params,
		array	$filter
	)

{

Parameters

array	$params	Table paramaters like limit or order
array	$filter	Filter settings

Returns

array

}

Implements ilTermsOfServiceTableDataProvider.

Definition at line 82 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

References $data, and collectData().

Referenced by ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderReturnsAResultForEveryInstalledLanguage().

        {
                $this->data = array(
                        'items' => array(),
                        'cnt'   => 0
                );

                $this->collectData();

                return $this->data;
        }

Here is the call graph for this function:

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::getSourceDirectories

(

)

Returns

array

Definition at line 47 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

References $source_directories.

Referenced by collectData(), and ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderShouldReturnSourceDirectoriesWhenSourceDirectoriesAreSet().

        {
                return $this->source_directories;
        }

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::initSourceDirectories ( )

protected

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

Referenced by __construct().

        {
                $this->source_directories = array(
                        implode('/', array('.', 'Customizing', 'clients', CLIENT_ID, 'agreement')),
                        implode('/', array('.', 'Customizing', 'global', 'agreement'))
                );
        }

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::setLanguageAdapter

(

$lng

)

Parameters

ilLanguage

$lng

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

References $lng.

Referenced by __construct(), ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderReturnsAResultForEveryInstalledLanguage(), and ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderShouldReturnLanguageAdapterWhenLanguageAdapterIsSet().

        {
                $this->lng = $lng;
        }

Here is the caller graph for this function:

ilTermsOfServiceAgreementByLanguageProvider::setSourceDirectories

(

$terms_of_service_source_directories

)

Parameters

array

$terms_of_service_source_directories

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

Referenced by ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderReturnsAResultForEveryInstalledLanguage(), and ilTermsOfServiceAgreementsByLanguageTableDataProviderTest\testProviderShouldReturnSourceDirectoriesWhenSourceDirectoriesAreSet().

        {
                $this->source_directories = $terms_of_service_source_directories;
        }

Here is the caller graph for this function:

Field Documentation

ilTermsOfServiceAgreementByLanguageProvider::$data = array()

protected

Definition at line 20 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

Referenced by getList().

ilTermsOfServiceAgreementByLanguageProvider::$lng

protected

Definition at line 15 of file class.ilTermsOfServiceAgreementByLanguageProvider.php.

Referenced by getLanguageAdapter(), and setLanguageAdapter().

ilTermsOfServiceAgreementByLanguageProvider::$source_directories = array()

protected

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

Referenced by getSourceDirectories().

---

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

• Services/TermsOfService/classes/class.ilTermsOfServiceAgreementByLanguageProvider.php