Search moodle.org's
Developer Documentation

See Release Notes

  • Bug fixes for general core bugs in 4.2.x will end 22 April 2024 (12 months).
  • Bug fixes for security issues in 4.2.x will end 7 October 2024 (18 months).
  • PHP version: minimum PHP 8.0.0 Note: minimum PHP version has increased since Moodle 4.1. PHP 8.1.x is supported too.

Differences Between: [Versions 310 and 402] [Versions 311 and 402] [Versions 39 and 402] [Versions 400 and 402] [Versions 401 and 402]

   1  <?php
   2  /*
   3   * Copyright 2010 Google Inc.
   4   *
   5   * Licensed under the Apache License, Version 2.0 (the "License"); you may not
   6   * use this file except in compliance with the License. You may obtain a copy of
   7   * the License at
   8   *
   9   * http://www.apache.org/licenses/LICENSE-2.0
  10   *
  11   * Unless required by applicable law or agreed to in writing, software
  12   * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
  13   * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
  14   * License for the specific language governing permissions and limitations under
  15   * the License.
  16   */
  17  
  18  /**
  19   * Service definition for SiteVerification (v1).
  20   *
  21   * <p>
  22   * Lets you programatically verify ownership of websites or domains with Google.</p>
  23   *
  24   * <p>
  25   * For more information about this service, see the API
  26   * <a href="https://developers.google.com/site-verification/" target="_blank">Documentation</a>
  27   * </p>
  28   *
  29   * @author Google, Inc.
  30   */
  31  #[AllowDynamicProperties]
  32  class Google_Service_SiteVerification extends Google_Service
  33  {
  34    /** Manage the list of sites and domains you control. */
  35    const SITEVERIFICATION =
  36        "https://www.googleapis.com/auth/siteverification";
  37    /** Manage your new site verifications with Google. */
  38    const SITEVERIFICATION_VERIFY_ONLY =
  39        "https://www.googleapis.com/auth/siteverification.verify_only";
  40  
  41    public $webResource;
  42    
  43  
  44    /**
  45     * Constructs the internal representation of the SiteVerification service.
  46     *
  47     * @param Google_Client $client
  48     */
  49    public function __construct(Google_Client $client)
  50    {
  51      parent::__construct($client);
  52      $this->rootUrl = 'https://www.googleapis.com/';
  53      $this->servicePath = 'siteVerification/v1/';
  54      $this->version = 'v1';
  55      $this->serviceName = 'siteVerification';
  56  
  57      $this->webResource = new Google_Service_SiteVerification_WebResource_Resource(
  58          $this,
  59          $this->serviceName,
  60          'webResource',
  61          array(
  62            'methods' => array(
  63              'delete' => array(
  64                'path' => 'webResource/{id}',
  65                'httpMethod' => 'DELETE',
  66                'parameters' => array(
  67                  'id' => array(
  68                    'location' => 'path',
  69                    'type' => 'string',
  70                    'required' => true,
  71                  ),
  72                ),
  73              ),'get' => array(
  74                'path' => 'webResource/{id}',
  75                'httpMethod' => 'GET',
  76                'parameters' => array(
  77                  'id' => array(
  78                    'location' => 'path',
  79                    'type' => 'string',
  80                    'required' => true,
  81                  ),
  82                ),
  83              ),'getToken' => array(
  84                'path' => 'token',
  85                'httpMethod' => 'POST',
  86                'parameters' => array(),
  87              ),'insert' => array(
  88                'path' => 'webResource',
  89                'httpMethod' => 'POST',
  90                'parameters' => array(
  91                  'verificationMethod' => array(
  92                    'location' => 'query',
  93                    'type' => 'string',
  94                    'required' => true,
  95                  ),
  96                ),
  97              ),'list' => array(
  98                'path' => 'webResource',
  99                'httpMethod' => 'GET',
 100                'parameters' => array(),
 101              ),'patch' => array(
 102                'path' => 'webResource/{id}',
 103                'httpMethod' => 'PATCH',
 104                'parameters' => array(
 105                  'id' => array(
 106                    'location' => 'path',
 107                    'type' => 'string',
 108                    'required' => true,
 109                  ),
 110                ),
 111              ),'update' => array(
 112                'path' => 'webResource/{id}',
 113                'httpMethod' => 'PUT',
 114                'parameters' => array(
 115                  'id' => array(
 116                    'location' => 'path',
 117                    'type' => 'string',
 118                    'required' => true,
 119                  ),
 120                ),
 121              ),
 122            )
 123          )
 124      );
 125    }
 126  }
 127  
 128  
 129  /**
 130   * The "webResource" collection of methods.
 131   * Typical usage is:
 132   *  <code>
 133   *   $siteVerificationService = new Google_Service_SiteVerification(...);
 134   *   $webResource = $siteVerificationService->webResource;
 135   *  </code>
 136   */
 137  #[AllowDynamicProperties]
 138  class Google_Service_SiteVerification_WebResource_Resource extends Google_Service_Resource
 139  {
 140  
 141    /**
 142     * Relinquish ownership of a website or domain. (webResource.delete)
 143     *
 144     * @param string $id The id of a verified site or domain.
 145     * @param array $optParams Optional parameters.
 146     */
 147    public function delete($id, $optParams = array())
 148    {
 149      $params = array('id' => $id);
 150      $params = array_merge($params, $optParams);
 151      return $this->call('delete', array($params));
 152    }
 153  
 154    /**
 155     * Get the most current data for a website or domain. (webResource.get)
 156     *
 157     * @param string $id The id of a verified site or domain.
 158     * @param array $optParams Optional parameters.
 159     * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource
 160     */
 161    public function get($id, $optParams = array())
 162    {
 163      $params = array('id' => $id);
 164      $params = array_merge($params, $optParams);
 165      return $this->call('get', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource");
 166    }
 167  
 168    /**
 169     * Get a verification token for placing on a website or domain.
 170     * (webResource.getToken)
 171     *
 172     * @param Google_SiteVerificationWebResourceGettokenRequest $postBody
 173     * @param array $optParams Optional parameters.
 174     * @return Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse
 175     */
 176    public function getToken(Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequest $postBody, $optParams = array())
 177    {
 178      $params = array('postBody' => $postBody);
 179      $params = array_merge($params, $optParams);
 180      return $this->call('getToken', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse");
 181    }
 182  
 183    /**
 184     * Attempt verification of a website or domain. (webResource.insert)
 185     *
 186     * @param string $verificationMethod The method to use for verifying a site or
 187     * domain.
 188     * @param Google_SiteVerificationWebResourceResource $postBody
 189     * @param array $optParams Optional parameters.
 190     * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource
 191     */
 192    public function insert($verificationMethod, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array())
 193    {
 194      $params = array('verificationMethod' => $verificationMethod, 'postBody' => $postBody);
 195      $params = array_merge($params, $optParams);
 196      return $this->call('insert', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource");
 197    }
 198  
 199    /**
 200     * Get the list of your verified websites and domains.
 201     * (webResource.listWebResource)
 202     *
 203     * @param array $optParams Optional parameters.
 204     * @return Google_Service_SiteVerification_SiteVerificationWebResourceListResponse
 205     */
 206    public function listWebResource($optParams = array())
 207    {
 208      $params = array();
 209      $params = array_merge($params, $optParams);
 210      return $this->call('list', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceListResponse");
 211    }
 212  
 213    /**
 214     * Modify the list of owners for your website or domain. This method supports
 215     * patch semantics. (webResource.patch)
 216     *
 217     * @param string $id The id of a verified site or domain.
 218     * @param Google_SiteVerificationWebResourceResource $postBody
 219     * @param array $optParams Optional parameters.
 220     * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource
 221     */
 222    public function patch($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array())
 223    {
 224      $params = array('id' => $id, 'postBody' => $postBody);
 225      $params = array_merge($params, $optParams);
 226      return $this->call('patch', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource");
 227    }
 228  
 229    /**
 230     * Modify the list of owners for your website or domain. (webResource.update)
 231     *
 232     * @param string $id The id of a verified site or domain.
 233     * @param Google_SiteVerificationWebResourceResource $postBody
 234     * @param array $optParams Optional parameters.
 235     * @return Google_Service_SiteVerification_SiteVerificationWebResourceResource
 236     */
 237    public function update($id, Google_Service_SiteVerification_SiteVerificationWebResourceResource $postBody, $optParams = array())
 238    {
 239      $params = array('id' => $id, 'postBody' => $postBody);
 240      $params = array_merge($params, $optParams);
 241      return $this->call('update', array($params), "Google_Service_SiteVerification_SiteVerificationWebResourceResource");
 242    }
 243  }
 244  
 245  
 246  
 247  
 248  #[AllowDynamicProperties]
 249  class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequest extends Google_Model
 250  {
 251    protected $internal_gapi_mappings = array(
 252    );
 253    protected $siteType = 'Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite';
 254    protected $siteDataType = '';
 255    public $verificationMethod;
 256  
 257  
 258    public function setSite(Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite $site)
 259    {
 260      $this->site = $site;
 261    }
 262    public function getSite()
 263    {
 264      return $this->site;
 265    }
 266    public function setVerificationMethod($verificationMethod)
 267    {
 268      $this->verificationMethod = $verificationMethod;
 269    }
 270    public function getVerificationMethod()
 271    {
 272      return $this->verificationMethod;
 273    }
 274  }
 275  
 276  #[AllowDynamicProperties]
 277  class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenRequestSite extends Google_Model
 278  {
 279    protected $internal_gapi_mappings = array(
 280    );
 281    public $identifier;
 282    public $type;
 283  
 284  
 285    public function setIdentifier($identifier)
 286    {
 287      $this->identifier = $identifier;
 288    }
 289    public function getIdentifier()
 290    {
 291      return $this->identifier;
 292    }
 293    public function setType($type)
 294    {
 295      $this->type = $type;
 296    }
 297    public function getType()
 298    {
 299      return $this->type;
 300    }
 301  }
 302  
 303  #[AllowDynamicProperties]
 304  class Google_Service_SiteVerification_SiteVerificationWebResourceGettokenResponse extends Google_Model
 305  {
 306    protected $internal_gapi_mappings = array(
 307    );
 308    public $method;
 309    public $token;
 310  
 311  
 312    public function setMethod($method)
 313    {
 314      $this->method = $method;
 315    }
 316    public function getMethod()
 317    {
 318      return $this->method;
 319    }
 320    public function setToken($token)
 321    {
 322      $this->token = $token;
 323    }
 324    public function getToken()
 325    {
 326      return $this->token;
 327    }
 328  }
 329  
 330  #[AllowDynamicProperties]
 331  class Google_Service_SiteVerification_SiteVerificationWebResourceListResponse extends Google_Collection
 332  {
 333    protected $collection_key = 'items';
 334    protected $internal_gapi_mappings = array(
 335    );
 336    protected $itemsType = 'Google_Service_SiteVerification_SiteVerificationWebResourceResource';
 337    protected $itemsDataType = 'array';
 338  
 339  
 340    public function setItems($items)
 341    {
 342      $this->items = $items;
 343    }
 344    public function getItems()
 345    {
 346      return $this->items;
 347    }
 348  }
 349  
 350  #[AllowDynamicProperties]
 351  class Google_Service_SiteVerification_SiteVerificationWebResourceResource extends Google_Collection
 352  {
 353    protected $collection_key = 'owners';
 354    protected $internal_gapi_mappings = array(
 355    );
 356    public $id;
 357    public $owners;
 358    protected $siteType = 'Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite';
 359    protected $siteDataType = '';
 360  
 361  
 362    public function setId($id)
 363    {
 364      $this->id = $id;
 365    }
 366    public function getId()
 367    {
 368      return $this->id;
 369    }
 370    public function setOwners($owners)
 371    {
 372      $this->owners = $owners;
 373    }
 374    public function getOwners()
 375    {
 376      return $this->owners;
 377    }
 378    public function setSite(Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite $site)
 379    {
 380      $this->site = $site;
 381    }
 382    public function getSite()
 383    {
 384      return $this->site;
 385    }
 386  }
 387  
 388  #[AllowDynamicProperties]
 389  class Google_Service_SiteVerification_SiteVerificationWebResourceResourceSite extends Google_Model
 390  {
 391    protected $internal_gapi_mappings = array(
 392    );
 393    public $identifier;
 394    public $type;
 395  
 396  
 397    public function setIdentifier($identifier)
 398    {
 399      $this->identifier = $identifier;
 400    }
 401    public function getIdentifier()
 402    {
 403      return $this->identifier;
 404    }
 405    public function setType($type)
 406    {
 407      $this->type = $type;
 408    }
 409    public function getType()
 410    {
 411      return $this->type;
 412    }
 413  }