Update to classes for CMIS enum types

Story ID:2295472. Update KT CMIS implementation to 1.0 lib/api/compliance Committed by: Paul Barrett

Update to classes for CMIS enum types
Story ID:2295472. Update KT CMIS implementation to 1.0 lib/api/compliance Committed by: Paul Barrett
Paul Barrett
1 parent 1faa0263
Showing 7 changed files with 98 additions and 15 deletions
lib/api/ktcmis/classes/Enum.inc.php
lib/api/ktcmis/enums/EnumCapabilityACL.inc.php
lib/api/ktcmis/enums/EnumCapabilityChanges.inc.php
lib/api/ktcmis/enums/EnumCapabilityContentStreamUpdatability.inc.php
lib/api/ktcmis/enums/EnumCapabilityJoin.inc.php
lib/api/ktcmis/enums/EnumCapabilityQuery.inc.php
lib/api/ktcmis/enums/EnumCapabilityRenditions.inc.php
@@ -9,15 +9,19 @@
 abstract class Enum {
     // actual implementation of these will be in child classes
-    static private $values;
-    static private $value;
-    static private $name;
+    static protected $name;
+    static protected $values;
+    static protected $value;
     /**
      * Sets the value of the enumerator
      *
      * @param unknown_type $value
      * @throws invalidArgumentException if the given value does not match one of the allowed values
+     * 
+     * Extending classes may override this function to add their own additional rules for how an enum may be set, 
+     * but they should always call this parent function afterward to invoke the base rule that the value must be
+     * one of the defined values
      */
     static protected function set($value)
     {        
@@ -31,6 +35,7 @@ abstract class Enum {
     /**
      * Returns the currently set value, or null if unset
      *
+     * @return $value the currently set value
      */
     static protected function get()
     {
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityACL extends Enum {
-    static private $values = array('none', 'discover', 'manage');
-    static private $name = 'capabilityACL';
+    static protected $name = 'capabilityACL';
+    static protected $values = array('none', 'discover', 'manage');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityChanges extends Enum {
-    static private $values = array('none', 'objectidsonly', 'properties', 'all');
-    static private $name = 'capabilityChanges';
+    static protected $name = 'capabilityChanges';
+    static protected $values = array('none', 'objectidsonly', 'properties', 'all');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityContentStreamUpdatability extends Enum {
-    static private $values = array('none', 'anytime', 'pwconly');
-    static private $name = 'capabilityContentStreamUpdatability';
+    static protected $name = 'capabilityContentStreamUpdatability';
+    static protected $values = array('none', 'anytime', 'pwconly');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityJoin extends Enum {
-    static private $values = array('none', 'inneronly', 'innerandouter');
-    static private $name = 'capabilityJoin';
+    static protected $name = 'capabilityJoin';
+    static protected $values = array('none', 'inneronly', 'innerandouter');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityQuery extends Enum {
-    static private $values = array('none', 'metadataonly', 'fulltextonly', 'bothseparate', 'bothcombined');
-    static private $name = 'capabilityQuery';
+    static protected $name = 'capabilityQuery';
+    static protected $values = array('none', 'metadataonly', 'fulltextonly', 'bothseparate', 'bothcombined');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file
@@ -11,8 +11,21 @@ require_once(CMIS_DIR . &#39;/classes/Enum.inc.php&#39;);
 class EnumCapabilityRenditions extends Enum {
-    static private $values = array('none', 'objectidsonly', 'properties', 'all');
-    static private $name = 'capabilityRenditions';
+    static protected $name = 'capabilityRenditions';
+    static protected $values = array('none', 'objectidsonly', 'properties', 'all');
+    
+    /**
+     * Sets the value of the enumerator
+     *
+     * @param unknown_type $value
+     * @throws invalidArgumentException if the given value does not match one of the allowed values
+     *         (exception is thrown in parent class function)
+     */
+    static protected function set($value)
+    {
+        parent::set($value);
+    }
+    
 }
 ?>
 \ No newline at end of file