40 | * @see http://www.php-fig.org/psr/psr-0/
41 | * @see http://www.php-fig.org/psr/psr-4/
42 | */
43 | class ClassLoader
44 | {
45 | // PSR-4
46 | private $prefixLengthsPsr4 = array();
47 | private $prefixDirsPsr4 = array();
48 | private $fallbackDirsPsr4 = array();
49 |
50 | // PSR-0
51 | private $prefixesPsr0 = array();
52 | private $fallbackDirsPsr0 = array();
53 |
54 | private $useIncludePath = false;
55 | private $classMap = array();
56 | private $classMapAuthoritative = false;
57 | private $missingClasses = array();
58 | private $apcuPrefix;
59 |
60 | public function getPrefixes()
61 | {
62 | if (!empty($this->prefixesPsr0)) {
63 | return call_user_func_array('array_merge', $this->prefixesPsr0);
64 | }
65 |
66 | return array();
67 | }
68 |
69 | public function getPrefixesPsr4()
70 | {
71 | return $this->prefixDirsPsr4;
72 | }
73 |
74 | public function getFallbackDirs()
75 | {
76 | return $this->fallbackDirsPsr0;
77 | }
78 |
79 | public function getFallbackDirsPsr4()
80 | {
81 | return $this->fallbackDirsPsr4;
82 | }
83 |
84 | public function getClassMap()
85 | {
86 | return $this->classMap;
87 | }
88 |
89 | /**
90 | * @param array $classMap Class to filename map
91 | */
92 | public function addClassMap(array $classMap)
93 | {
94 | if ($this->classMap) {
95 | $this->classMap = array_merge($this->classMap, $classMap);
96 | } else {
97 | $this->classMap = $classMap;
98 | }
99 | }
100 |
101 | /**
102 | * Registers a set of PSR-0 directories for a given prefix, either
103 | * appending or prepending to the ones previously set for this prefix.
104 | *
105 | * @param string $prefix The prefix
106 | * @param array|string $paths The PSR-0 root directories
107 | * @param bool $prepend Whether to prepend the directories
108 | */
109 | public function add($prefix, $paths, $prepend = false)
110 | {
111 | if (!$prefix) {
112 | if ($prepend) {
113 | $this->fallbackDirsPsr0 = array_merge(
114 | (array) $paths,
115 | $this->fallbackDirsPsr0
116 | );
117 | } else {
118 | $this->fallbackDirsPsr0 = array_merge(
119 | $this->fallbackDirsPsr0,
120 | (array) $paths
121 | );
122 | }
123 |
124 | return;
125 | }
126 |
127 | $first = $prefix[0];
128 | if (!isset($this->prefixesPsr0[$first][$prefix])) {
129 | $this->prefixesPsr0[$first][$prefix] = (array) $paths;
130 |
131 | return;
132 | }
133 | if ($prepend) {
134 | $this->prefixesPsr0[$first][$prefix] = array_merge(
135 | (array) $paths,
136 | $this->prefixesPsr0[$first][$prefix]
137 | );
138 | } else {
139 | $this->prefixesPsr0[$first][$prefix] = array_merge(
140 | $this->prefixesPsr0[$first][$prefix],
141 | (array) $paths
142 | );
143 | }
144 | }
145 |
146 | /**
147 | * Registers a set of PSR-4 directories for a given namespace, either
148 | * appending or prepending to the ones previously set for this namespace.
149 | *
150 | * @param string $prefix The prefix/namespace, with trailing '\\'
151 | * @param array|string $paths The PSR-4 base directories
152 | * @param bool $prepend Whether to prepend the directories
153 | *
154 | * @throws \InvalidArgumentException
155 | */
156 | public function addPsr4($prefix, $paths, $prepend = false)
157 | {
158 | if (!$prefix) {
159 | // Register directories for the root namespace.
160 | if ($prepend) {
161 | $this->fallbackDirsPsr4 = array_merge(
162 | (array) $paths,
163 | $this->fallbackDirsPsr4
164 | );
165 | } else {
166 | $this->fallbackDirsPsr4 = array_merge(
167 | $this->fallbackDirsPsr4,
168 | (array) $paths
169 | );
170 | }
171 | } elseif (!isset($this->prefixDirsPsr4[$prefix])) {
172 | // Register directories for a new namespace.
173 | $length = strlen($prefix);
174 | if ('\\' !== $prefix[$length - 1]) {
175 | throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
176 | }
177 | $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
178 | $this->prefixDirsPsr4[$prefix] = (array) $paths;
179 | } elseif ($prepend) {
180 | // Prepend directories for an already registered namespace.
181 | $this->prefixDirsPsr4[$prefix] = array_merge(
182 | (array) $paths,
183 | $this->prefixDirsPsr4[$prefix]
184 | );
185 | } else {
186 | // Append directories for an already registered namespace.
187 | $this->prefixDirsPsr4[$prefix] = array_merge(
188 | $this->prefixDirsPsr4[$prefix],
189 | (array) $paths
190 | );
191 | }
192 | }
193 |
194 | /**
195 | * Registers a set of PSR-0 directories for a given prefix,
196 | * replacing any others previously set for this prefix.
197 | *
198 | * @param string $prefix The prefix
199 | * @param array|string $paths The PSR-0 base directories
200 | */
201 | public function set($prefix, $paths)
202 | {
203 | if (!$prefix) {
204 | $this->fallbackDirsPsr0 = (array) $paths;
205 | } else {
206 | $this->prefixesPsr0[$prefix[0]][$prefix] = (array) $paths;
207 | }
208 | }
209 |
210 | /**
211 | * Registers a set of PSR-4 directories for a given namespace,
212 | * replacing any others previously set for this namespace.
213 | *
214 | * @param string $prefix The prefix/namespace, with trailing '\\'
215 | * @param array|string $paths The PSR-4 base directories
216 | *
217 | * @throws \InvalidArgumentException
218 | */
219 | public function setPsr4($prefix, $paths)
220 | {
221 | if (!$prefix) {
222 | $this->fallbackDirsPsr4 = (array) $paths;
223 | } else {
224 | $length = strlen($prefix);
225 | if ('\\' !== $prefix[$length - 1]) {
226 | throw new \InvalidArgumentException("A non-empty PSR-4 prefix must end with a namespace separator.");
227 | }
228 | $this->prefixLengthsPsr4[$prefix[0]][$prefix] = $length;
229 | $this->prefixDirsPsr4[$prefix] = (array) $paths;
230 | }
231 | }
232 |
233 | /**
234 | * Turns on searching the include path for class files.
235 | *
236 | * @param bool $useIncludePath
237 | */
238 | public function setUseIncludePath($useIncludePath)
239 | {
240 | $this->useIncludePath = $useIncludePath;
241 | }
242 |
243 | /**
244 | * Can be used to check if the autoloader uses the include path to check
245 | * for classes.
246 | *
247 | * @return bool
248 | */
249 | public function getUseIncludePath()
250 | {
251 | return $this->useIncludePath;
252 | }
253 |
254 | /**
255 | * Turns off searching the prefix and fallback directories for classes
256 | * that have not been registered with the class map.
257 | *
258 | * @param bool $classMapAuthoritative
259 | */
260 | public function setClassMapAuthoritative($classMapAuthoritative)
261 | {
262 | $this->classMapAuthoritative = $classMapAuthoritative;
263 | }
264 |
265 | /**
266 | * Should class lookup fail if not found in the current class map?
267 | *
268 | * @return bool
269 | */
270 | public function isClassMapAuthoritative()
271 | {
272 | return $this->classMapAuthoritative;
273 | }
274 |
275 | /**
276 | * APCu prefix to use to cache found/not-found classes, if the extension is enabled.
277 | *
278 | * @param string|null $apcuPrefix
279 | */
280 | public function setApcuPrefix($apcuPrefix)
281 | {
282 | $this->apcuPrefix = function_exists('apcu_fetch') && ini_get('apc.enabled') ? $apcuPrefix : null;
283 | }
284 |
285 | /**
286 | * The APCu prefix in use, or null if APCu caching is not enabled.
287 | *
288 | * @return string|null
289 | */
290 | public function getApcuPrefix()
291 | {
292 | return $this->apcuPrefix;
293 | }
294 |
295 | /**
296 | * Registers this instance as an autoloader.
297 | *
298 | * @param bool $prepend Whether to prepend the autoloader or not
299 | */
300 | public function register($prepend = false)
301 | {
302 | spl_autoload_register(array($this, 'loadClass'), true, $prepend);
303 | }
304 |
305 | /**
306 | * Unregisters this instance as an autoloader.
307 | */
308 | public function unregister()
309 | {
310 | spl_autoload_unregister(array($this, 'loadClass'));
311 | }
312 |
313 | /**
314 | * Loads the given class or interface.
315 | *
316 | * @param string $class The name of the class
317 | * @return bool|null True if loaded, null otherwise
318 | */
319 | public function loadClass($class)
320 | {
321 | if ($file = $this->findFile($class)) {
322 | includeFile($file);
323 |
324 | return true;
325 | }
326 | }
327 |
328 | /**
329 | * Finds the path to the file where the class is defined.
330 | *
331 | * @param string $class The name of the class
332 | *
333 | * @return string|false The path if found, false otherwise
334 | */
335 | public function findFile($class)
336 | {
337 | // class map lookup
338 | if (isset($this->classMap[$class])) {
339 | return $this->classMap[$class];
340 | }
341 | if ($this->classMapAuthoritative || isset($this->missingClasses[$class])) {
342 | return false;
343 | }
344 | if (null !== $this->apcuPrefix) {
345 | $file = apcu_fetch($this->apcuPrefix.$class, $hit);
346 | if ($hit) {
347 | return $file;
348 | }
349 | }
350 |
351 | $file = $this->findFileWithExtension($class, '.php');
352 |
353 | // Search for Hack files if we are running on HHVM
354 | if (false === $file && defined('HHVM_VERSION')) {
355 | $file = $this->findFileWithExtension($class, '.hh');
356 | }
357 |
358 | if (null !== $this->apcuPrefix) {
359 | apcu_add($this->apcuPrefix.$class, $file);
360 | }
361 |
362 | if (false === $file) {
363 | // Remember that this class does not exist.
364 | $this->missingClasses[$class] = true;
365 | }
366 |
367 | return $file;
368 | }
369 |
370 | private function findFileWithExtension($class, $ext)
371 | {
372 | // PSR-4 lookup
373 | $logicalPathPsr4 = strtr($class, '\\', DIRECTORY_SEPARATOR) . $ext;
374 |
375 | $first = $class[0];
376 | if (isset($this->prefixLengthsPsr4[$first])) {
377 | $subPath = $class;
378 | while (false !== $lastPos = strrpos($subPath, '\\')) {
379 | $subPath = substr($subPath, 0, $lastPos);
380 | $search = $subPath.'\\';
381 | if (isset($this->prefixDirsPsr4[$search])) {
382 | foreach ($this->prefixDirsPsr4[$search] as $dir) {
383 | $length = $this->prefixLengthsPsr4[$first][$search];
384 | if (file_exists($file = $dir . DIRECTORY_SEPARATOR . substr($logicalPathPsr4, $length))) {
385 | return $file;
386 | }
387 | }
388 | }
389 | }
390 | }
391 |
392 | // PSR-4 fallback dirs
393 | foreach ($this->fallbackDirsPsr4 as $dir) {
394 | if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr4)) {
395 | return $file;
396 | }
397 | }
398 |
399 | // PSR-0 lookup
400 | if (false !== $pos = strrpos($class, '\\')) {
401 | // namespaced class name
402 | $logicalPathPsr0 = substr($logicalPathPsr4, 0, $pos + 1)
403 | . strtr(substr($logicalPathPsr4, $pos + 1), '_', DIRECTORY_SEPARATOR);
404 | } else {
405 | // PEAR-like class name
406 | $logicalPathPsr0 = strtr($class, '_', DIRECTORY_SEPARATOR) . $ext;
407 | }
408 |
409 | if (isset($this->prefixesPsr0[$first])) {
410 | foreach ($this->prefixesPsr0[$first] as $prefix => $dirs) {
411 | if (0 === strpos($class, $prefix)) {
412 | foreach ($dirs as $dir) {
413 | if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
414 | return $file;
415 | }
416 | }
417 | }
418 | }
419 | }
420 |
421 | // PSR-0 fallback dirs
422 | foreach ($this->fallbackDirsPsr0 as $dir) {
423 | if (file_exists($file = $dir . DIRECTORY_SEPARATOR . $logicalPathPsr0)) {
424 | return $file;
425 | }
426 | }
427 |
428 | // PSR-0 include paths.
429 | if ($this->useIncludePath && $file = stream_resolve_include_path($logicalPathPsr0)) {
430 | return $file;
431 | }
432 |
433 | return false;
434 | }
435 | }
436 |
437 | /**
438 | * Scope isolated include.
439 | *
440 | * Prevents access to $this/self from included files.
441 | */
442 | function includeFile($file)
443 | {
444 | include $file;
445 | }
446 |
--------------------------------------------------------------------------------
/LICENSE:
--------------------------------------------------------------------------------
1 | GNU GENERAL PUBLIC LICENSE
2 | Version 2, June 1991
3 |
4 | Copyright (C) 1989, 1991 Free Software Foundation, Inc.,
5 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
6 | Everyone is permitted to copy and distribute verbatim copies
7 | of this license document, but changing it is not allowed.
8 |
9 | Preamble
10 |
11 | The licenses for most software are designed to take away your
12 | freedom to share and change it. By contrast, the GNU General Public
13 | License is intended to guarantee your freedom to share and change free
14 | software--to make sure the software is free for all its users. This
15 | General Public License applies to most of the Free Software
16 | Foundation's software and to any other program whose authors commit to
17 | using it. (Some other Free Software Foundation software is covered by
18 | the GNU Lesser General Public License instead.) You can apply it to
19 | your programs, too.
20 |
21 | When we speak of free software, we are referring to freedom, not
22 | price. Our General Public Licenses are designed to make sure that you
23 | have the freedom to distribute copies of free software (and charge for
24 | this service if you wish), that you receive source code or can get it
25 | if you want it, that you can change the software or use pieces of it
26 | in new free programs; and that you know you can do these things.
27 |
28 | To protect your rights, we need to make restrictions that forbid
29 | anyone to deny you these rights or to ask you to surrender the rights.
30 | These restrictions translate to certain responsibilities for you if you
31 | distribute copies of the software, or if you modify it.
32 |
33 | For example, if you distribute copies of such a program, whether
34 | gratis or for a fee, you must give the recipients all the rights that
35 | you have. You must make sure that they, too, receive or can get the
36 | source code. And you must show them these terms so they know their
37 | rights.
38 |
39 | We protect your rights with two steps: (1) copyright the software, and
40 | (2) offer you this license which gives you legal permission to copy,
41 | distribute and/or modify the software.
42 |
43 | Also, for each author's protection and ours, we want to make certain
44 | that everyone understands that there is no warranty for this free
45 | software. If the software is modified by someone else and passed on, we
46 | want its recipients to know that what they have is not the original, so
47 | that any problems introduced by others will not reflect on the original
48 | authors' reputations.
49 |
50 | Finally, any free program is threatened constantly by software
51 | patents. We wish to avoid the danger that redistributors of a free
52 | program will individually obtain patent licenses, in effect making the
53 | program proprietary. To prevent this, we have made it clear that any
54 | patent must be licensed for everyone's free use or not licensed at all.
55 |
56 | The precise terms and conditions for copying, distribution and
57 | modification follow.
58 |
59 | GNU GENERAL PUBLIC LICENSE
60 | TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
61 |
62 | 0. This License applies to any program or other work which contains
63 | a notice placed by the copyright holder saying it may be distributed
64 | under the terms of this General Public License. The "Program", below,
65 | refers to any such program or work, and a "work based on the Program"
66 | means either the Program or any derivative work under copyright law:
67 | that is to say, a work containing the Program or a portion of it,
68 | either verbatim or with modifications and/or translated into another
69 | language. (Hereinafter, translation is included without limitation in
70 | the term "modification".) Each licensee is addressed as "you".
71 |
72 | Activities other than copying, distribution and modification are not
73 | covered by this License; they are outside its scope. The act of
74 | running the Program is not restricted, and the output from the Program
75 | is covered only if its contents constitute a work based on the
76 | Program (independent of having been made by running the Program).
77 | Whether that is true depends on what the Program does.
78 |
79 | 1. You may copy and distribute verbatim copies of the Program's
80 | source code as you receive it, in any medium, provided that you
81 | conspicuously and appropriately publish on each copy an appropriate
82 | copyright notice and disclaimer of warranty; keep intact all the
83 | notices that refer to this License and to the absence of any warranty;
84 | and give any other recipients of the Program a copy of this License
85 | along with the Program.
86 |
87 | You may charge a fee for the physical act of transferring a copy, and
88 | you may at your option offer warranty protection in exchange for a fee.
89 |
90 | 2. You may modify your copy or copies of the Program or any portion
91 | of it, thus forming a work based on the Program, and copy and
92 | distribute such modifications or work under the terms of Section 1
93 | above, provided that you also meet all of these conditions:
94 |
95 | a) You must cause the modified files to carry prominent notices
96 | stating that you changed the files and the date of any change.
97 |
98 | b) You must cause any work that you distribute or publish, that in
99 | whole or in part contains or is derived from the Program or any
100 | part thereof, to be licensed as a whole at no charge to all third
101 | parties under the terms of this License.
102 |
103 | c) If the modified program normally reads commands interactively
104 | when run, you must cause it, when started running for such
105 | interactive use in the most ordinary way, to print or display an
106 | announcement including an appropriate copyright notice and a
107 | notice that there is no warranty (or else, saying that you provide
108 | a warranty) and that users may redistribute the program under
109 | these conditions, and telling the user how to view a copy of this
110 | License. (Exception: if the Program itself is interactive but
111 | does not normally print such an announcement, your work based on
112 | the Program is not required to print an announcement.)
113 |
114 | These requirements apply to the modified work as a whole. If
115 | identifiable sections of that work are not derived from the Program,
116 | and can be reasonably considered independent and separate works in
117 | themselves, then this License, and its terms, do not apply to those
118 | sections when you distribute them as separate works. But when you
119 | distribute the same sections as part of a whole which is a work based
120 | on the Program, the distribution of the whole must be on the terms of
121 | this License, whose permissions for other licensees extend to the
122 | entire whole, and thus to each and every part regardless of who wrote it.
123 |
124 | Thus, it is not the intent of this section to claim rights or contest
125 | your rights to work written entirely by you; rather, the intent is to
126 | exercise the right to control the distribution of derivative or
127 | collective works based on the Program.
128 |
129 | In addition, mere aggregation of another work not based on the Program
130 | with the Program (or with a work based on the Program) on a volume of
131 | a storage or distribution medium does not bring the other work under
132 | the scope of this License.
133 |
134 | 3. You may copy and distribute the Program (or a work based on it,
135 | under Section 2) in object code or executable form under the terms of
136 | Sections 1 and 2 above provided that you also do one of the following:
137 |
138 | a) Accompany it with the complete corresponding machine-readable
139 | source code, which must be distributed under the terms of Sections
140 | 1 and 2 above on a medium customarily used for software interchange; or,
141 |
142 | b) Accompany it with a written offer, valid for at least three
143 | years, to give any third party, for a charge no more than your
144 | cost of physically performing source distribution, a complete
145 | machine-readable copy of the corresponding source code, to be
146 | distributed under the terms of Sections 1 and 2 above on a medium
147 | customarily used for software interchange; or,
148 |
149 | c) Accompany it with the information you received as to the offer
150 | to distribute corresponding source code. (This alternative is
151 | allowed only for noncommercial distribution and only if you
152 | received the program in object code or executable form with such
153 | an offer, in accord with Subsection b above.)
154 |
155 | The source code for a work means the preferred form of the work for
156 | making modifications to it. For an executable work, complete source
157 | code means all the source code for all modules it contains, plus any
158 | associated interface definition files, plus the scripts used to
159 | control compilation and installation of the executable. However, as a
160 | special exception, the source code distributed need not include
161 | anything that is normally distributed (in either source or binary
162 | form) with the major components (compiler, kernel, and so on) of the
163 | operating system on which the executable runs, unless that component
164 | itself accompanies the executable.
165 |
166 | If distribution of executable or object code is made by offering
167 | access to copy from a designated place, then offering equivalent
168 | access to copy the source code from the same place counts as
169 | distribution of the source code, even though third parties are not
170 | compelled to copy the source along with the object code.
171 |
172 | 4. You may not copy, modify, sublicense, or distribute the Program
173 | except as expressly provided under this License. Any attempt
174 | otherwise to copy, modify, sublicense or distribute the Program is
175 | void, and will automatically terminate your rights under this License.
176 | However, parties who have received copies, or rights, from you under
177 | this License will not have their licenses terminated so long as such
178 | parties remain in full compliance.
179 |
180 | 5. You are not required to accept this License, since you have not
181 | signed it. However, nothing else grants you permission to modify or
182 | distribute the Program or its derivative works. These actions are
183 | prohibited by law if you do not accept this License. Therefore, by
184 | modifying or distributing the Program (or any work based on the
185 | Program), you indicate your acceptance of this License to do so, and
186 | all its terms and conditions for copying, distributing or modifying
187 | the Program or works based on it.
188 |
189 | 6. Each time you redistribute the Program (or any work based on the
190 | Program), the recipient automatically receives a license from the
191 | original licensor to copy, distribute or modify the Program subject to
192 | these terms and conditions. You may not impose any further
193 | restrictions on the recipients' exercise of the rights granted herein.
194 | You are not responsible for enforcing compliance by third parties to
195 | this License.
196 |
197 | 7. If, as a consequence of a court judgment or allegation of patent
198 | infringement or for any other reason (not limited to patent issues),
199 | conditions are imposed on you (whether by court order, agreement or
200 | otherwise) that contradict the conditions of this License, they do not
201 | excuse you from the conditions of this License. If you cannot
202 | distribute so as to satisfy simultaneously your obligations under this
203 | License and any other pertinent obligations, then as a consequence you
204 | may not distribute the Program at all. For example, if a patent
205 | license would not permit royalty-free redistribution of the Program by
206 | all those who receive copies directly or indirectly through you, then
207 | the only way you could satisfy both it and this License would be to
208 | refrain entirely from distribution of the Program.
209 |
210 | If any portion of this section is held invalid or unenforceable under
211 | any particular circumstance, the balance of the section is intended to
212 | apply and the section as a whole is intended to apply in other
213 | circumstances.
214 |
215 | It is not the purpose of this section to induce you to infringe any
216 | patents or other property right claims or to contest validity of any
217 | such claims; this section has the sole purpose of protecting the
218 | integrity of the free software distribution system, which is
219 | implemented by public license practices. Many people have made
220 | generous contributions to the wide range of software distributed
221 | through that system in reliance on consistent application of that
222 | system; it is up to the author/donor to decide if he or she is willing
223 | to distribute software through any other system and a licensee cannot
224 | impose that choice.
225 |
226 | This section is intended to make thoroughly clear what is believed to
227 | be a consequence of the rest of this License.
228 |
229 | 8. If the distribution and/or use of the Program is restricted in
230 | certain countries either by patents or by copyrighted interfaces, the
231 | original copyright holder who places the Program under this License
232 | may add an explicit geographical distribution limitation excluding
233 | those countries, so that distribution is permitted only in or among
234 | countries not thus excluded. In such case, this License incorporates
235 | the limitation as if written in the body of this License.
236 |
237 | 9. The Free Software Foundation may publish revised and/or new versions
238 | of the General Public License from time to time. Such new versions will
239 | be similar in spirit to the present version, but may differ in detail to
240 | address new problems or concerns.
241 |
242 | Each version is given a distinguishing version number. If the Program
243 | specifies a version number of this License which applies to it and "any
244 | later version", you have the option of following the terms and conditions
245 | either of that version or of any later version published by the Free
246 | Software Foundation. If the Program does not specify a version number of
247 | this License, you may choose any version ever published by the Free Software
248 | Foundation.
249 |
250 | 10. If you wish to incorporate parts of the Program into other free
251 | programs whose distribution conditions are different, write to the author
252 | to ask for permission. For software which is copyrighted by the Free
253 | Software Foundation, write to the Free Software Foundation; we sometimes
254 | make exceptions for this. Our decision will be guided by the two goals
255 | of preserving the free status of all derivatives of our free software and
256 | of promoting the sharing and reuse of software generally.
257 |
258 | NO WARRANTY
259 |
260 | 11. BECAUSE THE PROGRAM IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY
261 | FOR THE PROGRAM, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN
262 | OTHERWISE STATED IN WRITING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES
263 | PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED
264 | OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
265 | MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. THE ENTIRE RISK AS
266 | TO THE QUALITY AND PERFORMANCE OF THE PROGRAM IS WITH YOU. SHOULD THE
267 | PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY SERVICING,
268 | REPAIR OR CORRECTION.
269 |
270 | 12. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
271 | WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR
272 | REDISTRIBUTE THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES,
273 | INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING
274 | OUT OF THE USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED
275 | TO LOSS OF DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY
276 | YOU OR THIRD PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER
277 | PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE
278 | POSSIBILITY OF SUCH DAMAGES.
279 |
280 | END OF TERMS AND CONDITIONS
281 |
282 | How to Apply These Terms to Your New Programs
283 |
284 | If you develop a new program, and you want it to be of the greatest
285 | possible use to the public, the best way to achieve this is to make it
286 | free software which everyone can redistribute and change under these terms.
287 |
288 | To do so, attach the following notices to the program. It is safest
289 | to attach them to the start of each source file to most effectively
290 | convey the exclusion of warranty; and each file should have at least
291 | the "copyright" line and a pointer to where the full notice is found.
292 |
293 | {description}
294 | Copyright (C) {year} {fullname}
295 |
296 | This program is free software; you can redistribute it and/or modify
297 | it under the terms of the GNU General Public License as published by
298 | the Free Software Foundation; either version 2 of the License, or
299 | (at your option) any later version.
300 |
301 | This program is distributed in the hope that it will be useful,
302 | but WITHOUT ANY WARRANTY; without even the implied warranty of
303 | MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
304 | GNU General Public License for more details.
305 |
306 | You should have received a copy of the GNU General Public License along
307 | with this program; if not, write to the Free Software Foundation, Inc.,
308 | 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
309 |
310 | Also add information on how to contact you by electronic and paper mail.
311 |
312 | If the program is interactive, make it output a short notice like this
313 | when it starts in an interactive mode:
314 |
315 | Gnomovision version 69, Copyright (C) year name of author
316 | Gnomovision comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
317 | This is free software, and you are welcome to redistribute it
318 | under certain conditions; type `show c' for details.
319 |
320 | The hypothetical commands `show w' and `show c' should show the appropriate
321 | parts of the General Public License. Of course, the commands you use may
322 | be called something other than `show w' and `show c'; they could even be
323 | mouse-clicks or menu items--whatever suits your program.
324 |
325 | You should also get your employer (if you work as a programmer) or your
326 | school, if any, to sign a "copyright disclaimer" for the program, if
327 | necessary. Here is a sample; alter the names:
328 |
329 | Yoyodyne, Inc., hereby disclaims all copyright interest in the program
330 | `Gnomovision' (which makes passes at compilers) written by James Hacker.
331 |
332 | {signature of Ty Coon}, 1 April 1989
333 | Ty Coon, President of Vice
334 |
335 | This General Public License does not permit incorporating your program into
336 | proprietary programs. If your program is a subroutine library, you may
337 | consider it more useful to permit linking proprietary applications with the
338 | library. If this is what you want to do, use the GNU Lesser General
339 | Public License instead of this License.
340 |
341 |
--------------------------------------------------------------------------------
/includes/class-arabic-webfonts.php:
--------------------------------------------------------------------------------
1 | add(array(
63 | array(
64 | 'awf-controls' => '' . __('All Controls', 'arabic-webfonts') . '',
65 | ),
66 | array(
67 | 'more-plugins' => '' . __('More Plugins', 'arabic-webfonts') . '',
68 | ),
69 | ));
70 |
71 | $this->plugin_name = 'arabic-webfonts';
72 | $this->version = '1.4.6';
73 | $this->fonts = $this->get_fonts();
74 |
75 | $this->load_customizer();
76 | $this->get_post_type();
77 |
78 | add_action( 'wp_head' , array( $this, 'header_output' ) );
79 | add_action( 'wp_enqueue_scripts' , array( $this, 'enqueue_style' ) );
80 | add_action( 'customize_controls_enqueue_scripts' , array( $this, 'customize_controls_script' ) );
81 | add_action( 'customize_preview_init' , array( $this, 'live_preview' ) );
82 | add_action( 'wp_ajax_reset_customizer_settings', array( $this, 'ajax_reset_customizer_settings' ) );
83 | add_action( 'wp_footer', array( $this, 'custom_footer_actions' ), 9999, 0 );
84 | add_action( 'wp_footer_preview', array( $this, 'custom_css_selectors_live_preview' ), 9999, 0 );
85 |
86 | }
87 |
88 | /**
89 | * The code that runs during plugin activation.
90 | *
91 | * @since 1.0
92 | * @access public static
93 | */
94 | public static function activate() {
95 |
96 | // get wp version
97 | global $wp_version;
98 |
99 | // compatible version (or later)
100 | $wp_compatible_version = '4.0';
101 |
102 | if ( version_compare( $wp_version, $wp_compatible_version, '<' ) ) {
103 |
104 | deactivate_plugins( basename( __FILE__ ) );
105 | wp_die(
106 | '' .
107 | sprintf(
108 | __( 'This plugin can not be activated because it requires a WordPress version at least %1$s (or later). Please go to Dashboard ▸ Updates to get the latest version of WordPress.', 'arabic-webfonts' ),
109 | $wp_compatible_version
110 | )
111 | . '
' . __( 'go back', 'arabic-webfonts' ) . ''
112 | );
113 |
114 | }
115 |
116 | }
117 |
118 | /**
119 | * The code that runs during plugin deactivation.
120 | *
121 | * @since 1.0
122 | * @access public static
123 | */
124 | public static function deactivate() {
125 |
126 | // delete transients
127 | delete_transient( 'awf-get-fonts' );
128 |
129 | }
130 |
131 | /**
132 | * Get all fonts from fontface.me API.
133 | *
134 | * @since 1.2
135 | * @access public
136 | */
137 | public function get_fonts() {
138 |
139 | // name of transient in database
140 | $transName = 'awf-get-fonts';
141 |
142 | // time in days between updates, set to 2 days
143 | $cacheTime = 2 * DAY_IN_SECONDS;
144 |
145 | // get cached fonts
146 | $content = get_transient( $transName );
147 |
148 | // check for transient. If none, then get all fonts from API
149 | if( $content === false ) {
150 |
151 | // get all fonts from API json content
152 | $fontfaceApi = 'http://fontface.me/font/all';
153 | $fontsContent = wp_remote_get( $fontfaceApi, array('sslverify' => false) );
154 |
155 | // check if it is not a valid request
156 | if( is_wp_error( $fontsContent ) ) {
157 |
158 | return;
159 |
160 | } else {
161 |
162 | $content = json_decode($fontsContent['body'], true);
163 | set_transient($transName, $content, $cacheTime);
164 |
165 | }
166 |
167 | }
168 |
169 | return $content;
170 |
171 | }
172 |
173 | /**
174 | * Load the customizer api.
175 | *
176 | * @since 1.0
177 | * @access private
178 | */
179 | private function load_customizer() {
180 |
181 | require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-arabic-webfonts-customizer.php';
182 | new AWF_Customizer( $this->plugin_name, $this->fonts );
183 |
184 | }
185 |
186 | /**
187 | * Get the custom post type [ awf_font_control ].
188 | *
189 | * @since 1.0
190 | * @access private
191 | */
192 | private function get_post_type() {
193 |
194 | require_once plugin_dir_path( dirname( __FILE__ ) ) . 'includes/class-arabic-webfonts-post-type.php';
195 | new AWF_Post_Type( $this->plugin_name );
196 |
197 | }
198 |
199 | /**
200 | * Get all font controls ids from custom post type [ awf_font_control ].
201 | *
202 | * @since 1.0
203 | * @access private
204 | */
205 | private function get_custom_controls_ids() {
206 |
207 | // check if any controls exists
208 | $custom_controls = get_posts( array('post_type' => 'awf_font_control', 'posts_per_page' => -1) );
209 |
210 | if($custom_controls) {
211 |
212 | // get all controls ids
213 | $custom_controls_ids = array();
214 | foreach ( $custom_controls as $post ) {
215 |
216 | $custom_controls_ids[] = $post->ID;
217 |
218 | }
219 |
220 | return $custom_controls_ids;
221 |
222 | }
223 |
224 | }
225 |
226 | /**
227 | * Enqueue style for for live customize preview and the normal site.
228 | *
229 | * @since 1.0
230 | * @access public
231 | */
232 | public function enqueue_style() {
233 |
234 | // check if customize preview is active
235 | if ( is_customize_preview() ) {
236 |
237 | /**
238 | * Get all fonts
239 | * this updated to use fonts API
240 | *
241 | * @since 1.2
242 | */
243 | $all_fonts = array();
244 | foreach ($this->get_fonts() as $font) {
245 | $all_fonts[] = $font['permalink'] . ',';
246 | }
247 | $all_fonts_display = implode('',$all_fonts);
248 |
249 | wp_enqueue_style(
250 | $this->plugin_name .'-live',
251 | '//www.fontstatic.com/f='.$all_fonts_display,
252 | array(),
253 | null,
254 | 'all'
255 | );
256 |
257 | } else {
258 |
259 | // get body font
260 | if ( get_theme_mod('awf_body_font_family') != '' ) { $body_font = get_theme_mod('awf_body_font_family'). ','; } else { $body_font = ''; }
261 | // get paragraphs font
262 | if ( get_theme_mod('awf_paragraphs_font_family') != '' ) { $paragraphs_font = get_theme_mod('awf_paragraphs_font_family'). ','; } else { $paragraphs_font = ''; }
263 | // get h1 font
264 | if ( get_theme_mod('awf_h1_font_family') != '' ) { $h1_font = get_theme_mod('awf_h1_font_family'). ','; } else { $h1_font = ''; }
265 | // get h2 font
266 | if ( get_theme_mod('awf_h2_font_family') != '' ) { $h2_font = get_theme_mod('awf_h2_font_family'). ','; } else { $h2_font = ''; }
267 | // get h3 font
268 | if ( get_theme_mod('awf_h3_font_family') != '' ) { $h3_font = get_theme_mod('awf_h3_font_family'). ','; } else { $h3_font = ''; }
269 | // get h4 font
270 | if ( get_theme_mod('awf_h4_font_family') != '' ) { $h4_font = get_theme_mod('awf_h4_font_family'). ','; } else { $h4_font = ''; }
271 | // get h5 font
272 | if ( get_theme_mod('awf_h5_font_family') != '' ) { $h5_font = get_theme_mod('awf_h5_font_family'). ','; } else { $h5_font = ''; }
273 | // get h6 font
274 | if ( get_theme_mod('awf_h6_font_family') != '' ) { $h6_font = get_theme_mod('awf_h6_font_family'). ','; } else { $h6_font = ''; }
275 |
276 | // get custom controls fonts
277 | if( $this->get_custom_controls_ids() ) {
278 |
279 | $custom_controls_fonts = array();
280 | foreach ( $this->get_custom_controls_ids() as $id ) {
281 |
282 | if ( get_theme_mod('awf_'. $id .'_font_family') != '' ) {
283 | $custom_controls_fonts[] = get_theme_mod('awf_'. $id .'_font_family'). ',';
284 | } else { $custom_controls_fonts[] = ''; }
285 |
286 | }
287 |
288 | $custom_controls_fonts_display = implode('',$custom_controls_fonts);
289 |
290 | } else {
291 | $custom_controls_fonts_display = '';
292 | }
293 |
294 |
295 | if( empty($body_font) && empty($paragraphs_font) && empty($h1_font) && empty($h2_font) && empty($h3_font)
296 | && empty($h4_font) && empty($h5_font) && empty($h6_font) && empty($custom_controls_fonts_display) ) {
297 |
298 | } else {
299 |
300 | // check if font type is duplicated
301 | $default_settings_fonts_types = array ( $body_font, $paragraphs_font, $h1_font, $h2_font, $h3_font, $h4_font, $h5_font, $h6_font );
302 | if( $this->get_custom_controls_ids() ) {
303 | $all_fonts_types = array_merge($default_settings_fonts_types, $custom_controls_fonts);
304 | $final_fonts_types = implode('',array_unique($all_fonts_types));
305 | } else {
306 | $final_fonts_types = implode('',array_unique($default_settings_fonts_types));
307 | }
308 |
309 | wp_enqueue_style(
310 | $this->plugin_name,
311 | '//www.fontstatic.com/f='.$final_fonts_types,
312 | array(),
313 | null,
314 | 'all'
315 | );
316 |
317 | }
318 | }
319 |
320 | }
321 |
322 | /**
323 | * Do action footer custom action working like [ customize_preview_init ].
324 | *
325 | * @since 1.0
326 | * @access public
327 | */
328 | public function custom_footer_actions() {
329 |
330 | // check if customize preview is active
331 | if ( is_customize_preview() ) {
332 |
333 | // this action used to load wp.customize in live preview for custom controls
334 | do_action('wp_footer_preview');
335 |
336 | }
337 |
338 | }
339 |
340 | /**
341 | * Enqueue script for customize live preview.
342 | *
343 | * @since 1.0
344 | * @access public
345 | */
346 | public function live_preview() {
347 |
348 | wp_enqueue_script( $this->plugin_name .'-customizer-preview', plugins_url( '/assets/js/customizer-preview.js', dirname(__FILE__) ), array( 'jquery', 'customize-preview' ), $this->version, true );
349 |
350 | }
351 |
352 | /**
353 | * Enqueue custom script for cunstom controls in customize live preview.
354 | *
355 | * @since 1.0
356 | * @access public
357 | */
358 | public function custom_css_selectors_live_preview() {
359 |
360 | // get custom controls styles
361 | if( $this->get_custom_controls_ids() ) {
362 |
363 | ?>
364 |
414 | plugin_name .'-customizer-controls',
429 | plugins_url( '/assets/css/customizer-controls.css', dirname(__FILE__) ),
430 | array(),
431 | $this->version
432 | );
433 |
434 | wp_enqueue_script(
435 | $this->plugin_name .'-customizer-controls',
436 | plugins_url( '/assets/js/customizer-controls.js', dirname(__FILE__) ),
437 | array( 'jquery', 'customize-controls' ),
438 | $this->version, true
439 | );
440 |
441 | wp_localize_script(
442 | $this->plugin_name .'-customizer-controls',
443 | 'AWF_Customizer_Reset',
444 | array( 'confirm' => __( "Click OK to reset. All settings will be lost and replaced with default settings!", 'arabic-webfonts' ), )
445 | );
446 |
447 | }
448 |
449 | /**
450 | * Ajax method for reset customizer settings button.
451 | *
452 | * @since 1.0
453 | * @access public
454 | */
455 | public function ajax_reset_customizer_settings() {
456 |
457 | // get section id
458 | $reset_section = esc_attr($_POST['reset_section']);
459 |
460 | switch ( $reset_section ) {
461 |
462 | // body section
463 | case 'awf_body_settings_reset_control':
464 |
465 | remove_theme_mod('awf_body_font_family');
466 | remove_theme_mod('awf_body_font_size');
467 | remove_theme_mod('awf_body_line_height');
468 |
469 | break;
470 |
471 | // paragraphs section
472 | case 'awf_paragraphs_settings_reset_control':
473 |
474 | remove_theme_mod('awf_paragraphs_font_family');
475 | remove_theme_mod('awf_paragraphs_font_size');
476 | remove_theme_mod('awf_paragraphs_line_height');
477 | remove_theme_mod('awf_paragraphs_text_decoration');
478 |
479 | break;
480 |
481 | // headings section - h1 group
482 | case 'awf_h1_settings_reset_control':
483 |
484 | remove_theme_mod('awf_h1_font_family');
485 | remove_theme_mod('awf_h1_font_size');
486 | remove_theme_mod('awf_h1_line_height');
487 | remove_theme_mod('awf_h1_text_decoration');
488 |
489 | break;
490 |
491 | // headings section - h2 group
492 | case 'awf_h2_settings_reset_control':
493 |
494 | remove_theme_mod('awf_h2_font_family');
495 | remove_theme_mod('awf_h2_font_size');
496 | remove_theme_mod('awf_h2_line_height');
497 | remove_theme_mod('awf_h2_text_decoration');
498 |
499 | break;
500 |
501 | // headings section - h3 group
502 | case 'awf_h3_settings_reset_control':
503 |
504 | remove_theme_mod('awf_h3_font_family');
505 | remove_theme_mod('awf_h3_font_size');
506 | remove_theme_mod('awf_h3_line_height');
507 | remove_theme_mod('awf_h3_text_decoration');
508 |
509 | break;
510 |
511 | // headings section - h4 group
512 | case 'awf_h4_settings_reset_control':
513 |
514 | remove_theme_mod('awf_h4_font_family');
515 | remove_theme_mod('awf_h4_font_size');
516 | remove_theme_mod('awf_h4_line_height');
517 | remove_theme_mod('awf_h4_text_decoration');
518 |
519 | break;
520 |
521 | // headings section - h5 group
522 | case 'awf_h5_settings_reset_control':
523 |
524 | remove_theme_mod('awf_h5_font_family');
525 | remove_theme_mod('awf_h5_font_size');
526 | remove_theme_mod('awf_h5_line_height');
527 | remove_theme_mod('awf_h5_text_decoration');
528 |
529 | break;
530 |
531 | // headings section - h6 group
532 | case 'awf_h6_settings_reset_control':
533 |
534 | remove_theme_mod('awf_h6_font_family');
535 | remove_theme_mod('awf_h6_font_size');
536 | remove_theme_mod('awf_h6_line_height');
537 | remove_theme_mod('awf_h6_text_decoration');
538 |
539 | break;
540 |
541 | // reset all settings
542 | case 'awf_all_settings_reset_control':
543 |
544 | remove_theme_mod('awf_body_font_family');
545 | remove_theme_mod('awf_body_font_size');
546 | remove_theme_mod('awf_body_line_height');
547 | remove_theme_mod('awf_paragraphs_font_family');
548 | remove_theme_mod('awf_paragraphs_font_size');
549 | remove_theme_mod('awf_paragraphs_line_height');
550 | remove_theme_mod('awf_paragraphs_text_decoration');
551 | remove_theme_mod('awf_h1_font_family');
552 | remove_theme_mod('awf_h1_font_size');
553 | remove_theme_mod('awf_h1_line_height');
554 | remove_theme_mod('awf_h1_text_decoration');
555 | remove_theme_mod('awf_h2_font_family');
556 | remove_theme_mod('awf_h2_font_size');
557 | remove_theme_mod('awf_h2_line_height');
558 | remove_theme_mod('awf_h2_text_decoration');
559 | remove_theme_mod('awf_h3_font_family');
560 | remove_theme_mod('awf_h3_font_size');
561 | remove_theme_mod('awf_h3_line_height');
562 | remove_theme_mod('awf_h3_text_decoration');
563 | remove_theme_mod('awf_h4_font_family');
564 | remove_theme_mod('awf_h4_font_size');
565 | remove_theme_mod('awf_h4_line_height');
566 | remove_theme_mod('awf_h4_text_decoration');
567 | remove_theme_mod('awf_h5_font_family');
568 | remove_theme_mod('awf_h5_font_size');
569 | remove_theme_mod('awf_h5_line_height');
570 | remove_theme_mod('awf_h5_text_decoration');
571 | remove_theme_mod('awf_h6_font_family');
572 | remove_theme_mod('awf_h6_font_size');
573 | remove_theme_mod('awf_h6_line_height');
574 | remove_theme_mod('awf_h6_text_decoration');
575 | // custom controls section
576 | if( $this->get_custom_controls_ids() ) {
577 |
578 | foreach ( $this->get_custom_controls_ids() as $id ) {
579 |
580 | remove_theme_mod('awf_'. $id .'_font_family');
581 | remove_theme_mod('awf_'. $id .'_font_size');
582 | remove_theme_mod('awf_'. $id .'_line_height');
583 | remove_theme_mod('awf_'. $id .'_text_decoration');
584 |
585 | }
586 |
587 | }
588 |
589 | break;
590 |
591 | // custom controls section
592 | default:
593 |
594 | if( $this->get_custom_controls_ids() ) {
595 |
596 | foreach ( $this->get_custom_controls_ids() as $id ) {
597 |
598 | if( $reset_section == 'awf_'. $id .'_settings_reset_control' ) {
599 | remove_theme_mod('awf_'. $id .'_font_family');
600 | remove_theme_mod('awf_'. $id .'_font_size');
601 | remove_theme_mod('awf_'. $id .'_line_height');
602 | remove_theme_mod('awf_'. $id .'_text_decoration');
603 | }
604 |
605 | }
606 |
607 | }
608 |
609 | break;
610 |
611 |
612 | } // end switch section settings
613 |
614 | }
615 |
616 | /**
617 | * Output css styles in header to activate customizer settings.
618 | *
619 | * @since 1.0
620 | * @access public
621 | */
622 | public function header_output() {
623 |
624 | echo '';
625 | ?>
626 |
879 | plugin_name. ' styles -->';
881 |
882 | }
883 |
884 |
885 |
886 | }
887 |
888 | endif; // End Check Class Exists
889 |
--------------------------------------------------------------------------------