SnapPathCache Class Reference
[Core]
Manages the path cache (not really a cache).
More...
Static Public Member Functions | |
| static | addPathSet ($paths, $objId, $objType) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | regenPathCache () |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | removePathSet ($paths) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | retrievePath ($type, $id) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | updatePathSet ($newPaths, $oldPaths) |
| INSERT BRIEF DESCRIPTION HERE. | |
Static Private Member Functions | |
| static | recRegenDirectory ($pathBase, $dirId) |
| INSERT BRIEF DESCRIPTION HERE. | |
| static | recRegenResource ($pathBase, $resId) |
| INSERT BRIEF DESCRIPTION HERE. | |
Detailed Description
Manages the path cache (not really a cache).
For internal use only.
The path cache is a giant table that lists all Snap2 paths and links them to their respective filesystem objects. This class has some static methods that attempt to ease management of the path cache. Only the core API should make use of any of the methods in this class.
Definition at line 14 of file SnapPathCache.php5.
Member Function Documentation
| static SnapPathCache::addPathSet | ( | $ | paths, | |
| $ | objId, | |||
| $ | objType | |||
| ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$paths [TYPE]: DESCRIPTION $objId [TYPE]: DESCRIPTION $objType [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 25 of file SnapPathCache.php5.
References SnapDBI::cancelTransaction(), SnapDBI::commitTransaction(), SnapDBI::query(), and SnapDBI::startTransaction().
| static SnapPathCache::recRegenDirectory | ( | $ | pathBase, | |
| $ | dirId | |||
| ) | [static, private] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$pathBase [TYPE]: DESCRIPTION $dirId [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 182 of file SnapPathCache.php5.
References SnapDBI::query().
| static SnapPathCache::recRegenResource | ( | $ | pathBase, | |
| $ | resId | |||
| ) | [static, private] |
INSERT BRIEF DESCRIPTION HERE.
For internal use only.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$pathBase [TYPE]: DESCRIPTION $resId [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 229 of file SnapPathCache.php5.
References SnapDBI::query().
| static SnapPathCache::regenPathCache | ( | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 141 of file SnapPathCache.php5.
References SnapDBI::cancelTransaction(), SnapDBI::commitTransaction(), SnapDBI::query(), and SnapDBI::startTransaction().
| static SnapPathCache::removePathSet | ( | $ | paths | ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$paths [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 68 of file SnapPathCache.php5.
References SnapDBI::cancelTransaction(), SnapDBI::commitTransaction(), SnapDBI::query(), and SnapDBI::startTransaction().
| static SnapPathCache::retrievePath | ( | $ | type, | |
| $ | id | |||
| ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$type [TYPE]: DESCRIPTION $id [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 94 of file SnapPathCache.php5.
References SnapDBI::query().
| static SnapPathCache::updatePathSet | ( | $ | newPaths, | |
| $ | oldPaths | |||
| ) | [static] |
INSERT BRIEF DESCRIPTION HERE.
INSERT FULL DESCRIPTION HERE
- Parameters:
-
$newPaths [TYPE]: DESCRIPTION $oldPaths [TYPE]: DESCRIPTION
- Returns:
- [TYPE]: RETURN DESCRIPTION
Definition at line 115 of file SnapPathCache.php5.
References SnapDBI::cancelTransaction(), SnapDBI::commitTransaction(), SnapDBI::query(), and SnapDBI::startTransaction().
The documentation for this class was generated from the following file:
- snap2/core/SnapPathCache.php5
