Blame view

mustache/php/vendor/Mustache/Loader/FilesystemLoader.php 3.79 KB
5a739853   patrick.he   commit
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
  <?php
  
  /*
   * This file is part of Mustache.php.
   *
   * (c) 2010-2014 Justin Hileman
   *
   * For the full copyright and license information, please view the LICENSE
   * file that was distributed with this source code.
   */
  
  /**
   * Mustache Template filesystem Loader implementation.
   *
   * A FilesystemLoader instance loads Mustache Template source from the filesystem by name:
   *
   *     $loader = new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views');
   *     $tpl = $loader->load('foo'); // equivalent to `file_get_contents(dirname(__FILE__).'/views/foo.mustache');
   *
   * This is probably the most useful Mustache Loader implementation. It can be used for partials and normal Templates:
   *
   *     $m = new Mustache(array(
   *          'loader'          => new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views'),
   *          'partials_loader' => new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views/partials'),
   *     ));
   */
  class Mustache_Loader_FilesystemLoader implements Mustache_Loader
  {
      private $baseDir;
      private $extension = '.mustache';
      private $templates = array();
  
      /**
       * Mustache filesystem Loader constructor.
       *
       * Passing an $options array allows overriding certain Loader options during instantiation:
       *
       *     $options = array(
       *         // The filename extension used for Mustache templates. Defaults to '.mustache'
       *         'extension' => '.ms',
       *     );
       *
       * @throws Mustache_Exception_RuntimeException if $baseDir does not exist.
       *
       * @param string $baseDir Base directory containing Mustache template files.
       * @param array  $options Array of Loader options (default: array())
       */
      public function __construct($baseDir, array $options = array())
      {
          $this->baseDir = $baseDir;
  
          if (strpos($this->baseDir, '://') === false) {
              $this->baseDir = realpath($this->baseDir);
          }
  
          if (!is_dir($this->baseDir)) {
              throw new Mustache_Exception_RuntimeException(sprintf('FilesystemLoader baseDir must be a directory: %s', $baseDir));
          }
  
          if (array_key_exists('extension', $options)) {
              if (empty($options['extension'])) {
                  $this->extension = '';
              } else {
                  $this->extension = '.' . ltrim($options['extension'], '.');
              }
          }
      }
  
      /**
       * Load a Template by name.
       *
       *     $loader = new Mustache_Loader_FilesystemLoader(dirname(__FILE__).'/views');
       *     $loader->load('admin/dashboard'); // loads "./views/admin/dashboard.mustache";
       *
       * @param string $name
       *
       * @return string Mustache Template source
       */
      public function load($name)
      {
          if (!isset($this->templates[$name])) {
              $this->templates[$name] = $this->loadFile($name);
          }
  
          return $this->templates[$name];
      }
  
      /**
       * Helper function for loading a Mustache file by name.
       *
       * @throws Mustache_Exception_UnknownTemplateException If a template file is not found.
       *
       * @param string $name
       *
       * @return string Mustache Template source
       */
      protected function loadFile($name)
      {
          $fileName = $this->getFileName($name);
  
          if (!file_exists($fileName)) {
              throw new Mustache_Exception_UnknownTemplateException($name);
          }
  
          return file_get_contents($fileName);
      }
  
      /**
       * Helper function for getting a Mustache template file name.
       *
       * @param string $name
       *
       * @return string Template file name
       */
      protected function getFileName($name)
      {
          $fileName = $this->baseDir . '/' . $name;
          if (substr($fileName, 0 - strlen($this->extension)) !== $this->extension) {
              $fileName .= $this->extension;
          }
  
          return $fileName;
      }
  }