├── .gitignore
├── README.md
└── TouchyPHP.php


/.gitignore:
--------------------------------------------------------------------------------
1 | .project
2 | .settings/
3 | 


--------------------------------------------------------------------------------
/README.md:
--------------------------------------------------------------------------------
1 | Touchy™PHP
2 | ---------------
3 | 
4 | Touchy™PHP is a simple PHP class used by the DoAT team in convergence with [Touchy™BP](https://github.com/doat/TouchyBP).
5 | 
6 | USAGE
7 | ---------------
8 |      TouchyPHP::getFile($filename [, forceInclude])
9 | 


--------------------------------------------------------------------------------
/TouchyPHP.php:
--------------------------------------------------------------------------------
  1 | <?php
  2 | /* 
  3 |  * Copyright 2011 DoAT. All rights reserved.
  4 |  * 
  5 |  * Redistribution and use in source and binary forms, with or without modification, are
  6 |  * permitted provided that the following conditions are met:
  7 |  * 
  8 |  * 1. Redistributions of source code must retain the above copyright notice, this list of
  9 |  *      conditions and the following disclaimer.
 10 |  *
 11 |  *   2. Redistributions in binary form must reproduce the above copyright notice, this list
 12 |  *      of conditions and the following disclaimer in the documentation and/or other materials
 13 |  *      provided with the distribution.
 14 |  *
 15 |  * THIS SOFTWARE IS PROVIDED BY Do@ ``AS IS'' AND ANY EXPRESS OR IMPLIED
 16 |  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND
 17 |  * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> OR
 18 |  * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 19 |  * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 20 |  * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON
 21 |  * ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
 22 |  * NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF
 23 |  * ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 24 |  *
 25 |  * The views and conclusions contained in the software and documentation are those of the
 26 |  * authors and should not be interpreted as representing official policies, either expressed
 27 |  * or implied, of DoAT.
 28 |  */
 29 | 
 30 | class TouchyPHP {    
 31 |     /**
 32 |     * constructor
 33 |     */
 34 |     public function __construct() {}
 35 | 
 36 |     
 37 |     /**
 38 |      * Returns the contents of the css/js/image file
 39 |      * @param <string> $filename
 40 |      * @param <boolean> $forceInclude {optional}
 41 |      * If set to true or not set, the function returns manipulated content.
 42 |      * If set to false, the function returns original $filename (inside appropriate HTML tag)
 43 |      * @return <string>
 44 |      */
 45 |     public function getFile($filename, $forceInclude = null){
 46 |         $value = $filename;
 47 |         
 48 |         // get file extension
 49 |         $format = pathinfo($filename, PATHINFO_EXTENSION);
 50 |         
 51 |         if ($forceInclude !== false){
 52 |             switch ($format){
 53 |                 case 'css':
 54 |                 case 'js':                    
 55 |                     // get file content
 56 |                     $content = file_get_contents($filename);
 57 |                     
 58 |                     // set content within <script> tag
 59 |                     $value = self::_getInternalTag($filename, $format, $content);
 60 |                 default:
 61 |                     // If the file is local (too risky and slow to let the server fetch files form the web)
 62 |                     // if filename can be converted to image data URI
 63 |                     if (self::_isLocalFile($filename) && self::_canConvertToImageDataURI($format) ){
 64 |                          // Remove trailing querystring
 65 |                         if (strrpos($filename, '?')){
 66 |                             $filename = substr($filename, 0, strrpos($filename, '?'));
 67 |                         }
 68 |                         // get file content
 69 |                         $content = file_get_contents($filename);
 70 |                         
 71 |                         // set base64 data
 72 |                         $value = self::_getImageDataURI($format, $content);
 73 |                     }
 74 |             }
 75 |         }
 76 |         else {
 77 |             switch ($format){
 78 |                 case 'css':
 79 |                 case 'js':
 80 |                     // set content within <script>/<link> tag
 81 |                     $value = self::_getExternalTag($format, $filename);
 82 |                     break;
 83 |             }
 84 |         }
 85 |         return $value;
 86 |     }
 87 | 
 88 |     /**
 89 |      * Returns if a filepath specified is relative or absolute 
 90 |      * @param <string> $filename
 91 |      * @return <boolean>
 92 |      */
 93 |     private function _isLocalFile($filename) {
 94 |         return !(preg_match("/(https?:\/\/)/i", $filename));
 95 |     }
 96 |     
 97 |     /**
 98 |      * Gets an image filename and returns if it can be converted to base64
 99 |      * @param <string> $filename
100 |      * @return <boolean>
101 |      */
102 |     private function _canConvertToImageDataURI($format) {
103 |         return preg_match("/(jpe?g|jpe|png|gif|bmp)(\?.*)?$/i", $format);
104 |     }
105 |     
106 |     /**
107 |      * Gets an image filename and returns it converted to base64 data string
108 |      * @param <string> $format
109 |      * @param <string> $content
110 |      * @return <string> image data URI
111 |      */
112 |     private static function _getImageDataURI($format, $content) {        
113 |         // encode
114 |         $data = base64_encode($content);
115 | 
116 |         // return the image URI
117 |         return 'data:image/'.$format.';base64,'.$data;
118 |     }
119 | 
120 |     /**
121 |      * Searches for url(filepath) in content and returns manipulated according to php page location
122 |      * @param <string> $format
123 |      * @param <string> $content
124 |      * @ignore
125 |      */
126 |     private static function _replaceImageUrls($filepath, $content){
127 |         $content = preg_replace_callback('/url\([\'"]?([^\^(https?:\/\/))\'"]+)/',
128 |                                         function($m) use ($filepath){
129 |                                             $newPath = explode("/", $filepath);
130 |                                             unset($newPath[count($newPath)-1]);
131 |                                             $newPath = implode("/", $newPath) . "/" . $m[1];
132 |                                             return str_replace($m[1], $newPath, $m[0]);
133 |                                             
134 |                                         },
135 |                                         $content);
136 |         return $content;
137 |     }
138 |     
139 |     /**
140 |      * Returns HTML tag according to format, pointing to an external resource
141 |      * @param <string> $format
142 |      * @param <string> $filename
143 |      * @return <string> HTML tag
144 |      */
145 |     private static function _getExternalTag($format, $filename){
146 |         switch ($format) {
147 |             case 'css':
148 |                 $template = '<link href="{$filename}" rel="stylesheet" type="text/css" />';
149 |                 break;
150 |             case 'js':
151 |                 $template = '<script src="{$filename}" type="text/javascript"></script>';
152 |         }
153 |     
154 |         return str_replace('{$filename}', $filename, $template);
155 |     }
156 |     
157 |     /**
158 |      * Returns HTML tag according to format, including content
159 |      * @param <string> $format
160 |      * @param <string> $content
161 |      * @return <string> HTML tag
162 |      */
163 |     private static function _getInternalTag($filename, $format, $content){
164 |         switch ($format){
165 |             case 'css':
166 |                 $template = '<style type="text/css">{content}</style>';
167 |                 $content = self::_replaceImageUrls($filename, $content);
168 |                 break;
169 |             case 'js':
170 |                 $template = '<script type="text/javascript">{content}</script>';
171 |                 break;
172 |         }
173 |     
174 |         return str_replace('{content}', $content, $template);
175 |     }
176 | }


--------------------------------------------------------------------------------