diff options
-rw-r--r-- | libraries/di/ServiceItem.class.php | 11 | ||||
-rw-r--r-- | libraries/di/ValueItem.class.php | 9 | ||||
-rw-r--r-- | libraries/gis/GIS_Visualization.class.php | 51 | ||||
-rw-r--r-- | libraries/relation_cleanup.lib.php | 2 | ||||
-rw-r--r-- | libraries/util.lib.php | 9 | ||||
-rw-r--r-- | test/libraries/PMA_GIS_modifyQuery_test.php | 24 |
6 files changed, 82 insertions, 24 deletions
diff --git a/libraries/di/ServiceItem.class.php b/libraries/di/ServiceItem.class.php index 9cb5a8a9b4..4d1594fec2 100644 --- a/libraries/di/ServiceItem.class.php +++ b/libraries/di/ServiceItem.class.php @@ -10,6 +10,11 @@ namespace PMA\DI; require_once 'libraries/di/ReflectorItem.class.php'; +/** + * Service manager + * + * @package PMA\DI + */ class ServiceItem extends ReflectorItem { @@ -19,8 +24,8 @@ class ServiceItem extends ReflectorItem /** * Constructor * - * @param Container $container - * @param mixed $definition + * @param Container $container Container + * @param mixed $definition Definition */ function __construct(Container $container, $definition) { @@ -30,7 +35,7 @@ class ServiceItem extends ReflectorItem /** * Get the instance of the service * - * @param array $params + * @param array $params Parameters * @return mixed */ public function get($params = array()) diff --git a/libraries/di/ValueItem.class.php b/libraries/di/ValueItem.class.php index 34d1fb4ea5..164eef5ced 100644 --- a/libraries/di/ValueItem.class.php +++ b/libraries/di/ValueItem.class.php @@ -10,6 +10,11 @@ namespace PMA\DI; require_once 'libraries/di/Item.int.php'; +/** + * Value manager + * + * @package PMA\DI + */ class ValueItem implements Item { @@ -19,7 +24,7 @@ class ValueItem implements Item /** * Constructor * - * @param $value + * @param mixed $value Value */ function __construct($value) { @@ -29,7 +34,7 @@ class ValueItem implements Item /** * Get the value * - * @param array $params + * @param array $params Parameters * @return mixed */ public function get($params = array()) diff --git a/libraries/gis/GIS_Visualization.class.php b/libraries/gis/GIS_Visualization.class.php index 60ebc233b1..cab8b76268 100644 --- a/libraries/gis/GIS_Visualization.class.php +++ b/libraries/gis/GIS_Visualization.class.php @@ -75,16 +75,42 @@ class PMA_GIS_Visualization return $this->_settings; } + /** + * Factory + * + * @param string $sql_query SQL to fetch raw data for visualization + * @param array $options Users specified options + * @param integer $row number of rows + * @param integer $pos start position + * + * @return PMA_GIS_Visualization + * + * @access public + */ public static function get($sql_query, $options, $row, $pos) { return new PMA_GIS_Visualization($sql_query, $options, $row, $pos); } + /** + * Get visualization + * + * @param array $options Users specified options + * @param array $data Raw data, if set, parameters other than $options will be + * ignored + * + * @return PMA_GIS_Visualization + */ public static function getByData($data, $options) { return new PMA_GIS_Visualization(null, $options, null, null, $data); } + /** + * Check if data as srid + * + * @return bool + */ public function hasSrid() { foreach ($this->_data as $row) { @@ -132,9 +158,9 @@ class PMA_GIS_Visualization /** * Returns sql for fetching raw data * - * @param string $sql_query The SQL to modify. - * @param integer $rows Number of rows. - * @param integer $pos Start posistion. + * @param string $sql_query The SQL to modify. + * @param integer $rows Number of rows. + * @param integer $pos Start position. * * @return string the modified sql query. */ @@ -450,6 +476,13 @@ class PMA_GIS_Visualization $pdf->Output($file_name, 'D'); } + /** + * Convert file to image + * + * @param string $format Output format + * + * @return string File + */ public function toImage($format) { if ($format == 'svg') { @@ -461,6 +494,14 @@ class PMA_GIS_Visualization } } + /** + * Convert file to given format + * + * @param string $filename Filename + * @param string $format Output format + * + * @return void + */ public function toFile($filename, $format) { if ($format == 'svg') { @@ -619,7 +660,11 @@ class PMA_GIS_Visualization } /** + * Set user specific settings + * * @param array $userSpecifiedSettings + * + * @return void */ public function setUserSpecifiedSettings($userSpecifiedSettings) { diff --git a/libraries/relation_cleanup.lib.php b/libraries/relation_cleanup.lib.php index 4da5338aca..3fa094d787 100644 --- a/libraries/relation_cleanup.lib.php +++ b/libraries/relation_cleanup.lib.php @@ -215,6 +215,8 @@ function PMA_relationsCleanupDatabase($db) * Cleanup user related relation stuff * * @param string $username username + * + * @return void */ function PMA_relationsCleanupUser($username) { diff --git a/libraries/util.lib.php b/libraries/util.lib.php index e59bba6112..b5b066f47f 100644 --- a/libraries/util.lib.php +++ b/libraries/util.lib.php @@ -5,10 +5,11 @@ namespace PMA\Util; /** * Access to a multidimensional array by dot notation * - * @param array $array - * @param string|array $path - * @param mixed $default - * @return mixed + * @param array $array List of values + * @param string|array $path Path to searched value + * @param mixed $default Default value + * + * @return mixed Searched value */ function get($array, $path, $default = null) { diff --git a/test/libraries/PMA_GIS_modifyQuery_test.php b/test/libraries/PMA_GIS_modifyQuery_test.php index cda91036d5..7451af526e 100644 --- a/test/libraries/PMA_GIS_modifyQuery_test.php +++ b/test/libraries/PMA_GIS_modifyQuery_test.php @@ -19,17 +19,17 @@ require_once 'libraries/Util.class.php'; */ class PMA_GIS_ModifyQueryTest extends PHPUnit_Framework_TestCase { - // @todo: Move this test to GIS_Visualization's - // /** - // * Test PMA_GIS_modifyQuery method - // * - // * @param string $sql_query query to modify - // * @param array $settings visualization settings - // * @param string $modified_query modified query - // * - // * @dataProvider provider - // * @return void - // */ + //@todo: Move this test to GIS_Visualization's + /** + * Test PMA_GIS_modifyQuery method + * + * @param string $sql_query query to modify + * @param array $settings visualization settings + * @param string $modified_query modified query + * + * @dataProvider provider + * @return void + */ public function testModifyQuery(/*$sql_query, $settings, $modified_query*/) { // $this->assertEquals( @@ -42,7 +42,7 @@ class PMA_GIS_ModifyQueryTest extends PHPUnit_Framework_TestCase /** * data provider for testModifyQuery * - * @return data for testModifyQuery + * @return array data for testModifyQuery */ public function provider() { |