HJI WP Membership Code Reference
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Hook Reference
  • Slipstream API Docs

Namespaces

  • hji
    • AgentRoster
      • controllers
      • models
      • utils
    • common
      • factories
      • interfaces
      • models
      • utils
    • construction
      • admin
        • controllers
        • models
      • core
      • front
        • controllers
      • interfaces
      • models
        • listings
        • subdivisions
      • views
    • geofarms
      • common
      • controllers
      • models
      • widgets
    • homevalue
      • controllers
      • core
        • abstracts
      • models
    • lifestylefinder
    • listingstoblog
      • controllers
    • membership
      • abstracts
      • controllers
      • entities
      • extension
        • abstracts
        • interfaces
      • factories
      • includes
      • interfaces
      • models
        • data
        • webservice
          • abstracts
          • actions
          • interfaces
      • observers
      • services
    • recentsales
      • controllers
      • tinymce
      • widgets
    • ResponsiveIDX
      • abstracts
      • adapters
      • controllers
      • core
        • abstracts
      • entities
      • models
      • services
      • tinymce
      • utils
      • widgets
    • schools
      • controllers
      • tinymce
      • widgets
    • users
      • abstracts
      • admin
        • controllers
        • models
      • controllers
      • core
        • abstracts
      • entities
      • models
      • utils
  • None
  • REL
    • controllers
    • Models
    • Taxonomies
    • Utils
      • Convert
    • widgets

Classes

  • APIClient
  • CommonScripts
  • Dependency
  • DependencyResolver
  • Dispatcher
  • Downloads
  • GForms
  • ProductManager
  • ProductRegistrar
  • RegistryEntry
  • RequireJs
  • Settings
  • UpdateManager

Functions

  • __inject_plugin_table
  • __inject_theme_table

Class Dependency

Namespace: hji\membership\controllers
Located at classes/controllers/Dependency.php

Methods summary

public
# __construct( )
public
# initActionHooks( )

Action Hooks Setter Has to run only once

Action Hooks Setter Has to run only once

public boolean
# dependenciesSatisfied( hji\membership\interfaces\Product $product )

Determines if product's dependencies are met

Determines if product's dependencies are met

Parameters

$product

Returns

boolean
public static mixed
# extraHeaders( $headers )

Registers HJI-related headers with WP-core get_file_data() parser This data can be accessed via core getters of plugin and theme data.

Registers HJI-related headers with WP-core get_file_data() parser This data can be accessed via core getters of plugin and theme data.

Parameters

$headers

Returns

mixed
public boolean
# membershipUpdateAvailable( )

Determines if Membership plugin has an outstanding update available

Determines if Membership plugin has an outstanding update available

Returns

boolean
public
# adminNotices( )

Renders admin notices

Renders admin notices

public
# setInPluginUpdateMessages( )

Adds in-plugin update message action for each plugin

Adds in-plugin update message action for each plugin

public
# setUpgradeNotices( $productSlug )

Renders upgrade notices on the wp-admin/update-core.php page

Renders upgrade notices on the wp-admin/update-core.php page

Parameters

$productSlug
public mixed
# setDependencyUpgradeNotice( $upgrade )

Adds upgrade_notice property with upgrade dependencies info, to the upgrade data.

Adds upgrade_notice property with upgrade dependencies info, to the upgrade data.

Parameters

$upgrade

Returns

mixed
public
# inPluginUpdateMessage( $plugin_data, $r )

Renders dependencies message related to the available update The message is rendered inside the table row for each respective plugin inside Plugins Dashboard.

Renders dependencies message related to the available update The message is rendered inside the table row for each respective plugin inside Plugins Dashboard.

Parameters

$plugin_data
$r
public array
# setPluginsRowMeta( $plugin_meta, $plugin_file, $plugin_data, $status )

Renders required dependencies meta data within plugin's data row in the Plugins table Hook plugin_row_meta implementation.

Renders required dependencies meta data within plugin's data row in the Plugins table Hook plugin_row_meta implementation.

Parameters

$plugin_meta
$plugin_file
$plugin_data
$status

Returns

array
public hji\membership\models\PluginEntity
# getPluginFileBySlug( $slug )

Returns plugin file path

Returns plugin file path

Parameters

$slug

Returns

hji\membership\models\PluginEntity
public
# checkDependenciesOnActivation( $pluginFile, $network_wide )

Checks dependencies on plugin activation, if not satisfied - sets temp transient to trigger deactivation upon page reload.

Checks dependencies on plugin activation, if not satisfied - sets temp transient to trigger deactivation upon page reload.

Parameters

$pluginFile
$network_wide
public static
# undo_activation_actions( string $plugin, boolean $network_wide )

Undo any activation actions which may have run for blocked activation plugins

Undo any activation actions which may have run for blocked activation plugins

Parameters

$plugin
Name of the plugin which was blocked
$network_wide
Whether the intended activation was for the network or single site
public
# onActivationNotice( )

Add activation failure notices to the ::$notices due to dependencies being not satisfied.

Add activation failure notices to the ::$notices due to dependencies being not satisfied.

public
# themeDependenciesNotice( array $deps, $productName )

Adds theme dependency notice to the ::$notices container.

Adds theme dependency notice to the ::$notices container.

Parameters

$deps
dependencies
$productName
protected static null|string
# depsToString( array $deps )

Stringifies array of dependency entities

Stringifies array of dependency entities

Parameters

$deps

Returns

null|string
protected static
# _getThemeName( $template )
protected static string
# message( $code, $dependenciesStr, null $productName = null )

Returns message string based on code

Returns message string based on code

Parameters

$code
$dependenciesStr
$productName

Returns

string
public array
# resolveDependencies( $dependenciesArray )

Returns array of items sorted in the order satisfying dependencies

Returns array of items sorted in the order satisfying dependencies

Parameters

$dependenciesArray
=> array(dep1, dep2..)...);

Returns

array
HJI WP Membership Code Reference API documentation generated by ApiGen