v1.0

Author: alekseynemiro

Conf.php

@@ -0,0 +1,162 @@
+<?php
+namespace Nemiro\Nginx
+{
+
+  /*
+   * Copyright © Aleksey Nemiro, 2015. All rights reserved.
+   * 
+   * Licensed under the Apache License, Version 2.0 (the "License");
+   * you may not use this file except in compliance with the License.
+   * You may obtain a copy of the License at
+   * 
+   * http://www.apache.org/licenses/LICENSE-2.0
+   * 
+   * Unless required by applicable law or agreed to in writing, software
+   * distributed under the License is distributed on an "AS IS" BASIS,
+   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   * See the License for the specific language governing permissions and
+   * limitations under the License.
+   */
+
+  /**
+   * Represents Nginx directive collection.
+   * 
+   * @author      Aleksey Nemiro <[email protected]>
+   * @copyright   © Aleksey Nemiro, 2015. All rights reserved.
+   */
+  class DirectiveCollection implements \ArrayAccess
+  {
+    
+    /**
+     * The list of directives.
+     * 
+     * @var Directive[]|DirectiveGroup[]
+     */
+    public $Items;
+
+    function __construct()
+    {
+      $this->Items = array();
+    }
+
+    /**
+     * Determines whether the DirectiveCollection contains the specified directive name.
+     * 
+     * @param \string $name The key to locate in the DirectiveCollection.
+     * @return \bool
+     */
+    public function ContainsDirective($name)
+    {
+      if (is_null($name) || (gettype($name) != 'string' && gettype($name) != 'integer') || (string)$name == '')
+      {
+        throw new \InvalidArgumentException('Name is required. The name must be a string. Value can not be null or empty.');
+      }
+
+      return array_key_exists($name, $this->Items);
+    }
+
+    /**
+     * Adds a new directive or group to the collection.
+     * 
+     * @param Directive|DirectiveGroup[] $item The directive or group to add.
+     * @return Directive|DirectiveGroup
+     */
+    public function Add($item)
+    {
+      if ($this->ContainsDirective($item->Name))
+      {
+        throw new \ErrorException(sprintf('Directive `%s` already exists.', $item->Name));
+      }
+
+      $this->Items[$item->Name] = $item;
+
+      return end($this->Items);
+    }
+
+    /**
+     * Returns elements count.
+     * 
+     * @return \int
+     */
+    public function Count()
+    {
+      return $this->Items != NULL ? count($this->Items) : 0;
+    }
+
+    /**
+     * Returns the first directive of the collection.
+     * 
+     * @return Directive|DirectiveGroup
+     */
+    public function First()
+    {
+      reset($this->Items);
+      return current($this->Items);
+    }
+
+    /**
+     * Returns the last directive of the collection.
+     * 
+     * @return Directive|DirectiveGroup
+     */
+    public function Last()
+    {
+      return end($this->Items);
+    }
+
+    #region ArrayAccess Members
+
+    /**
+     * Whether a offset exists
+     * Whether or not an offset exists.
+     *
+     * @param \string|\int $offset An offset to check for.
+     * @return \bool
+     */
+    function offsetExists($offset)
+    {
+      return isset($this->Items[$offset]);
+    }
+
+    /**
+     * Offset to retrieve
+     * Returns the value at specified offset.
+     *
+     * @param mixed $offset The offset to retrieve.
+     * @return Directive|DirectiveGroup
+     */
+    function offsetGet($offset)
+    {
+      return isset($this->Items[$offset]) ? $this->Items[$offset] : NULL;
+    }
+
+    /**
+     * Offset to set
+     * Assigns a value to the specified offset.
+     *
+     * @param mixed $offset The offset to assign the value to.
+     * @param mixed $value The value to set.
+     * @return void
+     */
+    function offsetSet($offset, $value)
+    {
+      $this->Items[$offset] = $value;
+    }
+
+    /**
+     * Offset to unset
+     * Unsets an offset.
+     *
+     * @param mixed $offset The offset to unset.
+     * @return void
+     */
+    function offsetUnset($offset)
+    {
+      unset($this->Items[$offset]);
+    }
+
+    #endregion
+
+  }
+
+}

Directive.php

@@ -0,0 +1,76 @@
+<?php
+namespace Nemiro\Nginx
+{
+
+  /*
+   * Copyright © Aleksey Nemiro, 2015. All rights reserved.
+   * 
+   * Licensed under the Apache License, Version 2.0 (the "License");
+   * you may not use this file except in compliance with the License.
+   * You may obtain a copy of the License at
+   * 
+   * http://www.apache.org/licenses/LICENSE-2.0
+   * 
+   * Unless required by applicable law or agreed to in writing, software
+   * distributed under the License is distributed on an "AS IS" BASIS,
+   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   * See the License for the specific language governing permissions and
+   * limitations under the License.
+   */
+
+  /**
+   * Represents Nginx directive group.
+   * 
+   * @author      Aleksey Nemiro <[email protected]>
+   * @copyright   © Aleksey Nemiro, 2015. All rights reserved.
+   */
+  class DirectiveGroup extends Directive
+  {
+    
+    /**
+     * Initializes a new instance of the class with the specified parameters.
+     * 
+     * @param \string $groupName Name of the group.
+     */
+    function __construct($groupName)
+    {
+      parent::__construct($groupName, NULL);
+    }
+    
+    /**
+     * Adds a new directive with specified parameters to the group.
+     * 
+     * @param \string|\string[]|Directive $value List of parameters or directive instance.
+     * @return Directive|DirectiveGroup
+     */
+    public function AddDirective($value)
+    {
+      if (is_null($value) || !is_object($value))
+      {
+        return $this->Directives->Add(new Directive($this->Directives->Count(), $value));
+      }
+      else if (get_class($value) == 'Nemiro\Nginx\Directive')
+      {
+        $d = new Directive($this->Directives->Count(), $value->Parameters, $value->Directives);
+        return $this->Directives->Add($d);
+      }
+      else
+      {
+        throw new \ErrorException('The value of the specified type is not supported. Expected: string, string array or Directive instance.');
+      }
+    }
+    
+    /**
+     * [NOT SUPPORED FOR GROUPS!] Adds new parameter to the parameter collection of the instance. 
+     * 
+     * @param \object|\array $value The value to add.
+     * @return void
+     */
+    public function AddParameter($value)
+    {
+      throw new \ErrorException('Parameters not suppered for groups. It is only for single directives.');
+    }
+
+  }
+
+}

DirectiveCollection.php

@@ -0,0 +1,24 @@
+<?php
+namespace Nemiro\Nginx
+{
+
+  /*
+   * Copyright © Aleksey Nemiro, 2015. All rights reserved.
+   * 
+   * Licensed under the Apache License, Version 2.0 (the "License");
+   * you may not use this file except in compliance with the License.
+   * You may obtain a copy of the License at
+   * 
+   * http://www.apache.org/licenses/LICENSE-2.0
+   * 
+   * Unless required by applicable law or agreed to in writing, software
+   * distributed under the License is distributed on an "AS IS" BASIS,
+   * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   * See the License for the specific language governing permissions and
+   * limitations under the License.
+   */
+
+  const NGINX_DIRECTIVE_SIMPLE = 0;
+  const NGINX_DIRECTIVE_BLOCK = 1;
+
+}