ByTIC / framework

src/Records/_Abstract/Table.php

Doc Comments +18 added lines, -3 removed lines

@@ -129,6 +129,9 @@ 
         }
     }
 
+    /**
+     * @param string $class
+     */
     public function generateModelClass($class = null)
     {
         $class = $class ? $class : get_class($this);
@@ -192,6 +195,9 @@ 
         $this->setUpDB();
     }
 
+    /**
+     * @param string $name
+     */
     public function getHelper($name)
     {
         return HelperBroker::get($name);
@@ -402,6 +408,9 @@ 
         return $this->getDB()->lastInsertID();
     }
 
+    /**
+     * @param Record $model
+     */
     public function insertQuery($model, $onDuplicate)
     {
         $inserts = $this->getQueryModelData($model);
@@ -507,7 +516,7 @@ 
     /**
      * Delete a Record's database entry
      *
-     * @param mixed $input
+     * @param Row $input
      */
     public function delete($input)
     {
@@ -564,7 +573,7 @@ 
      * Returns paginated results
      * @param Paginator $paginator
      * @param array $params
-     * @return mixed
+     * @return RecordCollection
      */
     public function paginate(Paginator $paginator, $params = array())
     {
@@ -633,7 +642,7 @@ 
      * Finds Records using params array
      *
      * @param array $params
-     * @return mixed
+     * @return RecordCollection
      */
     public function findByParams($params = array())
     {
@@ -666,6 +675,9 @@ 
         return false;
     }
 
+    /**
+     * @param Query $query
+     */
     public function findByQuery($query, $params = array())
     {
         $class = $this->getCollectionClass();
@@ -903,6 +915,9 @@ 
         $this->initRelationsFromArray($type, $array);
     }
 
+    /**
+     * @param string $type
+     */
     public function initRelationsFromArray($type, $array)
     {
         foreach ($array as $key => $item) {

Spacing +2 added lines, -2 removed lines

@@ -540,7 +540,7 @@ 
         if (isset($where)) {
             if (is_array($where)) {
                 foreach ($where as $condition) {
-                    $condition = (array)$condition;
+                    $condition = (array) $condition;
                     $query->where($condition[0], $condition[1]);
                 }
             } else {
@@ -722,7 +722,7 @@ 
 
         if ($result->numRows()) {
             $row = $result->fetchResult();
-            return (int)$row['count'];
+            return (int) $row['count'];
         }
 
         return false;

src/Records/Relations/HasAndBelongsToMany.php

Doc Comments +2 added lines, -2 removed lines

@@ -19,7 +19,7 @@ 
      * When the $specific is false, it returns the generic query that applies
      * to any item, not just this collection's item
      *
-     * @return Nip_DB_Query_Select
+     * @return \Nip\Database\Query\_Abstract
      */
     public function getQuery($specific = true)
     {
@@ -61,7 +61,7 @@ 
 
     /**
      * Simple select query from the link table
-     * @return Nip_DB_Query_Select
+     * @return \Nip\Database\Query\_Abstract
      */
     public function getLinkQuery($specific = true)
     {

src/Records/Relations/HasOneOrMany.php

Doc Comments +3 added lines

@@ -37,6 +37,9 @@
         $this->setResults($collection);
     }
 
+    /**
+     * @param \Nip_RecordCollection $items
+     */
     public function populateCollection($collection, $items)
     {
         foreach ($items as $item) {

src/Records/Relations/Relation.php

Doc Comments +2 added lines, -2 removed lines

@@ -52,7 +52,7 @@ 
     }
 
     /**
-     * @param mixed $name
+     * @param string $name
      */
     public function setName($name)
     {
@@ -215,7 +215,7 @@ 
     }
 
     /**
-     * @param Record $object
+     * @param Records $object
      * @return $this
      */
     public function setWith(Records $object)

src/Request.php

Doc Comments +1 added lines, -1 removed lines

@@ -523,7 +523,7 @@
     /**
      * Singleton
      *
-     * @return Nip_Request
+     * @return Request
      */
     static public function instance()
     {

Spacing +4 added lines, -4 removed lines

@@ -396,7 +396,7 @@ 
      */
     public function setModuleKey($key)
     {
-        $this->_moduleKey = (string)$key;
+        $this->_moduleKey = (string) $key;
         return $this;
     }
 
@@ -418,7 +418,7 @@ 
      */
     public function setControllerKey($key)
     {
-        $this->_controllerKey = (string)$key;
+        $this->_controllerKey = (string) $key;
         return $this;
     }
 
@@ -440,14 +440,14 @@ 
      */
     public function setActionKey($key)
     {
-        $this->_actionKey = (string)$key;
+        $this->_actionKey = (string) $key;
         return $this;
     }
 
 
     public function getMCA()
     {
-        return $this->getModuleName().'.'.$this->getControllerName().'.'.$this->getActionName();
+        return $this->getModuleName() . '.' . $this->getControllerName() . '.' . $this->getActionName();
     }
 
 

src/router/route/Abstract.php

Doc Comments +3 added lines

@@ -31,6 +31,9 @@
     {
     }
 
+    /**
+     * @param boolean $map
+     */
     public function setMap($map)
     {
         $this->_map = $map;

src/router/Router.php

Doc Comments +1 added lines, -1 removed lines

@@ -81,7 +81,7 @@
     }
 
     /**
-     * @return mixed
+     * @return Nip\Request
      */
     public function getRequest()
     {

Spacing +3 added lines, -3 removed lines

@@ -29,14 +29,14 @@
 
         foreach ($this->_routes as $name => $route) {
             $route->setRequest($request);
-            Nip_Profiler::instance()->start('route [' . $name . '] ['.$uri.']');
+            Nip_Profiler::instance()->start('route [' . $name . '] [' . $uri . ']');
             if ($route->match($uri)) {
                 $this->_route = $route;
-                Nip_Profiler::instance()->end('route [' . $name . '] ['.$uri.']');
+                Nip_Profiler::instance()->end('route [' . $name . '] [' . $uri . ']');
                 break;
             }
 
-            Nip_Profiler::instance()->end('route [' . $name . '] ['.$uri.']');
+            Nip_Profiler::instance()->end('route [' . $name . '] [' . $uri . ']');
         }
 
         if ($this->_route) {

src/service/maps/objects/Abstract.php

Doc Comments +3 added lines

@@ -18,6 +18,9 @@
 
     }
 
+    /**
+     * @param string $key
+     */
     public function setParam($key, $value) {
         $this->_params[$key] = $value;
         return $this;

src/Session.php

Doc Comments +5 added lines, -5 removed lines

@@ -82,7 +82,7 @@ 
 	/**
 	 * Public method to return the session id
 	 * @todo implement a verification method ( ex: adding another validation string in the sessionID )
-	 * @return int
+	 * @return string
 	 */
 	public function getId()
 	{
@@ -106,7 +106,7 @@ 
 	 * Fetches session entry from database
 	 *
 	 * @param string $id
-	 * @return mixed
+	 * @return string|false
 	 */
 	public function read($id)
 	{
@@ -181,7 +181,7 @@ 
 
 	/**
 	 * @param Nip_DB_Wrapper $db
-	 * @return Nip_Session
+	 * @return Session
 	 */
 	public function setDB($db)
 	{
@@ -191,7 +191,7 @@ 
 
 	/**
 	 * @param int $lifetime
-	 * @return Nip_Session
+	 * @return Session
 	 */
 	public function setLifetime($lifetime)
 	{
@@ -216,7 +216,7 @@ 
 	 * Decodes data to be used
 	 *
 	 * @param string $data
-	 * @return mixed
+	 * @return string
 	 */
 	protected function decodeData($data)
 	{

Indentation +206 added lines, -206 removed lines

@@ -5,222 +5,222 @@
 class Session
 {
 
-	protected $id;
-	protected $_lifetime;
-	protected $db;
-	protected $table = 'session';
+    protected $id;
+    protected $_lifetime;
+    protected $db;
+    protected $table = 'session';
 
-	public function __construct()
-	{
-		$this->db = db();
-		$this->_lifetime = get_cfg_var("session.gc_maxlifetime");
+    public function __construct()
+    {
+        $this->db = db();
+        $this->_lifetime = get_cfg_var("session.gc_maxlifetime");
 
 //		ini_set('session.save_handler', 'user');
-		register_shutdown_function('session_write_close');
-	}
+        register_shutdown_function('session_write_close');
+    }
 
-	public function init()
-	{
-		$id = $this->checkRequestId();
+    public function init()
+    {
+        $id = $this->checkRequestId();
 //		$this->setHandlers();
-		$this->start($id);
-	}
-
-	/**
-	 * Restarts the session, with new optional session id
-	 *
-	 * @param string $id
-	 */
-	public function reinitialize($id = false)
-	{
-		session_write_close();
-		$this->setHandlers()->start($id);
-	}
-
-	/**
-	 * Starts the session, with optional session id
-	 * @param string $id
-	 */
-	protected function start($id = false)
-	{
-		if ($id) {
-			session_id($id);
-		}
+        $this->start($id);
+    }
+
+    /**
+     * Restarts the session, with new optional session id
+     *
+     * @param string $id
+     */
+    public function reinitialize($id = false)
+    {
+        session_write_close();
+        $this->setHandlers()->start($id);
+    }
+
+    /**
+     * Starts the session, with optional session id
+     * @param string $id
+     */
+    protected function start($id = false)
+    {
+        if ($id) {
+            session_id($id);
+        }
         \Nip\AutoLoader::instance()->isFatal(false);
-		session_start();
+        session_start();
         \Nip\AutoLoader::instance()->isFatal(true);
-	}
-
-	/**
-	 * Overrides default session handling functions
-	 * @return Session
-	 */
-	protected function setHandlers()
-	{
-		session_set_save_handler(
-			array($this, 'open'),
-			array($this, 'close'),
-			array($this, 'read'),
-			array($this, 'write'),
-			array($this, 'destroy'),
-			array($this, 'gc')
-		);
+    }
+
+    /**
+     * Overrides default session handling functions
+     * @return Session
+     */
+    protected function setHandlers()
+    {
+        session_set_save_handler(
+            array($this, 'open'),
+            array($this, 'close'),
+            array($this, 'read'),
+            array($this, 'write'),
+            array($this, 'destroy'),
+            array($this, 'gc')
+        );
 		
-		return $this;
-	}
-
-	public function open()
-	{
-		return true;
-	}
-
-	public function close()
-	{
-		return true;
-	}
-
-	/**
-	 * Public method to return the session id
-	 * @todo implement a verification method ( ex: adding another validation string in the sessionID )
-	 * @return int
-	 */
-	public function getId()
-	{
-		return session_id();
-	}
-
-	/**
-	 * Gets the session ID from REQUEST
-	 * @return int
-	 */
-	public function checkRequestId()
-	{
-		if (isset($_REQUEST['session_id'])) {
-			return $_REQUEST['session_id'];
-		}
-
-		return false;
-	}
-
-	/**
-	 * Fetches session entry from database
-	 *
-	 * @param string $id
-	 * @return mixed
-	 */
-	public function read($id)
-	{
-		/* @var $result Nip_DBResult */
-		$query = $this->db->newQuery('select');
-		$query->from($this->table)
-			  ->where('id = ?', $id)
-			  ->where('expires > ?', time())
-			  ->limit(1);
-		$result = $this->db->execute($query);
-
-		$return = false;
-		if ($result->numRows()) {
-			$row = $result->fetchResult();
-			$return = $this->decodeData($row['data']);
-		}
-		return $return;
-	}
-
-	/**
-	 * Stores the surrent session in the database
-	 *
-	 * @param string $id
-	 * @param mixed $data
-	 * @return int
-	 */
-	public function write($id, $data)
-	{
-		$replace = array();
-		$replace['id'] = $id;
-		$replace['data'] = $this->encodeData($data);
-		$replace['expires'] = time() + $this->_lifetime;
+        return $this;
+    }
+
+    public function open()
+    {
+        return true;
+    }
+
+    public function close()
+    {
+        return true;
+    }
+
+    /**
+     * Public method to return the session id
+     * @todo implement a verification method ( ex: adding another validation string in the sessionID )
+     * @return int
+     */
+    public function getId()
+    {
+        return session_id();
+    }
+
+    /**
+     * Gets the session ID from REQUEST
+     * @return int
+     */
+    public function checkRequestId()
+    {
+        if (isset($_REQUEST['session_id'])) {
+            return $_REQUEST['session_id'];
+        }
+
+        return false;
+    }
+
+    /**
+     * Fetches session entry from database
+     *
+     * @param string $id
+     * @return mixed
+     */
+    public function read($id)
+    {
+        /* @var $result Nip_DBResult */
+        $query = $this->db->newQuery('select');
+        $query->from($this->table)
+                ->where('id = ?', $id)
+                ->where('expires > ?', time())
+                ->limit(1);
+        $result = $this->db->execute($query);
+
+        $return = false;
+        if ($result->numRows()) {
+            $row = $result->fetchResult();
+            $return = $this->decodeData($row['data']);
+        }
+        return $return;
+    }
+
+    /**
+     * Stores the surrent session in the database
+     *
+     * @param string $id
+     * @param mixed $data
+     * @return int
+     */
+    public function write($id, $data)
+    {
+        $replace = array();
+        $replace['id'] = $id;
+        $replace['data'] = $this->encodeData($data);
+        $replace['expires'] = time() + $this->_lifetime;
 		
-		$query = $this->db->newQuery('replace');
-		$query->table($this->table)
-			  ->data($replace);
-		$result = $this->db->execute($query);
-
-		return $this->db->affectedRows();
-	}
-
-	/**
-	 * Destroys current session and deletes it's entry from the database
-	 *
-	 * @param string $id
-	 * @return int
-	 */
-	public function destroy($id)
-	{
-		$query = $this->db->newQuery("delete");
-		$query->table($this->table);
-		$query->where('id = ?', $id);
-		$query->limit(1);
-		$query->execute();
-
-		return $this->db->affectedRows();
-	}
-
-	/**
-	 * Garbage control. Called by PHP to remove expired entries from the database
-	 * @return int
-	 */
-	public function gc()
-	{
-		$query = $this->db->newQuery("delete");
-		$query->table($this->table);
-		$query->where('expires <= ?', time());
-		$query->execute();
-
-		return $this->db->affectedRows();
-	}
-
-	/**
-	 * @param Nip_DB_Wrapper $db
-	 * @return Nip_Session
-	 */
-	public function setDB($db)
-	{
-		$this->db = $db;
-		return $this;
-	}
-
-	/**
-	 * @param int $lifetime
-	 * @return Nip_Session
-	 */
-	public function setLifetime($lifetime)
-	{
+        $query = $this->db->newQuery('replace');
+        $query->table($this->table)
+                ->data($replace);
+        $result = $this->db->execute($query);
+
+        return $this->db->affectedRows();
+    }
+
+    /**
+     * Destroys current session and deletes it's entry from the database
+     *
+     * @param string $id
+     * @return int
+     */
+    public function destroy($id)
+    {
+        $query = $this->db->newQuery("delete");
+        $query->table($this->table);
+        $query->where('id = ?', $id);
+        $query->limit(1);
+        $query->execute();
+
+        return $this->db->affectedRows();
+    }
+
+    /**
+     * Garbage control. Called by PHP to remove expired entries from the database
+     * @return int
+     */
+    public function gc()
+    {
+        $query = $this->db->newQuery("delete");
+        $query->table($this->table);
+        $query->where('expires <= ?', time());
+        $query->execute();
+
+        return $this->db->affectedRows();
+    }
+
+    /**
+     * @param Nip_DB_Wrapper $db
+     * @return Nip_Session
+     */
+    public function setDB($db)
+    {
+        $this->db = $db;
+        return $this;
+    }
+
+    /**
+     * @param int $lifetime
+     * @return Nip_Session
+     */
+    public function setLifetime($lifetime)
+    {
         if ($lifetime && is_numeric($lifetime)) {
-    		$this->_lifetime = $lifetime;
+            $this->_lifetime = $lifetime;
         }
-		return $this;
-	}
-
-	/**
-	 * Encodes data to be stored
-	 *
-	 * @param mixed $data
-	 * @return string
-	 */
-	protected function encodeData($data)
-	{
-		return base64_encode($data);
-	}
-
-	/**
-	 * Decodes data to be used
-	 *
-	 * @param string $data
-	 * @return mixed
-	 */
-	protected function decodeData($data)
-	{
-		return base64_decode($data);
-	}
+        return $this;
+    }
+
+    /**
+     * Encodes data to be stored
+     *
+     * @param mixed $data
+     * @return string
+     */
+    protected function encodeData($data)
+    {
+        return base64_encode($data);
+    }
+
+    /**
+     * Decodes data to be used
+     *
+     * @param string $data
+     * @return mixed
+     */
+    protected function decodeData($data)
+    {
+        return base64_decode($data);
+    }
 
 }
\ No newline at end of file