joshtronic/pickles
1
0
Fork 0
Code Issues 8 Pull requests Projects Releases Packages Wiki Activity Actions

Cleaned up headers

Browse source
This commit is contained in:
Josh Sherman 2014-10-03 10:46:43 -04:00
parent 89fc175701
commit ae98b67683
18 changed files with 72 additions and 100 deletions
Download patch file Download diff file Expand all files Collapse all files

23
src/Auth.php
View file

@ -1,9 +1,32 @@
<?php
/**
* Auth Abstraction
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
/**
* Auth Abstract Class
*/
abstract class Auth extends Object
{
/**
* Basic Auth
*
* Implement this method when using 'basic' auth. Allows you to roll a
* custom solution based on your needs. Want to use username and password?
* Rather use an API key and not worry about the password? Do it. Return
* true when authentication is successful and false when it is not.
*/
public function basic()
{

7
src/Browser.php
View file

@ -3,16 +3,13 @@
/**
* Browser Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

11
src/Cache.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Caching System for PICKLES
*
* PHP version 5
* Caching System
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -26,7 +23,7 @@ namespace Pickles;
* don't entirely remember specifics, but the reason for not using Memcached()
* was due to an unexplainable bug in the version in the repository for Ubuntu
* 10.04 LTS. Memcached() does support more of the memcached protocol and will
* eventually be what PICKLES uses. Keys are forced to be uppercase for
* eventually be what Pickles uses. Keys are forced to be uppercase for
* consistencies sake as I've been burned by the case sensitivity due to typos
* in my code.
*

11
src/Config.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Configuration Class File for PICKLES
*
* PHP version 5
* Configuration
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -23,7 +20,7 @@ namespace Pickles;
* Handles loading the site's configuration file (if available). At the moment
* this class is a very skewed Singleton. The plan is to eventually extend this
* out to support multiple configuration files, and the ability to load in
* custom config files on the fly as well. The core of PICKLES uses the class
* custom config files on the fly as well. The core of Pickles uses the class
* as a Singleton so we're not loading the configuration multiple times per
* page load.
*/

7
src/Convert.php
View file

@ -3,16 +3,13 @@
/**
* Converter
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

9
src/Database.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Database Class File for PICKLES
*
* PHP version 5
* Database Abstraction Layer
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
* @todo Drop driver, hardcode drivers based on the type
* @todo More assumptions for the datasource variables
*/

7
src/Date.php
View file

@ -3,16 +3,13 @@
/**
* Date Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

7
src/Distance.php
View file

@ -3,16 +3,13 @@
/**
* Distance
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

7
src/File.php
View file

@ -3,16 +3,13 @@
/**
* File Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

15
src/Model.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Model Parent Class for PICKLES
*
* PHP version 5
* Model Parent Class
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -20,9 +17,9 @@ namespace Pickles;
/**
* Model Class
*
* This is a parent class that all PICKLES data models should be extending. When
* using the class as designed, objects will function as active record pattern
* objects.
* This is a parent class that all Pickles data models should be extending.
* When using the class as designed, objects will function as active record
* pattern objects.
*/
class Model extends Object
{

7
src/Number.php
View file

@ -3,16 +3,13 @@
/**
* Number Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

11
src/Object.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Object Class File for PICKLES
*
* PHP version 5
* Parent Object
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -20,7 +17,7 @@ namespace Pickles;
/**
* Object Class
*
* Every instantiated class in PICKLES should be extending this class. By doing
* Every instantiated class in Pickles should be extending this class. By doing
* so the class is automatically hooked into the profiler, and the object will
* have access to some common components as well.
*/

7
src/Profiler.php
View file

@ -3,16 +3,13 @@
/**
* Profiler
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

11
src/Resource.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Resource Class File for PICKLES
*
* PHP version 5
* Resource Class
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -20,7 +17,7 @@ namespace Pickles;
/**
* Resource Class
*
* This is a parent class that all PICKLES modules should be extending. Each
* This is a parent class that all Pickles modules should be extending. Each
* module can specify it's own meta data and whether or not a user must be
* properly authenticated to view the page. Currently any pages without a
* template are treated as pages being requested via AJAX and the return will

11
src/Router.php
View file

@ -1,18 +1,15 @@
<?php
/**
* Single Entry Router
*
* PHP version 5
* Endpoint Router
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;
@ -20,7 +17,7 @@ namespace Pickles;
/**
* Router Class
*
* The heavy lifter of PICKLES, makes the calls to get the session and
* The heavy lifter of Pickles, makes the calls to get the session and
* configuration loaded. Loads modules, serves up user authentication when the
* module asks for it, and loads the viewer that the module requested. Default
* values are present to make things easier on the user.

7
src/Sort.php
View file

@ -3,16 +3,13 @@
/**
* Sorting Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

7
src/String.php
View file

@ -3,16 +3,13 @@
/**
* String Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;

7
src/Time.php
View file

@ -3,16 +3,13 @@
/**
* Time Utility Collection
*
* PHP version 5
*
* Licensed under The MIT License
* Redistribution of these files must retain the above copyright notice.
*
* @author Josh Sherman <josh@gravityblvd.com>
* @copyright Copyright 2007-2014, Josh Sherman
* @license http://www.opensource.org/licenses/mit-license.html
* @package PICKLES
* @link https://github.com/joshtronic/pickles
* @link http://picklesphp.com
* @package Pickles
*/
namespace Pickles;