Author: gimler
Date: 2010-02-07 22:11:19 +0100 (Sun, 07 Feb 2010)
New Revision: 27674
Modified:
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/browser/dmBrowser.php
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/context/dmContext.php
Log:
[Diem] add phpdocs
Modified:
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/browser/dmBrowser.php
===================================================================
---
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/browser/dmBrowser.php
2010-02-07 21:01:32 UTC (rev 27673)
+++
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/browser/dmBrowser.php
2010-02-07 21:11:19 UTC (rev 27674)
@@ -7,7 +7,7 @@
$browserDetection,
$name,
$version;
-
+
public function __construct(sfEventDispatcher $dispatcher,
dmBrowserDetection $browserDetection)
{
$this->dispatcher = $dispatcher;
@@ -20,12 +20,14 @@
{
$this->name = $this->version = null;
}
-
+
/**
* Minimal browser detection from user agent.
* It has the advantage of being compact and
* fairly performant as well, since it doesn't
* do any iteration or recursion.
+ *
+ * @param string $userAgent user agent to use
*/
public function configureFromUserAgent($userAgent)
{
@@ -40,37 +42,40 @@
$this->dispatcher->notify(new sfEvent($this, 'dm.browser.unknown',
$userAgent));
}
}
-
+
public function isUnknown()
{
return null === $this->name;
}
-
+
public function getName()
{
return $this->name;
}
-
+
public function setName($name)
{
$this->name = $name;
}
-
+
public function getVersion()
{
return $this->version;
}
-
+
public function setVersion($version)
{
$this->version = $version;
}
-
+
public function __toString()
{
return $this->getFullName();
}
-
+
+ /**
+ * @return array some informations about the brower
+ */
public function describe()
{
return array(
@@ -79,7 +84,10 @@
'is_unknown' => $this->isUnknown()
);
}
-
+
+ /**
+ * @return string combined browser name and version
+ */
public function getFullName()
{
return $this->getName().' '.$this->getVersion();
Modified:
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/context/dmContext.php
===================================================================
---
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/context/dmContext.php
2010-02-07 21:01:32 UTC (rev 27673)
+++
plugins/diemPlugin/tags/RELEASE_5_0_0_BETA5/dmCorePlugin/lib/context/dmContext.php
2010-02-07 21:11:19 UTC (rev 27674)
@@ -72,6 +72,8 @@
* @param string $name The name of the object to retrieve
*
* @return object The object associated with the given name
+ *
+ * @throws Exception if object does not exist in the current context
*/
public function get($name, $class = null)
{
--
You received this message because you are subscribed to the Google Groups
"symfony SVN" group.
To post to this group, send email to [email protected].
To unsubscribe from this group, send email to
[email protected].
For more options, visit this group at
http://groups.google.com/group/symfony-svn?hl=en.
