php/src/gadgets/Gadget.php

   1 <?php
   2 /**
   3  * Licensed to the Apache Software Foundation (ASF) under one
   4  * or more contributor license agreements.  See the NOTICE file
   5  * distributed with this work for additional information
   6  * regarding copyright ownership.  The ASF licenses this file
   7  * to you under the Apache License, Version 2.0 (the
   8  * "License"); you may not use this file except in compliance
   9  * with the License.  You may obtain a copy of the License at
  10  *
  11  *     http://www.apache.org/licenses/LICENSE-2.0
  12  *
  13  * Unless required by applicable law or agreed to in writing,
  14  * software distributed under the License is distributed on an
  15  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16  * KIND, either express or implied.  See the License for the
  17  * specific language governing permissions and limitations
  18  * under the License.
  19  */
  20
  21 class Gadget {
  22   const DEFAULT_VIEW = 'profile';
  23
  24   /**
  25    * @var GadgetSpec
  26    */
  27   public $gadgetSpec;
  28
  29   public $features;
  30   public $substitutions;
  31   public $rightToLeft;
  32
  33   /**
  34    * @var GadgetContext
  35    */
  36   public $gadgetContext;
  37
  38   public function __construct(GadgetSpec $gadgetSpec, GadgetContext $gadgetContext) {
  39     $this->gadgetSpec = $gadgetSpec;
  40     $this->gadgetContext = $gadgetContext;
  41   }
  42
  43   public function getView($viewName) {
  44     if (isset($this->gadgetSpec->views[$viewName])) {
  45       return $this->gadgetSpec->views[$viewName];
  46     } elseif (isset($this->gadgetSpec->views[self::DEFAULT_VIEW])) {
  47       return $this->gadgetSpec->views[self::DEFAULT_VIEW];
  48     } else {
  49       // see if there's any empty entries, we'll use that as default then (old iGoogle style)
  50       foreach ($this->gadgetSpec->views as $view) {
  51         if (empty($view['view'])) {
  52           return $view;
  53         }
  54       }
  55     }
  56     throw new GadgetException("Invalid view specified for this gadget");
  57   }
  58
  59   /**
  60    * @return unknown
  61    */
  62   public function getAuthor() {
  63     return $this->substitutions->substitute($this->gadgetSpec->author);
  64   }
  65
  66   /**
  67    * @return unknown
  68    */
  69   public function getAuthorAboutme() {
  70     return $this->substitutions->substitute($this->gadgetSpec->authorAboutme);
  71   }
  72
  73   /**
  74    * @return unknown
  75    */
  76   public function getAuthorAffiliation() {
  77     return $this->substitutions->substitute($this->gadgetSpec->authorAffiliation);
  78   }
  79
  80   /**
  81    * @return unknown
  82    */
  83   public function getAuthorEmail() {
  84     return $this->substitutions->substitute($this->gadgetSpec->authorEmail);
  85   }
  86
  87   /**
  88    * @return unknown
  89    */
  90   public function getAuthorLink() {
  91     return $this->substitutions->substitute($this->gadgetSpec->authorLink);
  92   }
  93
  94   /**
  95    * @return unknown
  96    */
  97   public function getAuthorLocation() {
  98     return $this->substitutions->substitute($this->gadgetSpec->authorLocation);
  99   }
 100
 101   /**
 102    * @return unknown
 103    */
 104   public function getAuthorPhoto() {
 105     return $this->substitutions->substitute($this->gadgetSpec->authorPhoto);
 106   }
 107
 108   /**
 109    * @return unknown
 110    */
 111   public function getAuthorQuote() {
 112     return $this->substitutions->substitute($this->gadgetSpec->authorQuote);
 113   }
 114
 115   /**
 116    * @return unknown
 117    */
 118   public function getCategory() {
 119     return $this->substitutions->substitute($this->gadgetSpec->category);
 120   }
 121
 122   /**
 123    * @return unknown
 124    */
 125   public function getCategory2() {
 126     return $this->substitutions->substitute($this->gadgetSpec->category2);
 127   }
 128
 129   /**
 130    * @return unknown
 131    */
 132   public function getChecksum() {
 133     return $this->gadgetSpec->checksum;
 134   }
 135
 136   /**
 137    * @return unknown
 138    */
 139   public function getDescription() {
 140     return $this->substitutions->substitute($this->gadgetSpec->description);
 141   }
 142
 143   /**
 144    * @return unknown
 145    */
 146   public function getDirectoryTitle() {
 147     return $this->substitutions->substitute($this->gadgetSpec->directoryTitle);
 148   }
 149
 150   /**
 151    * @return unknown
 152    */
 153   public function getHeight() {
 154     return $this->substitutions->substitute($this->gadgetSpec->height);
 155   }
 156
 157   /**
 158    * @return unknown
 159    */
 160   public function getIcon() {
 161     return $this->substitutions->substitute($this->gadgetSpec->icon);
 162   }
 163
 164   /**
 165    * @return unknown
 166    */
 167   public function getLinks() {
 168     return $this->gadgetSpec->links;
 169   }
 170
 171   /**
 172    * @return unknown
 173    */
 174   public function getLocales() {
 175     return $this->gadgetSpec->locales;
 176   }
 177
 178   /**
 179    * @return unknown
 180    */
 181   public function getOptionalFeatures() {
 182     return $this->gadgetSpec->optionalFeatures;
 183   }
 184
 185   /**
 186    * @return unknown
 187    */
 188   public function getPreloads() {
 189     return $this->gadgetSpec->preloads;
 190   }
 191
 192   /**
 193    * @return unknown
 194    */
 195   public function getRenderInline() {
 196     return $this->substitutions->substitute($this->gadgetSpec->renderInline);
 197   }
 198
 199   /**
 200    * @return unknown
 201    */
 202   public function getRequiredFeatures() {
 203     return $this->substitutions->substitute($this->gadgetSpec->requiredFeatures);
 204   }
 205
 206   /**
 207    * @return unknown
 208    */
 209   public function getScaling() {
 210     return $this->substitutions->substitute($this->gadgetSpec->scaling);
 211   }
 212
 213   /**
 214    * @return unknown
 215    */
 216   public function getScreenshot() {
 217     return $this->substitutions->substitute($this->gadgetSpec->screenshot);
 218   }
 219
 220   /**
 221    * @return unknown
 222    */
 223   public function getScrolling() {
 224     return $this->substitutions->substitute($this->gadgetSpec->scrolling);
 225   }
 226
 227   /**
 228    * @return unknown
 229    */
 230   public function getShowInDirectory() {
 231     return $this->substitutions->substitute($this->gadgetSpec->showInDirectory);
 232   }
 233
 234   /**
 235    * @return unknown
 236    */
 237   public function getShowStats() {
 238     return $this->substitutions->substitute($this->gadgetSpec->showStats);
 239   }
 240
 241   /**
 242    * @return unknown
 243    */
 244   public function getSingleton() {
 245     return $this->substitutions->substitute($this->gadgetSpec->singleton);
 246   }
 247
 248   /**
 249    * @return unknown
 250    */
 251   public function getString() {
 252     return $this->substitutions->substitute($this->gadgetSpec->string);
 253   }
 254
 255   /**
 256    * @return unknown
 257    */
 258   public function getThumbnail() {
 259     return $this->substitutions->substitute($this->gadgetSpec->thumbnail);
 260   }
 261
 262   /**
 263    * @return unknown
 264    */
 265   public function getTitle() {
 266     return $this->substitutions->substitute($this->gadgetSpec->title);
 267   }
 268
 269   /**
 270    * @return unknown
 271    */
 272   public function getTitleUrl() {
 273     return $this->substitutions->substitute($this->gadgetSpec->titleUrl);
 274   }
 275
 276   /**
 277    * @return unknown
 278    */
 279   public function getUserPrefs() {
 280     return $this->gadgetSpec->userPrefs;
 281   }
 282
 283   /**
 284    * @return unknown
 285    */
 286   public function getWidth() {
 287     return $this->substitutions->substitute($this->gadgetSpec->width);
 288   }
 289
 290   /**
 291    * @param unknown_type $author
 292    */
 293   public function setAuthor($author) {
 294     $this->gadgetSpec->author = $author;
 295   }
 296
 297   /**
 298    * @param unknown_type $authorAboutme
 299    */
 300   public function setAuthorAboutme($authorAboutme) {
 301     $this->gadgetSpec->authorAboutme = $authorAboutme;
 302   }
 303
 304   /**
 305    * @param unknown_type $authorAffiliation
 306    */
 307   public function setAuthorAffiliation($authorAffiliation) {
 308     $this->gadgetSpec->authorAffiliation = $authorAffiliation;
 309   }
 310
 311   /**
 312    * @param unknown_type $authorEmail
 313    */
 314   public function setAuthorEmail($authorEmail) {
 315     $this->gadgetSpec->authorEmail = $authorEmail;
 316   }
 317
 318   /**
 319    * @param unknown_type $authorLink
 320    */
 321   public function setAuthorLink($authorLink) {
 322     $this->gadgetSpec->authorLink = $authorLink;
 323   }
 324
 325   /**
 326    * @param unknown_type $authorLocation
 327    */
 328   public function setAuthorLocation($authorLocation) {
 329     $this->gadgetSpec->authorLocation = $authorLocation;
 330   }
 331
 332   /**
 333    * @param unknown_type $authorPhoto
 334    */
 335   public function setAuthorPhoto($authorPhoto) {
 336     $this->gadgetSpec->authorPhoto = $authorPhoto;
 337   }
 338
 339   /**
 340    * @param unknown_type $authorQuote
 341    */
 342   public function setAuthorQuote($authorQuote) {
 343     $this->gadgetSpec->authorQuote = $authorQuote;
 344   }
 345
 346   /**
 347    * @param unknown_type $category
 348    */
 349   public function setCategory($category) {
 350     $this->gadgetSpec->category = $category;
 351   }
 352
 353   /**
 354    * @param unknown_type $category2
 355    */
 356   public function setCategory2($category2) {
 357     $this->gadgetSpec->category2 = $category2;
 358   }
 359
 360   /**
 361    * @param unknown_type $checksum
 362    */
 363   public function setChecksum($checksum) {
 364     $this->gadgetSpec->checksum = $checksum;
 365   }
 366
 367   /**
 368    * @param unknown_type $description
 369    */
 370   public function setDescription($description) {
 371     $this->gadgetSpec->description = $description;
 372   }
 373
 374   /**
 375    * @param unknown_type $directoryTitle
 376    */
 377   public function setDirectoryTitle($directoryTitle) {
 378     $this->gadgetSpec->directoryTitle = $directoryTitle;
 379   }
 380
 381   /**
 382    * @param unknown_type $height
 383    */
 384   public function setHeight($height) {
 385     $this->gadgetSpec->height = $height;
 386   }
 387
 388   /**
 389    * @param unknown_type $icon
 390    */
 391   public function setIcon($icon) {
 392     $this->gadgetSpec->icon = $icon;
 393   }
 394
 395   /**
 396    * @param unknown_type $links
 397    */
 398   public function setLinks($links) {
 399     $this->gadgetSpec->links = $links;
 400   }
 401
 402   /**
 403    * @param unknown_type $locales
 404    */
 405   public function setLocales($locales) {
 406     $this->gadgetSpec->locales = $locales;
 407   }
 408
 409   /**
 410    * @param unknown_type $optionalFeatures
 411    */
 412   public function setOptionalFeatures($optionalFeatures) {
 413     $this->gadgetSpec->optionalFeatures = $optionalFeatures;
 414   }
 415
 416   /**
 417    * @param unknown_type $preloads
 418    */
 419   public function setPreloads($preloads) {
 420     $this->gadgetSpec->preloads = $preloads;
 421   }
 422
 423   /**
 424    * @param unknown_type $renderInline
 425    */
 426   public function setRenderInline($renderInline) {
 427     $this->gadgetSpec->renderInline = $renderInline;
 428   }
 429
 430   /**
 431    * @param unknown_type $requiredFeatures
 432    */
 433   public function setRequiredFeatures($requiredFeatures) {
 434     $this->gadgetSpec->requiredFeatures = $requiredFeatures;
 435   }
 436
 437   /**
 438    * @param unknown_type $scaling
 439    */
 440   public function setScaling($scaling) {
 441     $this->gadgetSpec->scaling = $scaling;
 442   }
 443
 444   /**
 445    * @param unknown_type $screenshot
 446    */
 447   public function setScreenshot($screenshot) {
 448     $this->gadgetSpec->screenshot = $screenshot;
 449   }
 450
 451   /**
 452    * @param unknown_type $scrolling
 453    */
 454   public function setScrolling($scrolling) {
 455     $this->gadgetSpec->scrolling = $scrolling;
 456   }
 457
 458   /**
 459    * @param unknown_type $showInDirectory
 460    */
 461   public function setShowInDirectory($showInDirectory) {
 462     $this->gadgetSpec->showInDirectory = $showInDirectory;
 463   }
 464
 465   /**
 466    * @param unknown_type $showStats
 467    */
 468   public function setShowStats($showStats) {
 469     $this->gadgetSpec->showStats = $showStats;
 470   }
 471
 472   /**
 473    * @param unknown_type $singleton
 474    */
 475   public function setSingleton($singleton) {
 476     $this->gadgetSpec->singleton = $singleton;
 477   }
 478
 479   /**
 480    * @param unknown_type $string
 481    */
 482   public function setString($string) {
 483     $this->gadgetSpec->string = $string;
 484   }
 485
 486   /**
 487    * @param unknown_type $thumbnail
 488    */
 489   public function setThumbnail($thumbnail) {
 490     $this->gadgetSpec->thumbnail = $thumbnail;
 491   }
 492
 493   /**
 494    * @param unknown_type $title
 495    */
 496   public function setTitle($title) {
 497     $this->gadgetSpec->title = $title;
 498   }
 499
 500   /**
 501    * @param unknown_type $titleUrl
 502    */
 503   public function setTitleUrl($titleUrl) {
 504     $this->gadgetSpec->titleUrl = $titleUrl;
 505   }
 506
 507   /**
 508    * @param unknown_type $userPrefs
 509    */
 510   public function setUserPrefs($userPrefs) {
 511     $this->gadgetSpec->userPrefs = $userPrefs;
 512   }
 513
 514   /**
 515    * @param unknown_type $width
 516    */
 517   public function setWidth($width) {
 518     $this->gadgetSpec->width = $width;
 519   }
 520 }