You are here

Home » API reference » Social Content 7.2 » social_content_vk.class.inc

class SocialContentVK in Social Content 7.2

@file Social Content VK class.

Hierarchy

Expanded class hierarchy of SocialContentVK

1 string reference to 'SocialContentVK'
social_content_vk_social_content_class_info in modules/vk/social_content_vk.module
Implements hook_social_content_class_info().

File

modules/vk/social_content_vk.class.inc, line 7
Social Content VK class.

View source 
class SocialContentVK extends SocialContent {

  /**
   * The label for this global.
   *
   * @return string
   *   The label.
   */
  public function getLabel() {
    if (isset($this->settings['instance']) && !empty($this->settings['instance']['type'])) {
      return t('VK (@type)', array(
        '@type' => ucfirst($this->settings['instance']['type']),
      ));
    }
    return t('VK');
  }

  /**
   * The machine name for the global.
   *
   * @return string
   *   The machine name.
   */
  public function getMachineName() {
    return 'vk';
  }

  /**
   * Get the source being used to get the rows i.e. account / hashtag.
   *
   * @return string
   *   The hashtag / account being used to fetch the rows.
   */
  public function getSource() {
    return 'account';
  }

  /**
   * Fields to save from the row.
   *
   * Get fields to save.
   *
   * @return array
   *   List of fields to save.
   */
  public function fields() {
    return array(
      'id' => 'id',
      'text' => 'body',
    ) + parent::fields();
  }

  /**
   * The shared global settings form for all VK instances.
   *
   * @return array
   *   Global settings form.
   */
  public function globalSettingsForm() {
    $settings = $this->settings['global'];
    $form['api_url'] = array(
      '#type' => 'textfield',
      '#title' => t('API URL'),
      '#description' => t('Do not include trailing slash. Example: !url', array(
        '!url' => 'https://api.vk.com',
      )),
      '#default_value' => isset($settings['api_url']) ? $settings['api_url'] : NULL,
      '#required' => TRUE,
    );
    $form['api_version'] = array(
      '#type' => 'textfield',
      '#title' => t('API version'),
      '#description' => t("i.e. 'v1'."),
      '#default_value' => isset($settings['api_version']) ? $settings['api_version'] : '5.21',
      '#required' => TRUE,
    );
    return $form;
  }

  /**
   * Instance settings form.
   *
   * @return array
   *   Any instance settings that will be included on all
   *    instance forms for the current global.
   */
  public function instanceSettingsForm() {
    $settings = $this->settings['instance'];
    $form = parent::instanceSettingsForm($settings);
    $form['owner_id'] = array(
      '#type' => 'textfield',
      '#title' => t('VK Owner ID'),
      '#description' => t('The VK user/group id to pull the statuses from. Use negative numbers for groups.'),
      '#default_value' => isset($settings['owner_id']) ? $settings['owner_id'] : NULL,
    );
    return $form;
  }

  /**
   * Get the rows to import.
   *
   * @param mixed $last_id
   *   The id of the last import.
   *
   * @return mixed
   */
  public function getRows($last_id = NULL) {
    $settings = array_merge($this->settings['global'], $this->settings['instance']);
    if (!empty($settings['owner_id'])) {
      $params = array(
        'owner_id' => $settings['owner_id'],
        'photo_sizes' => 1,
      );
      if (!empty($settings['limit'])) {
        $params['count'] = $settings['limit'];
      }
      if (!empty($settings['api_version'])) {
        $params['v'] = $settings['api_version'];
      }
      $url = $settings['api_url'] . '/method/wall.get';
      $result = $this
        ->httpRequest(url($url, array(
        'query' => $params,
        'external' => TRUE,
      )));
      if ($result->code == 200) {
        $response = json_decode($result->data);
        if (!isset($response->error)) {
          return $response->response->items;
        }
        else {
          watchdog('social_content_vk', 'Error fetching feed, data: %data', array(
            '%data' => $response->error->error_msg,
          ), WATCHDOG_WARNING);
        }
      }
    }
    return FALSE;
  }

  /**
   * Do the uploads and attach expected fields to a row about to be imported.
   */
  public function prepareRow($row) {
    $row->created = $row->date;
    return parent::prepareRow($row);
  }

}

Members

Namesort descending Modifiers Type Description Overrides
SocialContent::$currentLanguageKey protected property
SocialContent::$settings protected property
SocialContent::applyGlobalTemplate protected function Apply global template to instance.
SocialContent::attachFields protected function Attach declare fields onto wrapper.
SocialContent::clearGlobals public function Delete global settings.
SocialContent::deleteHistory public static function Utility static function to delete log history of an internal id(nid).
SocialContent::deleteInstance public function Delete the current instance as well as it's history if required.
SocialContent::getAllInstances public static function Utility static function to get all instances.
SocialContent::getDynamicProperty protected function Get the value of a nested property, providing array of property names.
SocialContent::getFieldMappings public function Remote fields map to local fields.
SocialContent::getForm public function Get an internal form of the gievn type.
SocialContent::getFormRootElementKey public static function The root element to use in forms.
SocialContent::getImportCount public static function Utility static function to get a count number of imports for an instance.
SocialContent::getInstances public function Get all instances for the current global.
SocialContent::getInstanceTitle public function The title to use for the current instance.
SocialContent::getLastImportedExternalID public static function Utility static function to get last imported external id.
SocialContent::getObjectFromInstance public static function Utility static function to get a global object from instance id.
SocialContent::httpRequest protected static function Utility method make remote request.
SocialContent::import public function Do the import.
SocialContent::instanceSettingsFields protected function The default field keys which will be on all instance's forms.
SocialContent::isEnabled public function Whether the current instance is enabled for import.
SocialContent::loadGlobalSettings public function Load global settings.
SocialContent::loadInstanceSettings public function Load instance settings for the current global.
SocialContent::logHistory protected function Log import of row to history.
SocialContent::saveExternalFile protected function Utility static function to get and save a remote file.
SocialContent::saveForm public function Save the form values of a form that was request with the getForm method.
SocialContent::saveGlobalSettings public function Save global settings.
SocialContent::saveInstanceSettings public function Save instance settings. 3
SocialContent::setInstanceSettings public function Allow for overridding of intsnace settings.
SocialContent::translate public function Translate a node to a set given languages
SocialContent::validateText protected static function Strip non utf8 characters that can sometimes come through.
SocialContent::__construct public function Class constructor to instantiate a new object.
SocialContentVK::fields public function Fields to save from the row. Overrides SocialContent::fields
SocialContentVK::getLabel public function The label for this global. Overrides SocialContent::getLabel
SocialContentVK::getMachineName public function The machine name for the global. Overrides SocialContent::getMachineName
SocialContentVK::getRows public function Get the rows to import. Overrides SocialContent::getRows
SocialContentVK::getSource public function Get the source being used to get the rows i.e. account / hashtag. Overrides SocialContent::getSource
SocialContentVK::globalSettingsForm public function The shared global settings form for all VK instances. Overrides SocialContent::globalSettingsForm
SocialContentVK::instanceSettingsForm public function Instance settings form. Overrides SocialContent::instanceSettingsForm
SocialContentVK::prepareRow public function Do the uploads and attach expected fields to a row about to be imported. Overrides SocialContent::prepareRow