diff options
Diffstat (limited to 'lib/private/vobject.php')
| -rw-r--r-- | lib/private/vobject.php | 78 |
1 files changed, 39 insertions, 39 deletions
diff --git a/lib/private/vobject.php b/lib/private/vobject.php index a3e9f7ef790..94e3470ff08 100644 --- a/lib/private/vobject.php +++ b/lib/private/vobject.php @@ -25,28 +25,28 @@ */ class OC_VObject{ /** @var Sabre\VObject\Component */ - protected $vobject; + protected $vObject; /** - * @returns Sabre\VObject\Component + * @return Sabre\VObject\Component */ public function getVObject() { - return $this->vobject; + return $this->vObject; } /** - * @brief Parses the VObject + * Parses the VObject * @param string $data VObject as string - * @returns Sabre\VObject\Reader|null + * @return Sabre\VObject\Reader|null */ public static function parse($data) { try { Sabre\VObject\Property::$classMap['LAST-MODIFIED'] = 'Sabre\VObject\Property\DateTime'; - $vobject = Sabre\VObject\Reader::read($data); - if ($vobject instanceof Sabre\VObject\Component) { - $vobject = new OC_VObject($vobject); + $vObject = Sabre\VObject\Reader::read($data); + if ($vObject instanceof Sabre\VObject\Component) { + $vObject = new OC_VObject($vObject); } - return $vobject; + return $vObject; } catch (Exception $e) { OC_Log::write('vobject', $e->getMessage(), OC_Log::ERROR); return null; @@ -54,7 +54,7 @@ class OC_VObject{ } /** - * @brief Escapes semicolons + * Escapes semicolons * @param array $value * @return string */ @@ -66,7 +66,7 @@ class OC_VObject{ } /** - * @brief Creates an array out of a multivalue property + * Creates an array out of a multivalue property * @param string $value * @return array */ @@ -89,34 +89,34 @@ class OC_VObject{ /** * Constructor - * @param Sabre\VObject\Component or string + * @param Sabre\VObject\Component|string $vobject_or_name */ public function __construct($vobject_or_name) { if (is_object($vobject_or_name)) { - $this->vobject = $vobject_or_name; + $this->vObject = $vobject_or_name; } else { - $this->vobject = new Sabre\VObject\Component($vobject_or_name); + $this->vObject = new Sabre\VObject\Component($vobject_or_name); } } /** * @todo Write documentation - * @param $item + * @param \OC_VObject|\Sabre\VObject\Component $item * @param null $itemValue */ public function add($item, $itemValue = null) { if ($item instanceof OC_VObject) { $item = $item->getVObject(); } - $this->vobject->add($item, $itemValue); + $this->vObject->add($item, $itemValue); } /** - * @brief Add property to vobject + * Add property to vobject * @param object $name of property * @param object $value of property * @param array|object $parameters of property - * @returns Sabre\VObject\Property newly created + * @return Sabre\VObject\Property newly created */ public function addProperty($name, $value, $parameters=array()) { if(is_array($value)) { @@ -127,26 +127,26 @@ class OC_VObject{ $property->parameters[] = new Sabre\VObject\Parameter($name, $value); } - $this->vobject->add($property); + $this->vObject->add($property); return $property; } public function setUID() { $uid = substr(md5(rand().time()), 0, 10); - $this->vobject->add('UID', $uid); + $this->vObject->add('UID', $uid); } /** * @todo Write documentation - * @param mixed $name + * @param mixed $name * @param string $string */ public function setString($name, $string) { if ($string != '') { $string = strtr($string, array("\r\n"=>"\n")); - $this->vobject->__set($name, $string); + $this->vObject->__set($name, $string); }else{ - $this->vobject->__unset($name); + $this->vObject->__unset($name); } } @@ -167,31 +167,31 @@ class OC_VObject{ if ($datetime instanceof DateTime) { $datetime_element = new Sabre\VObject\Property\DateTime($name); $datetime_element->setDateTime($datetime, $dateType); - $this->vobject->__set($name, $datetime_element); + $this->vObject->__set($name, $datetime_element); }else{ - $this->vobject->__unset($name); + $this->vObject->__unset($name); } } /** * @todo Write documentation - * @param $name + * @param string $name * @return string */ public function getAsString($name) { - return $this->vobject->__isset($name) ? - $this->vobject->__get($name)->value : + return $this->vObject->__isset($name) ? + $this->vObject->__get($name)->value : ''; } /** * @todo Write documentation - * @param $name + * @param string $name * @return array */ public function getAsArray($name) { $values = array(); - if ($this->vobject->__isset($name)) { + if ($this->vObject->__isset($name)) { $values = explode(',', $this->getAsString($name)); $values = array_map('trim', $values); } @@ -200,14 +200,14 @@ class OC_VObject{ /** * @todo Write documentation - * @param $name + * @param string $name * @return array|OC_VObject|\Sabre\VObject\Property */ public function &__get($name) { if ($name == 'children') { - return $this->vobject->children; + return $this->vObject->children; } - $return = $this->vobject->__get($name); + $return = $this->vObject->__get($name); if ($return instanceof Sabre\VObject\Component) { $return = new OC_VObject($return); } @@ -220,7 +220,7 @@ class OC_VObject{ * @param string $value */ public function __set($name, $value) { - return $this->vobject->__set($name, $value); + return $this->vObject->__set($name, $value); } /** @@ -228,7 +228,7 @@ class OC_VObject{ * @param string $name */ public function __unset($name) { - return $this->vobject->__unset($name); + return $this->vObject->__unset($name); } /** @@ -237,16 +237,16 @@ class OC_VObject{ * @return bool */ public function __isset($name) { - return $this->vobject->__isset($name); + return $this->vObject->__isset($name); } /** * @todo Write documentation - * @param $function - * @param $arguments + * @param callable $function + * @param array $arguments * @return mixed */ public function __call($function, $arguments) { - return call_user_func_array(array($this->vobject, $function), $arguments); + return call_user_func_array(array($this->vObject, $function), $arguments); } } |