Interface ilWebDAVMountInstructionsRepository. More...
Inheritance diagram for ilWebDAVMountInstructionsRepository:
Collaboration diagram for ilWebDAVMountInstructionsRepository:
Public Member Functions | |
| createMountInstructionsDocumentEntry (ilWebDAVMountInstructionsDocument $document) | |
| Create new database entry for given mount instructions document. More... | |
| getNextMountInstructionsDocumentId () | |
| Return next free ID for mount instructions document. More... | |
| getHighestSortingNumber () | |
| Get currently highest sorting number for mount instructions document. More... | |
| getMountInstructionsDocumentById (int $id) | |
| Gets mount instructions document by id. More... | |
| getMountInstructionsByLanguage (string $language) | |
| Gets mount instructions document by language -> language is two letters like "en" for English etc. More... | |
| getAllMountInstructions () | |
| Returns an array with all existing mount instructions documents. More... | |
| doMountInstructionsExistByLanguage (string $language) | |
| Check if mount instructions for language exists. More... | |
| updateMountInstructions (ilWebDAVMountInstructionsDocument $document) | |
| Update existing mount instructions document. More... | |
| updateSortingValueById (int $id, int $a_new_sorting_value) | |
| Update sorting value of a mount instructions document. More... | |
| deleteMountInstructionsById (int $id) | |
| Delete mount instructions document by id. More... | |
Detailed Description
Interface ilWebDAVMountInstructionsRepository.
Definition at line 6 of file ilWebDAVMountInstructionsRepository.php.
Member Function Documentation
◆ createMountInstructionsDocumentEntry()
| ilWebDAVMountInstructionsRepository::createMountInstructionsDocumentEntry | ( | ilWebDAVMountInstructionsDocument | $document | ) |
Create new database entry for given mount instructions document.
- Parameters
-
ilWebDAVMountInstructionsDocument $document
- Returns
- void
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ deleteMountInstructionsById()
| ilWebDAVMountInstructionsRepository::deleteMountInstructionsById | ( | int | $id | ) |
Delete mount instructions document by id.
- Parameters
-
int $id
- Returns
- void
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ doMountInstructionsExistByLanguage()
| ilWebDAVMountInstructionsRepository::doMountInstructionsExistByLanguage | ( | string | $language | ) |
Check if mount instructions for language exists.
Language is two letters like "en" for English etc. Returns id of mount instructions, if found, or 0.
- Parameters
-
string $language
- Returns
- int
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ getAllMountInstructions()
| ilWebDAVMountInstructionsRepository::getAllMountInstructions | ( | ) |
Returns an array with all existing mount instructions documents.
- Returns
- array
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ getHighestSortingNumber()
| ilWebDAVMountInstructionsRepository::getHighestSortingNumber | ( | ) |
Get currently highest sorting number for mount instructions document.
- Returns
- int
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ getMountInstructionsByLanguage()
| ilWebDAVMountInstructionsRepository::getMountInstructionsByLanguage | ( | string | $language | ) |
Gets mount instructions document by language -> language is two letters like "en" for English etc.
- Parameters
-
string $language
- Returns
- ilWebDAVMountInstructionsDocument $document
- Exceptions
-
InvalidArgumentException
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ getMountInstructionsDocumentById()
| ilWebDAVMountInstructionsRepository::getMountInstructionsDocumentById | ( | int | $id | ) |
Gets mount instructions document by id.
- Parameters
-
int $id
- Returns
- ilWebDAVMountInstructionsDocument $document
- Exceptions
-
InvalidArgumentException
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ getNextMountInstructionsDocumentId()
| ilWebDAVMountInstructionsRepository::getNextMountInstructionsDocumentId | ( | ) |
Return next free ID for mount instructions document.
- Returns
- int $nextId
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ updateMountInstructions()
| ilWebDAVMountInstructionsRepository::updateMountInstructions | ( | ilWebDAVMountInstructionsDocument | $document | ) |
Update existing mount instructions document.
- Parameters
-
ilWebDAVMountInstructionsDocument $document
- Returns
- void
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
◆ updateSortingValueById()
| ilWebDAVMountInstructionsRepository::updateSortingValueById | ( | int | $id, |
| int | $a_new_sorting_value | ||
| ) |
Update sorting value of a mount instructions document.
- Parameters
-
int $id int $a_new_sorting_value
- Returns
- void
Implemented in ilWebDAVMountInstructionsRepositoryImpl.
The documentation for this interface was generated from the following file:
- Services/WebDAV/classes/mount_instructions/ilWebDAVMountInstructionsRepository.php
