Kylob / BootPress

src/Asset/Component.php

Doc Comments +10 added lines, -1 removed lines

@@ -31,7 +31,7 @@ 
      * - 
      * - 
      * 
-     * @return object  A Symfony\Component\HttpFoundation\Response
+     * @return Response  A Symfony\Component\HttpFoundation\Response
      */
     public static function dispatch($file, $options = array())
     {
@@ -223,6 +223,9 @@ 
         return ($image) ? $image : static::dispatch($file, array('expires' => 31536000));
     }
 
+    /**
+     * @param string $html
+     */
     public static function urls($html)
     {
         if (is_null(static::$instance) || empty($html)) {
@@ -463,6 +466,9 @@ 
         return ($mime && $single) ? array_shift($mime) : $mime;
     }
 
+    /**
+     * @return string
+     */
     private function css($file, $row)
     {
         $page = Page::html();
@@ -577,6 +583,9 @@ 
         return;
     }
 
+    /**
+     * @param integer $count
+     */
     private function ids($count)
     {
         $ids = array();

Unused Use Statements +3 added lines, -3 removed lines

@@ -4,12 +4,12 @@
 
 use BootPress\Page\Component as Page;
 use BootPress\SQLite\Component as SQLite;
-use Symfony\Component\HttpFoundation\Response;
-use Symfony\Component\HttpFoundation\StreamedResponse;
-use Symfony\Component\HttpFoundation\BinaryFileResponse;
 use League\Glide\Responses\SymfonyResponseFactory;
 use League\Glide\ServerFactory;
 use MatthiasMullie\Minify;
+use Symfony\Component\HttpFoundation\BinaryFileResponse;
+use Symfony\Component\HttpFoundation\Response;
+use Symfony\Component\HttpFoundation\StreamedResponse;
 use phpUri;
 
 class Component

src/Auth/Component.php

Doc Comments +1 added lines, -1 removed lines

@@ -779,7 +779,7 @@
      * @param string  $group    The name of the group.  To verify $user_id against multiple groups then make this an ``array($group, ...)`` of groups.
      * @param string  $check    If '**all**' (default) then they must be in every group specified.  If '**any**' then they must be in at least one of the groups specified.
      * 
-     * @return array  True or False, whether or not your conditions were met.
+     * @return boolean  True or False, whether or not your conditions were met.
      * 
      * ```php
      * if ($auth->userInGroup($user_id, array('rothschild', 'white house', 'al-Qaeda'), 'any') {

src/Blog/Blog.php

Doc Comments +12 added lines

@@ -113,6 +113,9 @@ 
         }
     }
 
+    /**
+     * @param string $type
+     */
     public function query($type, $params = null)
     {
         $posts = array();
@@ -652,6 +655,9 @@ 
         return ($single) ? array_shift($posts) : $posts;
     }
 
+    /**
+     * @param string $value
+     */
     public function config($table = null, $path = null, $value = null)
     {
         if (is_null($this->config)) {
@@ -698,6 +704,9 @@ 
         return $param;
     }
 
+    /**
+     * @param string $table
+     */
     private function configInfo($table, $path, $name)
     {
         if (empty($path)) {
@@ -809,6 +818,9 @@ 
         $this->updateConfig();
     }
 
+    /**
+     * @param string $table
+     */
     private function getId($table, $value)
     {
         if (is_null($this->ids)) {

Unused Use Statements +3 added lines, -3 removed lines

@@ -2,12 +2,12 @@
 
 namespace BootPress\Blog;
 
+use BootPress\Hierarchy\Component as Hierarchy;
 use BootPress\Page\Component as Page;
-use BootPress\Theme\Component as Theme;
+use BootPress\Pagination\Component as Pagination;
 use BootPress\SQLite\Component as SQLite;
 use BootPress\Sitemap\Component as Sitemap;
-use BootPress\Hierarchy\Component as Hierarchy;
-use BootPress\Pagination\Component as Pagination;
+use BootPress\Theme\Component as Theme;
 use Symfony\Component\Finder\Finder;
 use Symfony\Component\Yaml\Yaml;
 

src/Bootstrap/Bootstrap3.php

Doc Comments +4 added lines, -5 removed lines

@@ -48,8 +48,6 @@ 
     /**
      * This method works in conjunction with ``$bp->col()`` below.  It makes things a little less verbose, but much easier to edit, modify, and see at a glance what in the world is going on.
      * 
-     * @param string $size    This value can be either '**xs**' < 768px, '**sm**' >= 768px, '**md**' >= 992 , or '**lg**' >= 1200. This is the point at which your grid will break, if no smaller size is indicated. With this method you can indicate multiple sizes by simply inserting another argument. All of your ``$size``'s must correspond with the values given in the ``$bp->col()``'s or ``$columns`` below.
-     * @param array $columns  An array of ``$bp->col()``'s.  This argument does not need to be the second one in line.  It is merely the last one given.
      * 
      * @return string
      * 
@@ -91,8 +89,6 @@ 
     /**
      * This is a helper method for ``$bp->row()`` above.  It only returns it's own arguments, but it helps to keep things straight.  Including arrays within arrays can get to be a little unwieldly, especially in a Smarty template. Just take a look at the ``$bp->media()`` method.
      * 
-     * @param mixed $number   This parameter must correspond with it's parent ``$bp->row($size)``. It can be an integer between 1 and 12, as long as all of the ``$bp->col()``'s respective numbers add up to 12 or less. To get fancy you can add a space, then an '**offset-**', '**push-**', or '**pull-**' followed by the number of columns that you would like to affect. All of these will be preceded by ``col-{$size}-...``. To include additional classes just keep on going with a space in between each like you normally would.
-     * @param string $column  The actual html content you would like to be placed in this column.
      * 
      * @return array  An array of it's own parameters.
      * 
@@ -233,7 +229,7 @@ 
      * @param string $name    The name of the form.
      * @param string $method  The form's method for sending.
      * 
-     * @return object
+     * @return Bootstrap3Form
      * 
      * ```php
      * $form = $bp->form('example');
@@ -1204,6 +1200,9 @@ 
         return array($html, $id);
     }
 
+    /**
+     * @param integer $count
+     */
     protected function listItem($link, $options, $name, $href, $count)
     {
         $name = trim(preg_replace('/(\<[^\<]+\<\/[^\>]+\>)/i', '', $name)); // remove tags and their contents

Unused Use Statements +1 added lines, -1 removed lines

@@ -2,8 +2,8 @@
 
 namespace BootPress\Bootstrap;
 
-use BootPress\Page\Component as Page;
 use BootPress\Form\Component as Form;
+use BootPress\Page\Component as Page;
 
 class Bootstrap3
 {

src/Bootstrap/Bootstrap3Form.php

Doc Comments +1 added lines, -1 removed lines

@@ -238,7 +238,7 @@
     /**
      * This is to add html tags, or semicolons, or asterisks, or whatever you would like include with all of the form's prompts.
      * 
-     * @param string|array $prompt  The form label reference.  If you want to include additional information relative to the field, then you can make this an ``array($prompt => $info)``, or an ``array($prompt, $info)`` that will appear when cliked or hovered over.  To customize the icon set ``$form->prompt('info', 'fa fa-info-circle')``.
+     * @param string $prompt  The form label reference.  If you want to include additional information relative to the field, then you can make this an ``array($prompt => $info)``, or an ``array($prompt, $info)`` that will appear when cliked or hovered over.  To customize the icon set ``$form->prompt('info', 'fa fa-info-circle')``.
      * @param string       $name    The name of the associated input field.
      * @param string       $id      The id of the associated input field.
      * 

src/Database/Component.php

Doc Comments +3 added lines

@@ -153,6 +153,9 @@
         return $stmt;
     }
 
+    /**
+     * @param string $fetch
+     */
     public function prepare($query, $fetch = null)
     {
         $query = (is_array($query)) ? trim(implode("\n", $query)) : trim($query);

src/Database/Driver.php

Doc Comments +7 added lines, -1 removed lines

@@ -166,7 +166,7 @@ 
     }
 
     /**
-     * @return object  The database connection.  This is how we create lazy connections.
+     * @return null|\PDO  The database connection.  This is how we create lazy connections.
      */
     public function connection()
     {
@@ -185,6 +185,9 @@ 
         return $this->connection;
     }
 
+    /**
+     * @param string $query
+     */
     protected function dbPrepare($query)
     {
         return $this->connection->prepare($query); // returns (mixed) $stmt object or false
@@ -205,6 +208,9 @@ 
         return ($info = $stmt->errorInfo()) ? "Code: {$info[0]} Error: ({$info[1]}) {$info[2]}" : false; // returns (string) error or false
     }
 
+    /**
+     * @param string $fetch
+     */
     protected function dbStyle($fetch)
     {
         switch ($fetch) {

src/Form/Component.php

Doc Comments +2 added lines, -2 removed lines

@@ -215,9 +215,9 @@
      * Retrieves an input's default value to display using the Validator::value method.  This is used internally when creating form fields using this class.
      * 
      * @param string      $field   The input's name.
-     * @param false|mixed $escape  If set to anything but false, then we run the value(s) through ``htmlspecialchars``.
+     * @param string $escape  If set to anything but false, then we run the value(s) through ``htmlspecialchars``.
      * 
-     * @return array|string  The field's default value.
+     * @return string|null  The field's default value.
      */
     public function defaultValue($field, $escape = false)
     {

src/Hierarchy/Component.php

Doc Comments +17 added lines

@@ -31,6 +31,9 @@ 
     All you need to worry about is the 'id' and 'parent'.  This class will take care of the rest.
     */
 
+    /**
+     * @param string $table
+     */
     public function __construct(Database $db, $table, $id = 'id')
     {
         $this->db = $db;
@@ -41,6 +44,10 @@ 
     // this should be called any time you insert into or delete from your hierarchical table
     // http://stackoverflow.com/questions/4664517/how-do-you-convert-a-parent-child-adjacency-table-to-a-nested-set-using-php-an
     // http://gen5.info/q/2008/11/04/nested-sets-php-verb-objects-and-noun-objects/
+
+    /**
+     * @param string $order
+     */
     public function refresh($order = null)
     {
         if (is_null($order)) {
@@ -150,6 +157,10 @@ 
         return $level;
     }
 
+    /**
+     * @param string $table
+     * @param string $match
+     */
     public function counts($table, $match, $id = null)
     {
         if (!is_null($id)) {
@@ -287,6 +298,9 @@ 
         return $children;
     }
 
+    /**
+     * @param integer $id
+     */
     private function traverse($id, $level = -1)
     {
         $lft = $this->count;
@@ -302,6 +316,9 @@ 
         $this->update[$id] = array('level' => $level, 'lft' => $lft, 'rgt' => $rgt);
     }
 
+    /**
+     * @param string $prefix
+     */
     private function fields($prefix, array $fields)
     {
         return $prefix.'.'.implode(', '.$prefix.'.', $fields);