PhpDocs

Author: cdujeu

core/src/core/classes/class.AJXP_AbstractMetaSource.php

@@ -20,6 +20,10 @@
  */
 defined('AJXP_EXEC') or die( 'Access not allowed');
 
+/**
+ * Class AJXP_AbstractMetaSource
+ * Abstract class from which all meta.* plugins must extend.
+ */
 abstract class AJXP_AbstractMetaSource extends AJXP_Plugin {
 
     /**

core/src/core/classes/class.AJXP_Exception.php

@@ -26,7 +26,7 @@
  */
 class AJXP_Exception extends Exception
 {
-    public function AJXP_Exception($messageString, $messageId = false)
+    public function __construct($messageString, $messageId = false)
     {
         if ($messageId !== false && class_exists("ConfService")) {
             $messages = ConfService::getMessages();

core/src/core/classes/class.AJXP_MetaStreamWrapper.php

@@ -21,7 +21,17 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_MetaStreamWrapper
+ *
+ * Global streamWrapper that encapsulates all wrappers to access a driver's resource.
+ * Registered under the "pydio" protocol, it should replace all the old ajxp.XX direct calls.
+ * The static "appendMetaWrapper" method allows to add additional wrapper that will be sequentially called until
+ * reaching the driver ajxp.XX wrapper.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_MetaStreamWrapper implements AjxpWrapper
 {
     /**
@@ -40,6 +50,10 @@ class AJXP_MetaStreamWrapper implements AjxpWrapper
 
     protected static $cachedRepositoriesWrappers = array();
 
+    /**
+     * Register the stack of protocols/wrappers.
+     * @param null $registered_wrappers
+     */
     public static function register($registered_wrappers = null){
         if($registered_wrappers == null){
             $registered_wrappers = stream_get_wrappers();
@@ -51,6 +65,11 @@ public static function register($registered_wrappers = null){
         }
     }
 
+    /**
+     * Register an addition protocol/wrapper in the stack
+     * @param $name string
+     * @param $className string
+     */
     public static function appendMetaWrapper($name, $className){
         self::$metaWrappers[$name] = $className;
         self::register();
@@ -105,6 +124,12 @@ protected static function actualRepositoryWrapperData($repositoryId){
         }
     }
 
+    /**
+     * Return the final ajxp.XX wrapper class name.
+     * @param string $repositoryId
+     * @return string mixed
+     * @throws Exception
+     */
     public static function actualRepositoryWrapperClass($repositoryId){
         $data = self::actualRepositoryWrapperData($repositoryId);
         return $data["classname"];

core/src/core/classes/class.AJXP_Permission.php

@@ -21,7 +21,15 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_Permission
+ *
+ * Atomic permission associated to a folder path. Can be initialized either with an integer
+ * value (use MASK constants) or with a string value like "r", "rw", etc.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_Permission implements JsonSerializable
 {
     /**
@@ -55,25 +63,32 @@ function __construct($value = null){
         }
     }
 
+    /**
+     * Replicate this permission.
+     * @return AJXP_Permission
+     */
     function getCopy(){
         return new AJXP_Permission($this->value);
     }
 
     /**
+     * Test if the permission is readable
      * @return bool
      */
     function canRead(){
         return ($this->value & self::READ) === self::READ;
     }
 
     /**
+     * Test if the permission is writeable
      * @return bool
      */
     function canWrite(){
         return ($this->value & self::WRITE) === self::WRITE;
     }
 
     /**
+     * Test if the permission denies access, whatever happens.
      * @return bool
      */
     function denies(){
@@ -82,10 +97,20 @@ function denies(){
         return false;
     }
 
+    /**
+     * Test if the permission is just empty
+     * @return bool
+     */
     function isEmpty(){
         return $this->value === 0;
     }
 
+    /**
+     * Test permission against an integer value
+     * @param int $numPerm
+     * @return bool
+     * @throws Exception
+     */
     function testPermission($numPerm){
         if(is_integer($numPerm) && ($numPerm < self::MASK)){
             $numPerm = $numPerm & self::MASK;
@@ -99,20 +124,34 @@ function testPermission($numPerm){
         }
     }
 
+    /**
+     * Set this permission as readable
+     * @param bool|true $value
+     */
     function setRead($value = true){
         if($value)
             $this->value = $this->value | self::READ;
         else{
             $this->value = $this->value & (self::READ ^ self::MASK);
         }
     }
+
+    /**
+     * Set this permission as writeable
+     * @param bool|true $value
+     */
     function setWrite($value = true){
         if($value)
             $this->value = $this->value | self::WRITE;
         else{
             $this->value = $this->value & (self::WRITE ^ self::MASK);
         }
     }
+
+    /**
+     * Set this permission as denied
+     * @param bool|true $value
+     */
     function setDeny($value = true){
         if($value)
             $this->value = self::DENY;
@@ -122,6 +161,7 @@ function setDeny($value = true){
     }
 
     /**
+     * Override this permission value with the one passed in parameter
      * @param AJXP_Permission $perm
      * @return AJXP_Permission
      */

core/src/core/classes/class.AJXP_PermissionMask.php

@@ -21,7 +21,15 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_PermissionMask
+ *
+ * Stores a mapping of path => AJXP_Permission that can be used as a mask on an existing folder structure.
+ *
+ * @package Pydio
+ * @subpackage Core
+ *
+ */
 class AJXP_PermissionMask implements JsonSerializable, Serializable
 {
     /**
@@ -30,6 +38,7 @@ class AJXP_PermissionMask implements JsonSerializable, Serializable
     private $permissionTree = array();
 
     /**
+     * Initialize an empty mask, or from a serializedForm.
      * @param array|null $serializedForm
      */
     function __construct($serializedForm = null){
@@ -48,6 +57,7 @@ function __construct($serializedForm = null){
     }
 
     /**
+     * Returns the whole permission tree
      * @return array
      */
     function getTree(){
@@ -56,6 +66,7 @@ function getTree(){
     }
 
     /**
+     * Set the permision tree at once
      * @param array $tree
      * @return AJXP_PermissionMask;
      */
@@ -65,6 +76,7 @@ function updateTree($tree){
     }
 
     /**
+     * Add a branch in the permissions tree
      * @param string $path
      * @param AJXP_Permission $permission
      * @return AJXP_PermissionMask
@@ -76,6 +88,7 @@ function updateBranch($path, $permission){
     }
 
     /**
+     * Delete a branch from the permission tree
      * @param string $path
      * @return AJXP_PermissionMask
      */
@@ -85,6 +98,7 @@ function deleteBranch($path){
     }
 
     /**
+     * Merge the current permission tree with the one passed in parameter. The latter takes precedence on the first.
      * @param AJXP_PermissionMask $mask
      * @return AJXP_PermissionMask
      */
@@ -96,6 +110,7 @@ function override($mask){
     }
 
     /**
+     * Copy the full tree from the one passed in parameter
      * @param AJXP_PermissionMask $mask
      * @return AJXP_PermissionMask
      */
@@ -105,6 +120,7 @@ function copyMask($mask){
     }
 
     /**
+     * Test if a given path does have the given permission according to this mask permission tree.
      * @param string $test
      * @param  string $permission
      * @return bool
@@ -146,6 +162,7 @@ function match($test, $permission){
     }
 
     /**
+     * Merge two trees
      * @param array $t1
      * @param array $t2
      * @return array
@@ -184,6 +201,7 @@ private function mergeTrees($t1, $t2){
     }
 
     /**
+     * Translate a path=> AJXP_Permission to an array-based branch.
      * @param string $path
      * @param AJXP_Permission $permission
      * @return array
@@ -205,6 +223,7 @@ private function pathToBranch($path, $permission){
     }
 
     /**
+     * Transform the permission tree into a flat structure of pathes => permissions.
      * @param array|null $tree
      * @param array|null $pathes
      * @param string $currentRoot
@@ -226,7 +245,11 @@ public function flattenTree($tree = null, &$pathes = null, $currentRoot=""){
     }
 
 
-
+    /**
+     * Print the tree as a string (for debug puprpose).
+     * @param $permissionTree
+     * @param $level
+     */
     public function toStr($permissionTree, $level)
     {
         $level = $level + 1;

core/src/core/classes/class.AJXP_ProgressBarCLI.php

@@ -20,6 +20,13 @@
  */
 defined('AJXP_EXEC') or die( 'Access not allowed');
 
+/**
+ * Class AJXP_ProgressBarCLI
+ * Simple object to print a progress bar on the command-line.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_ProgressBarCLI {
     private $strProgress = "";
     private $strLength = 25; // 50 '='

core/src/core/classes/class.AJXP_PromptException.php

@@ -24,6 +24,13 @@
 define('AJXP_PROMPT_EXCEPTION_CONFIRM', 'AJXP_PROMPT_EXCEPTION_CONFIRM');
 define('AJXP_PROMPT_EXCEPTION_ALERT', 'AJXP_PROMPT_EXCEPTION_ALERT');
 
+/**
+ * Class AJXP_PromptException
+ * Specific exception that triggers a prompt in the UI instead of displaying an error message.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_PromptException extends AJXP_Exception{
 
     private $promptType = "prompt";
@@ -61,6 +68,12 @@ public function __construct($promptType, $data, $messageString, $messageId = fal
         parent::__construct($messageString, $messageId);
     }
 
+    /**
+     * Prompt user for credentials
+     * @param $sessionVariable
+     * @param $switchToRepositoryId
+     * @throws AJXP_PromptException
+     */
     public static function testOrPromptForCredentials($sessionVariable, $switchToRepositoryId){
         if(isSet($_GET["prompt_passed_data"]) && isSet($_GET["variable_name"]) && $_GET["variable_name"] == $sessionVariable){
             $_SESSION[$sessionVariable] = true;

core/src/core/classes/class.AJXP_SchemeTranslatorWrapper.php

@@ -21,7 +21,13 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 
-
+/**
+ * Class AJXP_SchemeTranslatorWrapper
+ * Simple Wrapper that justs converts a given protocol to another one.
+ *
+ * @package Pydio
+ * @subpackage Core
+ */
 class AJXP_SchemeTranslatorWrapper extends AJXP_MetaStreamWrapper implements AjxpWrapper
 {
     /**

core/src/core/classes/class.AJXP_ShutdownScheduler.php

@@ -21,6 +21,8 @@
 
 defined('AJXP_EXEC') or die('Access not allowed');
 /**
+ *
+ * Registry for callbacks that must be triggered after the script is finished.
  *
  * @package Pydio
  * @subpackage Core

core/src/core/classes/class.PydioSdkGenerator.php

@@ -18,7 +18,14 @@
  *
  * The latest code can be found at <https://pyd.io/>.
  *
+ *
+ */
+
+/**
+ * Class PydioSdkGenerator
  * Generate a Swagger file for Rest APIs documentation
+ * @package Pydio
+ * @subpackage Core
  */
 class PydioSdkGenerator
 {